Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
billhenn committed Feb 19, 2021
2 parents bfe6dc1 + c2387e2 commit 35e4988
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 17 deletions.
Binary file modified .github/image-content/documentation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/image-content/theme-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/image-content/theme-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
94 changes: 77 additions & 17 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,35 @@
# Actipro WPF Controls

![Integration Build](https://github.com/Actipro/WPF-Controls/workflows/Integration%20Build/badge.svg)
[![Latest](https://img.shields.io/nuget/v/ActiproSoftware.Controls.WPF?label=Latest&logo=nuget)](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF)
[![Downloads](https://img.shields.io/nuget/dt/ActiproSoftware.Controls.WPF?label=Downloads)](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF)
[![Integration Build](https://github.com/Actipro/WPF-Controls/workflows/Integration%20Build/badge.svg)](https://github.com/Actipro/WPF-Controls/actions/workflows/integration-build.yml)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0-ff69b4.svg)](https://github.com/Actipro/.github/blob/main/Code-of-Conduct.md)
[![Follow @Actipro](https://img.shields.io/twitter/follow/Actipro?style=social)](https://twitter.com/intent/follow?screen_name=Actipro)

Samples, documentation, and other related open-source projects for [Actipro WPF Controls](https://www.actiprosoftware.com/products/controls/wpf), a vast set of modern-themed UI controls for building beautiful WPF desktop applications that include:
Samples, documentation, and other related open-source projects for [Actipro WPF Controls](https://www.actiprosoftware.com/products/controls/wpf), a vast set of modern-themed UI controls for building beautiful WPF desktop applications.

The controls ship with over 25 professionally-designed themes, and custom themes can be easily created using configurable theme definitions.

| An Office Colorful Theme | A Custom Dark Slate Theme |
| ------------- | ------------- |
| ![Sample Browser](.github/image-content/theme-light.png) | ![Sample Browser](.github/image-content/theme-dark.png) |

## Table of Contents

- [About WPF Controls](#about-wpf-controls)
- [Getting Started](#getting-started)
- [Running the Sample Browser Application](#running-the-sample-browser-application)
- [Browsing Documentation](#browsing-documentation)
- [Running Other Sample Applications](#running-other-sample-applications)
- [Viewing Related Open-Source Projects](#viewing-related-open-source-projects)
- [NuGet Packages](#nuget-packages)
- [Contributing](#contributing)
- [Support](#support)
- [Licensing](#licensing)

## About WPF Controls

The [Actipro WPF Controls](https://www.actiprosoftware.com/products/controls/wpf) include:

- [SyntaxEditor](https://www.actiprosoftware.com/products/controls/wpf/syntaxeditor) - A syntax-highlighting code editor control and parsing suite.
- [Docking/MDI](https://www.actiprosoftware.com/products/controls/wpf/docking) - A complete docking tool window and multiple document interface solution.
Expand All @@ -24,15 +49,7 @@ Samples, documentation, and other related open-source projects for [Actipro WPF

*The control products themselves are closed-source commercial products, whose source is not included in this repo.*

## Table of Contents

- [Usage](#usage)
- [NuGet Packages](#nuget-packages)
- [Contributing](#contributing)
- [Support](#support)
- [Licensing](#licensing)

## Usage
## Getting Started

### Running the Sample Browser Application

Expand All @@ -48,29 +65,72 @@ Follow these steps to run the application:

### Browsing Documentation

[Product documentation](https://www.actiprosoftware.com/docs/controls/wpf/index) is available on our web site.
Complete [product documentation](https://www.actiprosoftware.com/docs/controls/wpf/index) is available on our web site.

[![Sample Browser](.github/image-content/documentation.png)](https://www.actiprosoftware.com/docs/controls/wpf/index)

The Markdown source code for the product documentation is contained within this repo's `Documentation\topics` folder. The documentation is built with [DocFx](https://github.com/dotnet/docfx).

### Running Other Sample Applications

This repo contains two other sample application solutions that demonstrate specialized integrations:

- `Samples\PrismIntegration.sln` - Shows using Docking/MDI with the [Prism library](https://github.com/PrismLibrary/Prism).
- `Samples\WindowsWorkflowIntegration.sln` - Shows using SyntaxEditor and its .NET Languages Add-on as a [rehosted Windows Workflow Designer](https://docs.microsoft.com/en-us/dotnet/framework/windows-workflow-foundation/rehosting-the-workflow-designer) expression editor, along with Docking/MDI and Themes.

### Viewing Related Open-Source Projects

This repo also contains the following open-source projects, which can be opened in the `Source\WPF-Libraries.sln` solution:

- `DataGrid.Contrib` - Several enhancements for the native Microsoft WPF DataGrid control.
- `Editors.Interop.DataGrid` - Integration of Actipro Editors with the Microsoft WPF DataGrid control.
- `Editors.Interop.DataGrid` - Integration of Actipro Editors with the Microsoft WPF DataGrid control, with dedicated DataGrid column types for each of the editors.

## NuGet Packages

[Packages for the Actipro WPF Controls](https://www.nuget.org/packages?q=ActiproSoftware.Controls.WPF) are published on nuget.org, all beginning with the `ActiproSoftware.Controls.WPF` name prefix.

While there are packages available for individual products, the [ActiproSoftware.Controls.WPF](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF) metapackage contains all the control products, and is easiest to reference when getting started.
### All WPF Controls Metapackage

This metapackage contains all of the control products, and is easiest to reference when getting started:

- [ActiproSoftware.Controls.WPF](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF)

### Individual WPF Control Packages

Use these individual control packages if you want to use a specific subset of the metapackage:

- [ActiproSoftware.Controls.WPF.BarCode](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.BarCode)
- [ActiproSoftware.Controls.WPF.Charts](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.Charts)
- [ActiproSoftware.Controls.WPF.Docking](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.Docking)
- [ActiproSoftware.Controls.WPF.Editors](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.Editors)
- [ActiproSoftware.Controls.WPF.Editors.Interop.DataGrid](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.Editors.Interop.DataGrid)
- [ActiproSoftware.Controls.WPF.Editors.Interop.Grids](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.Editors.Interop.Grids)
- [ActiproSoftware.Controls.WPF.Gauge](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.Gauge)
- [ActiproSoftware.Controls.WPF.Grids](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.Grids)
- [ActiproSoftware.Controls.WPF.MicroCharts](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.MicroCharts)
- [ActiproSoftware.Controls.WPF.Navigation](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.Navigation)
- [ActiproSoftware.Controls.WPF.Ribbon](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.Ribbon)
- [ActiproSoftware.Controls.WPF.Shared](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.Shared)
- [ActiproSoftware.Controls.WPF.Shell](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.Shell)
- [ActiproSoftware.Controls.WPF.SyntaxEditor](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.SyntaxEditor)
- [ActiproSoftware.Controls.WPF.Views](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.Views)
- [ActiproSoftware.Controls.WPF.Wizard](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.Wizard)

### SyntaxEditor Language Add-on Packages

Use these packages for SyntaxEditor's premium language add-ons as needed, which are shipped separately from the metapackage:

- [ActiproSoftware.Controls.WPF.SyntaxEditor.Addons.DotNet](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.SyntaxEditor.Addons.DotNet) - Advanced C#/VB languages in the .NET Languages Add-on.
- [ActiproSoftware.Controls.WPF.SyntaxEditor.Addons.JavaScript](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.SyntaxEditor.Addons.JavaScript) - Advanced JavaScript/JSON languages in the Web Languages Add-on.
- [ActiproSoftware.Controls.WPF.SyntaxEditor.Addons.Python](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.SyntaxEditor.Addons.Python) - Advanced Python language in the Python Language Add-on.
- [ActiproSoftware.Controls.WPF.SyntaxEditor.Addons.XML](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.SyntaxEditor.Addons.XML) - Advanced XML language in the Web Languages Add-on.

### Other Packages

[![Latest Version](https://img.shields.io/nuget/v/ActiproSoftware.Controls.WPF?label=ActiproSoftware.Controls.WPF&logo=nuget)](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF)
[![Downloads](https://img.shields.io/nuget/dt/ActiproSoftware.Controls.WPF)](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF)
These packages are optional and shipped separately from the metapackage:

Use the appropriate NuGet packages when adding Actipro WPF controls to your own projects. Note that the premium SyntaxEditor language add-ons are not included in the metapackage and ship in their own separate packages.
- [ActiproSoftware.Controls.WPF.DataGrid.Contrib](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.DataGrid.Contrib) - For the `DataGrid.Contrib` project in this repo.
- [ActiproSoftware.Controls.WPF.Themes.Aero](https://www.nuget.org/packages/ActiproSoftware.Controls.WPF.Themes.Aero) - For legacy Aero themes.

## Contributing

Expand Down

0 comments on commit 35e4988

Please sign in to comment.