-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'release/v22.1.0' into main
- Loading branch information
Showing
187 changed files
with
6,157 additions
and
1,009 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"sdk": { | ||
"allowPrerelease": false, | ||
"version": "5.0.100", | ||
"rollForward": "latestFeature" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
--- | ||
title: "Converting to v22.1" | ||
page-title: "Converting to v22.1 - Conversion Notes" | ||
order: 87 | ||
--- | ||
# Converting to v22.1 | ||
|
||
The 22.1 version made several minor API changes in the SyntaxEditor Python Language Add-on. A new [ToggleSwitch](../shared/windows-controls/toggle-switch.md) control (Shared Library) also resulted in renaming the existing ToggleSwitch (Guage) as [FlipSwitch](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch) to avoid ambiguity. | ||
|
||
## SyntaxEditor Drag and Drop Updates | ||
|
||
The [Drag and Drop](../syntaxeditor/user-interface/input-output/drag-drop.md) functionality has been enhanced to provide more control over the experience. | ||
|
||
Previously, any non-`null` value assigned to the [PasteDragDropEventArgs](xref:ActiproSoftware.Windows.Controls.SyntaxEditor.PasteDragDropEventArgs).[Text](xref:ActiproSoftware.Windows.Controls.SyntaxEditor.PasteDragDropEventArgs.Text) property within a handler for the [SyntaxEditor](xref:ActiproSoftware.Windows.Controls.SyntaxEditor.SyntaxEditor).[PasteDragDrop](xref:ActiproSoftware.Windows.Controls.SyntaxEditor.SyntaxEditor.PasteDragDrop) event would indicate that drag-and-drop was allowed, but this limited advanced scenarios such as drag-and-drop with custom objects or dropping onto read-only documents. Going forward, the accepted operation assigned through [PasteDragDropEventArgs](xref:ActiproSoftware.Windows.Controls.SyntaxEditor.PasteDragDropEventArgs).[DragEventArgs](xref:ActiproSoftware.Windows.Controls.SyntaxEditor.PasteDragDropEventArgs.DragEventArgs) will be used to indicate `Copy`, `Move`, or `None` operations. Refer to the [Drag and Drop](../syntaxeditor/user-interface/input-output/drag-drop.md) topic for details on customizing drag operations. | ||
|
||
## SyntaxEditor Tagging Updates | ||
|
||
Previously, any [ITagger<T>](xref:ActiproSoftware.Text.Tagging.ITagger`1) which implemented the `IDisposable` interface would be disposed when detached from an instance of the [TagAggregatorBase<T>](xref:ActiproSoftware.Text.Tagging.TagAggregatorBase`1) class. Since taggers are frequently reused, this could lead to issues if the tagger was accessed after it was disposed. | ||
|
||
New [ITaggerBase](xref:ActiproSoftware.Text.Tagging.ITaggerBase).[NotifyTagAggregatorAttached](xref:ActiproSoftware.Text.Tagging.ITaggerBase.NotifyTagAggregatorAttached*) and [ITaggerBase](xref:ActiproSoftware.Text.Tagging.ITaggerBase).[NotifyTagAggregatorDetached](xref:ActiproSoftware.Text.Tagging.ITaggerBase.NotifyTagAggregatorDetached*) methods have been added for more granular control over the lifecycle of a tagger. Taggers which derive from [TaggerBase<T>](xref:ActiproSoftware.Text.Tagging.Implementation.TaggerBase`1) can override the [OnTagAggregatorAttached](xref:ActiproSoftware.Text.Tagging.Implementation.TaggerBase`1.OnTagAggregatorAttached*) and [OnTagAggregatorDetached](xref:ActiproSoftware.Text.Tagging.Implementation.TaggerBase`1.OnTagAggregatorDetached*) methods to respond to these notifications and more accurately determine if/when a tagger should be disposed. | ||
|
||
The following changes were made to tagging-related interfaces: | ||
|
||
- New [ITaggerBase](xref:ActiproSoftware.Text.Tagging.ITaggerBase) interface added which is implemented by [ITagger<T>](xref:ActiproSoftware.Text.Tagging.ITagger`1). | ||
- The `Close` method, `Closed` event, and `TagsChanged` event were moved from [ITagger<T>](xref:ActiproSoftware.Text.Tagging.ITagger`1) to [ITaggerBase](xref:ActiproSoftware.Text.Tagging.ITaggerBase). | ||
- New [ITagAggregatorBase](xref:ActiproSoftware.Text.Tagging.ITagAggregatorBase) interface added which is implemented by [ITagAggregator<T>](xref:ActiproSoftware.Text.Tagging.ITagAggregator`1). | ||
- The `TagsChanged` event was moved from [ITagAggregator<T>](xref:ActiproSoftware.Text.Tagging.ITagAggregator`1) to [ITagAggregatorBase](xref:ActiproSoftware.Text.Tagging.ITagAggregatorBase). | ||
|
||
## SyntaxEditor Python Language Add-on Updates | ||
|
||
The [Python](../syntaxeditor/python-language-addon/python/index.md) parser grammar has been updated to support v3.9.5 syntax. | ||
|
||
Python v2.x has been officially end of life for some time now, so we removed support for it. The `PythonVersion` enum was removed, and all APIs that had a `PythonVersion` parameter have had that parameter removed. | ||
|
||
## SyntaxEditor .NET Languages Add-on Updates | ||
|
||
The [C#](../syntaxeditor/dotnet-languages-addon/csharp/index.md) parser grammar has been updated to support v8.0 syntax. | ||
|
||
## ToggleSwitch Control (Guage Library) Renamed to FlipSwitch | ||
|
||
To avoid ambiguity with a new [ToggleSwitch](../shared/windows-controls/toggle-switch.md) control (Shared Library), the existing Actipro Gauge `ToggleSwitch` control has been renamed to [FlipSwitch](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch). The following related types and members have also been renamed: | ||
|
||
- `ToggleSwitch.RenderToggleSwitch` method renamed to [FlipSwitch](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch).[RenderFlipSwitch](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.RenderFlipSwitch*). | ||
- `ToggleSwitchType` enumeration renamed to [FlipSwitchType](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitchType). | ||
- `ToggleSwitchAutomationPeer` class renamed as [FlipSwitchAutomationPeer](xref:ActiproSoftware.Windows.Controls.Gauge.Automation.Peers.FlipSwitchAutomationPeer). | ||
|
||
## PartEditBoxCommitTriggers Changes (Editors Library) | ||
|
||
The [PartEditBoxCommitTriggers](xref:ActiproSoftware.Windows.Controls.Editors.PartEditBoxCommitTriggers) enumeration determines the rules by which typed/changed values are committed to an edit box's [Value](xref:ActiproSoftware.Windows.Controls.Editors.Primitives.PartEditBoxBase`1.Value) property. By default, it commits on focus loss, spinner change, and `Enter` key press. | ||
|
||
Commit on focus loss didn't used to be an option and always occurred. For this version, we've added an explicit `LostFocus` option to the enumeration for customers who might not want a commit to occur unless the end user pressed `Enter`. The `Default` and `All` values include the `LostFocus` option so that they behave the same as before. However if any other custom values were previously used, you must now include the `LostFocus` value to retain the same behavior. | ||
|
||
As part of these changes, the former `None` option has been renamed to `Manual`. Usage of the old `None` option should be replaced with the new `LostFocus` option to retain the same behavior as before. | ||
|
||
## Windows 11 WindowChrome Corner Kind | ||
|
||
The [WindowChrome](../themes/windowchrome.md) class has a new [WindowChrome](xref:ActiproSoftware.Windows.Themes.WindowChrome).[CornerKind](xref:ActiproSoftware.Windows.Themes.WindowChrome.CornerKind) property that can be set to a [WindowChromeCornerKind](xref:ActiproSoftware.Windows.Themes.WindowChromeCornerKind) value. | ||
|
||
This default `Rounded` value will use the system to render rounded borders on Windows 11 windows, matching how non-chromed windows appear. Windows in Windows 10 or earlier will continue to render with square borders as before. | ||
|
||
## ThemeManager.CurrentTheme Validation | ||
|
||
The [ThemeManager](xref:ActiproSoftware.Windows.Themes.ThemeManager).[CurrentTheme](xref:ActiproSoftware.Windows.Themes.ThemeManager.CurrentTheme) property setter will now throw an exception if the specified theme name is not for a predefined theme or a registered custom theme, thereby warning you that you have not registered a custom theme properly before attempting to use it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
Documentation/topics/gauge/flip-switch-features/.toc-generator.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
title: "FlipSwitch Features" | ||
order: 8 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
title: "Overview" | ||
page-title: "FlipSwitch Features" | ||
order: 1 | ||
--- | ||
# Overview | ||
|
||
The [FlipSwitch](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch) control can be broken down into separate areas, which are described below. Additional topics are provided for areas that require more detailed explanations. | ||
|
||
## Frames | ||
|
||
[FlipSwitch](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch) supports the same frame features as [CircularGauge](xref:ActiproSoftware.Windows.Controls.Gauge.CircularGauge), for more information see the [CircularGauge Frames](../circular-gauge-features/frames.md) topic. | ||
|
||
> [!NOTE] | ||
> The `FlipSwitch` control defaults the [BackgroundType](xref:ActiproSoftware.Windows.Controls.Gauge.Primitives.CircularGaugeBase.BackgroundType) to [None](xref:ActiproSoftware.Windows.Controls.Gauge.CircularBackgroundType.None), which differs from the `CircularGauge`. | ||
## Switch | ||
|
||
[FlipSwitch](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch) supports two or three check states, and includes several options for customizing the look of the switch. | ||
|
||
See the [Switch](switch.md) topic for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
title: "Switch" | ||
page-title: "Switch - FlipSwitch Features" | ||
order: 2 | ||
--- | ||
# Switch | ||
|
||
[FlipSwitch](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch) supports two or three check states, and includes several options for customizing the look of the switch. | ||
|
||
## Checked State | ||
|
||
The `FlipSwitch` mimics most of the functionality found in the native WPF `ToggleButton`, such as the [IsChecked](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.IsChecked) and [IsThreeState](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.IsThreeState) properties. | ||
|
||
The [IsChecked](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.IsChecked) property determines the position of the switch (up for `true`, down for `false`, or in the middle for `null`). By default, only `true` and `false` are supported, but if [IsThreeState](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.IsThreeState) is set to `true` then `null` (or indeterminate) is also supported. | ||
|
||
![Screenshot](../images/flip-switch-flat-on.png)![Screenshot](../images/flip-switch-flat-off.png) | ||
|
||
*Two FlipSwitch controls with one checked (left) and one unchecked (right)* | ||
|
||
When animating from one state to another, the [SwitchInterval](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.SwitchInterval) determines how long it takes the switch to travel to the new location. | ||
|
||
## Appearance | ||
|
||
### Switch Type | ||
|
||
There are two switch types supported (circular and flat), which can be specified using the [SwitchType](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.SwitchType) property. | ||
|
||
![Screenshot](../images/flip-switch-flat-on.png)![Screenshot](../images/flip-switch-circular-on.png) | ||
|
||
*Two FlipSwitch controls with a flat switch (left) and one with a circular switch (right)* | ||
|
||
### Switch Size | ||
|
||
The size of the switch is control by the [SwitchRadiusRatio](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.SwitchRadiusRatio) property, which is defined as a percentage of the [Radius](xref:ActiproSoftware.Windows.Controls.Gauge.Primitives.CircularGaugeBase.Radius). | ||
|
||
### Brush and Effect | ||
|
||
The switch can be broken down into two different parts; the base of the switch and then the switch itself. The brushed used for each part can be customized independenty. | ||
|
||
The base color can be customized by setting the [BaseBackground](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.BaseBackground) property. Additionally, the accent color (the octagon) can be customized by setting the [BaseAccentBrush](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.BaseAccentBrush) property. | ||
|
||
![Screenshot](../images/flip-switch-circular-on-base.png) | ||
|
||
*FlipSwitch with the base in red and the base accent in blue* | ||
|
||
The actual switch is made up of a ball, shaft, and a tip. The colors from these elements can be customized using [BallBrush](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.BallBrush), [ShaftBrush](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.ShaftBrush), and [TipBrush](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.TipBrush) respectively. | ||
|
||
![Screenshot](../images/flip-switch-circular-on-switch.png)![Screenshot](../images/flip-switch-flat-on-switch.png) | ||
|
||
*Two FlipSwitch control, one circular and one flat, with a green ball, yellow shaft, and blue tip* | ||
|
||
The switch includes an effect that can be disabled by setting [IsSwitchEffectEnabled](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.IsSwitchEffectEnabled) to `false`. | ||
|
||
> [!NOTE] | ||
> The led effect is only supported when [IsSwitchEffectEnabled](xref:ActiproSoftware.Windows.Controls.Gauge.FlipSwitch.IsSwitchEffectEnabled) is set to `true`**and** the associated brush is set to a `SolidColorBrush`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.