Skip to content

Commit

Permalink
Updates for v24.1.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
billhenn committed Feb 22, 2024
1 parent a4cff0c commit 9e49517
Show file tree
Hide file tree
Showing 161 changed files with 3,225 additions and 1,900 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/integration-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ jobs:

env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
LICENSEKEY: ${{ secrets.ACTIPRO_CONTROLS_WINFORMS_V23_1_LICENSEKEY }}
LICENSEKEY: ${{ secrets.ACTIPRO_CONTROLS_WINFORMS_V24_1_LICENSEKEY }}

steps:
- name: Cancel duplicate runs
uses: fkirc/skip-duplicate-actions@v5
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Run build project
Expand Down
2 changes: 1 addition & 1 deletion Build/Build.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<RootNamespace>ActiproSoftware.Tools.Builds</RootNamespace>
<Company>Actipro Software LLC</Company>
<Authors>Actipro Software LLC</Authors>
<Copyright>Copyright (c) 2020-2023 Actipro Software LLC. All rights reserved.</Copyright>
<Copyright>Copyright (c) 2020-2024 Actipro Software LLC. All rights reserved.</Copyright>

<GeneratePackageOnBuild>false</GeneratePackageOnBuild>

Expand Down
14 changes: 14 additions & 0 deletions Documentation/api-filter.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
apiRules:

# Exclude Obsolete in Actipro namespaces
- exclude:
uidRegex: ^ActiproSoftware\.
hasAttribute:
uid: System.ObsoleteAttribute

# Include EditorBrowsableState.Never in Actipro namespaces (excluded by default)
- include:
uidRegex: ^ActiproSoftware\.
hasAttribute:
uid: System.ComponentModel.EditorBrowsableAttribute
ctorArguments:
- System.ComponentModel.EditorBrowsableState.Never

# Exclude compatibility and core product code
- exclude:
uidRegex: ^ActiproSoftware\.Compatibility$
Expand Down
25 changes: 5 additions & 20 deletions Documentation/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,8 @@
{
"src": "../../Deploy/Build/AssembliesDocFX",
"files": [
"ActiproSoftware.Shared.WinForms.dll",
"ActiproSoftware.Bars.WinForms.dll",
"ActiproSoftware.Docking.WinForms.dll",
"ActiproSoftware.Navigation.WinForms.dll",
"ActiproSoftware.SyntaxEditor.Addons.DotNet.WinForms.dll",
"ActiproSoftware.SyntaxEditor.Addons.JavaScript.WinForms.dll",
"ActiproSoftware.SyntaxEditor.Addons.Python.WinForms.dll",
"ActiproSoftware.SyntaxEditor.Addons.Xml.WinForms.dll",
"ActiproSoftware.SyntaxEditor.WinForms.dll",
"ActiproSoftware.Text.Addons.DotNet.WinForms.dll",
"ActiproSoftware.Text.Addons.DotNet.Roslyn.WinForms.dll",
"ActiproSoftware.Text.Addons.JavaScript.WinForms.dll",
"ActiproSoftware.Text.Addons.Python.WinForms.dll",
"ActiproSoftware.Text.Addons.Xml.WinForms.dll",
"ActiproSoftware.Text.LLParser.WinForms.dll",
"ActiproSoftware.Text.WinForms.dll",
"ActiproSoftware.Wizard.WinForms.dll"
// "**.csproj"
// Actipro assemblies
"ActiproSoftware.*.dll"
]
}
],
Expand All @@ -36,6 +20,7 @@
"src": "topics",
"files": [
"**.md",
"api/ActiproSoftware.yml",
"api/ActiproSoftware.*.yml",
"api/toc.yml",
"toc.yml"
Expand Down Expand Up @@ -68,10 +53,10 @@
"_appTitle": "Actipro WinForms Controls Docs",
"_docsCompanyHref": "https://www.actiprosoftware.com/products/controls/windowsforms",
"_docsCompanyName": "Actipro Software LLC",
"_docsCopyrightYears": "1999-2023",
"_docsCopyrightYears": "1999-2024",
"_docsProductHref": "https://www.actiprosoftware.com/products/controls/windowsforms",
"_docsProductName": "WinForms Controls",
"_docsProductVersion": "23.1",
"_docsProductVersion": "24.1",
"_disableContribution": true,
"_enableNewTab": true,
"_gitContribute": {
Expand Down
25 changes: 13 additions & 12 deletions Documentation/topics/bars/extensible-rendering.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,39 +9,40 @@ All the bar controls use an extensible rendering model that is based on our comm

This object model allows for three levels of rendering customization. Choose which level of customization you wish to use:

- Use Built-In Renderers As-Is - Use the built-in rendering styles without any changes, which include all Visual Studio and Office styles.
- Use Built-In Renderers As-Is - Use the built-in rendering styles without any changes, which include several Metro, Visual Studio, and Office styles.
- Modify Properties on Built-In Renderers - Use the built-in renderers but modify the various properties on the renderers to easily create a customized appearance.
- Create Custom Renderers - Implement the [IBarRenderer](xref:@ActiproUIRoot.Controls.Bars.IBarRenderer) or [IStatusBarRenderer](xref:@ActiproUIRoot.Controls.Bars.IStatusBarRenderer) interfaces or inherit our [BarRenderer](xref:@ActiproUIRoot.Controls.Bars.BarRenderer) or [StatusBarRenderer](xref:@ActiproUIRoot.Controls.Bars.StatusBarRenderer) classes to do all the measuring and drawing of the controls and their elements yourself.

These are some sample rendering styles that come with [BarManager](xref:@ActiproUIRoot.Controls.Bars.BarManager) and [StatusBar](xref:@ActiproUIRoot.Controls.Bars.StatusBar):

![Screenshot](images/bar-controls-metro-light.png)![Screenshot](images/bar-controls-office-2007-blue.png)![Screenshot](images/bar-controls-office-2007-silver.png)![Screenshot](images/bar-controls-office-2007-black.png)![Screenshot](images/bar-controls-office-2003-blue.png)![Screenshot](images/bar-controls-office-2003-olive-green.png)![Screenshot](images/bar-controls-office-2003-silver.png)![Screenshot](images/bar-controls-office-2003-royale.png)![Screenshot](images/bar-controls-windows-classic.png)![Screenshot](images/bar-controls-visual-studio-2002.png)![Screenshot](images/bar-controls-visual-studio-2005.png)
![Screenshot](images/bar-controls-metro-light.png)![Screenshot](images/bar-controls-office-2007-blue.png)![Screenshot](images/bar-controls-office-2007-silver.png)![Screenshot](images/bar-controls-office-2007-black.png)![Screenshot](images/bar-controls-office-2003-blue.png)![Screenshot](images/bar-controls-office-2003-olive-green.png)![Screenshot](images/bar-controls-office-2003-silver.png)![Screenshot](images/bar-controls-windows-classic.png)![Screenshot](images/bar-controls-visual-studio-2002.png)![Screenshot](images/bar-controls-visual-studio-2005.png)

## Use Built-In Renderers As-Is

Bars includes these built-in renderers, which support Metro Light, Metro Dark, Office, and Visual Studio styles:
Bars includes these built-in renderers, which support Metro, Visual Studio, Office, and other classic styles:

| Renderer | Description |
|-----|-----|
| [MetroBarRenderer](xref:@ActiproUIRoot.Controls.Bars.MetroBarRenderer) | Capable of drawing Metro styles (Light and Dark) for bar controls. To change to a different style, change the [BaseColorSchemeType](xref:@ActiproUIRoot.Controls.Bars.MetroBarRenderer.BaseColorSchemeType). |
| [MetroStatusBarRenderer](xref:@ActiproUIRoot.Controls.Bars.MetroStatusBarRenderer) | Capable of drawing Metro styles (Light and Dark) for statusbar controls. To change to a different style, change the [BaseColorSchemeType](xref:@ActiproUIRoot.Controls.Bars.MetroStatusBarRenderer.BaseColorSchemeType). |
| [Office2003BarRenderer](xref:@ActiproUIRoot.Controls.Bars.Office2003BarRenderer) | Capable of drawing all Office 2007 styles (Blue, Silver, Black), Office 2003 styles (Blue, Olive, Silver, Royale, and Windows Classic), as well as the Visual Studio 2005 style for bar controls. To change to a different style, change the [BaseColorSchemeType](xref:@ActiproUIRoot.Controls.Bars.Office2003BarRenderer.BaseColorSchemeType). |
| [Office2003StatusBarRenderer](xref:@ActiproUIRoot.Controls.Bars.Office2003StatusBarRenderer) | Capable of drawing all Office styles for statusbar controls. |
| [VisualStudio2002BarRenderer](xref:@ActiproUIRoot.Controls.Bars.VisualStudio2002BarRenderer) | Capable of drawing Visual Studio 2002 bar controls. |
| [VisualStudio2002StatusBarRenderer](xref:@ActiproUIRoot.Controls.Bars.VisualStudio2002StatusBarRenderer) | Capable of drawing Visual Studio 2002 statusbar controls. |
| [VisualStudio2005StatusBarRenderer](xref:@ActiproUIRoot.Controls.Bars.VisualStudio2005StatusBarRenderer) | Capable of drawing Visual Studio 2005 statusbar controls. |
| [OfficeClassicBarRenderer](xref:@ActiproUIRoot.Controls.Bars.OfficeClassicBarRenderer) | Capable of drawing all Office classic styles (Blue, Silver, Black), Luna styles (Blue, Olive Green, Silver), and Windows Classic, as well as the Visual Studio classic style for bar controls. To change to a different style, change the [BaseColorSchemeType](xref:@ActiproUIRoot.Controls.Bars.OfficeClassicBarRenderer.BaseColorSchemeType). |
| [OfficeClassicStatusBarRenderer](xref:@ActiproUIRoot.Controls.Bars.OfficeClassicStatusBarRenderer) | Capable of drawing all Office styles for statusbar controls. |
| [VisualStudioBarRenderer](xref:@ActiproUIRoot.Controls.Bars.VisualStudioBarRenderer) | Capable of drawing Visual Studio bar controls. |
| [VisualStudioClassicStatusBarRenderer](xref:@ActiproUIRoot.Controls.Bars.VisualStudioClassicStatusBarRenderer) | Capable of drawing Visual Studio classic statusbar controls. |
| [WindowsClassicBarRenderer](xref:@ActiproUIRoot.Controls.Bars.WindowsClassicBarRenderer) | Capable of drawing Windows classic bar controls. |
| [WindowsClassicStatusBarRenderer](xref:@ActiproUIRoot.Controls.Bars.WindowsClassicStatusBarRenderer) | Capable of drawing Windows classic statusbar controls. |

## Color Tinting Color Schemes

With one line of code, any `WindowsColorScheme` can be tinted so that all of the colors are altered. For instance, you can easily create a tan or red color scheme and then use those color schemes with the [Office2003BarRenderer](xref:@ActiproUIRoot.Controls.Bars.Office2003BarRenderer) class like this:
With one line of code, any `WindowsColorScheme` can be tinted so that all of the colors are altered. For instance, you can easily create a tan or red color scheme and then use those color schemes with the [OfficeClassicBarRenderer](xref:@ActiproUIRoot.Controls.Bars.OfficeClassicBarRenderer) class like this:

![Screenshot](images/bar-controls-custom-tan.png)![Screenshot](images/bar-controls-custom-red.png)

This code shows how to load a custom tan-tinted color scheme (displayed in the screenshot above) that is based on the built-in Windows XP blue theme:
This code shows how to load a custom tan-tinted color scheme (displayed in the screenshot above) that is based on the built-in Luna blue theme:

```csharp
WindowsColorScheme scheme = new WindowsColorScheme("Tan", WindowsColorSchemeType.WindowsXPBlue, Color.Tan);
barManager.Renderer = new Office2003BarRenderer(scheme);
var scheme = new WindowsColorScheme("Tan", WindowsColorSchemeType.LunaBlue, Color.Tan);
barManager.Renderer = new OfficeClassicBarRenderer(scheme);
```

## Customizing Specific Colors in a Color Scheme
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed Documentation/topics/bars/images/bar-test-app.gif
Binary file not shown.
Binary file removed Documentation/topics/bars/images/bar-test-app2.gif
Binary file not shown.
2 changes: 1 addition & 1 deletion Documentation/topics/bars/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Out of the box, the bar controls have [rendering capabilities](extensible-render

## Feature List

- Built-in [rendering styles](extensible-rendering.md) include Metro Light, Metro Dark, Visual Studio, and Office styles.
- Built-in [rendering styles](extensible-rendering.md) include Metro, Visual Studio, Office, and Windows Classic styles.

- Robust rendering interface allows for totally customized rendering.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/topics/conversion/converting-to-v23-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The [TabbedMdiWindowContextMenuEventArgs](xref:@ActiproUIRoot.Controls.Docking.T

## Modern DockGuides

Docking support for [DockGuideStyle](xref:@ActiproUIRoot.Controls.Docking.DockGuideStyle).[Sunken](xref:@ActiproUIRoot.Controls.Docking.DockGuideStyle.Sunken) (previous default) and [DockGuideStyle](xref:@ActiproUIRoot.Controls.Docking.DockGuideStyle).[Raised](xref:@ActiproUIRoot.Controls.Docking.DockGuideStyle.Raised) (old Windows XP-era style) has been removed and replaced by [DockGuideStyle](xref:@ActiproUIRoot.Controls.Docking.DockGuideStyle).[Modern](xref:@ActiproUIRoot.Controls.Docking.DockGuideStyle.Modern) (new default). The old values are still defined but have been marked as obsolete and will use the `Modern` style when used. No changes are necessary at this time, but any references to the old values should be replaced with `Modern` to avoid IDE warnings and eventual breaking changes when the obsolete values are removed in a future release.
Docking support for [DockGuideStyle](xref:@ActiproUIRoot.Controls.Docking.DockGuideStyle).`Sunken` (previous default) and [DockGuideStyle](xref:@ActiproUIRoot.Controls.Docking.DockGuideStyle).`Raised` (old Windows XP-era style) has been removed and replaced by [DockGuideStyle](xref:@ActiproUIRoot.Controls.Docking.DockGuideStyle).[Modern](xref:@ActiproUIRoot.Controls.Docking.DockGuideStyle.Modern) (new default). The old values are still defined but have been marked as obsolete and will use the `Modern` style when used. No changes are necessary at this time, but any references to the old values should be replaced with `Modern` to avoid IDE warnings and eventual breaking changes when the obsolete values are removed in a future release.

The `Sunken` and `Raised` styles were based on image resources that could be customized using `ActiproSoftware.Products.Docking.AssemblyInfo.Instance.ImageProviderFunc`. Since the `Modern` guides are built dynamically at run-time, there are no images to customize and the `ImageProviderFunc` property has been removed. The colors used for `Modern` guides can be customized using various properties on [IWindowsColorScheme](xref:@ActiproUIRoot.Drawing.IWindowsColorScheme) (e.g., [IWindowsColorScheme](xref:@ActiproUIRoot.Drawing.IWindowsColorScheme).[DockGuideArrowBack](xref:@ActiproUIRoot.Drawing.IWindowsColorScheme.DockGuideArrowBack) changes the background color of the arrow). See the [Extensible Rendering](../docking/extensible-rendering.md) topic for more details on customizing a color scheme.

Expand Down
Loading

0 comments on commit 9e49517

Please sign in to comment.