Skip to content

Commit

Permalink
Updates for v23.1.3.
Browse files Browse the repository at this point in the history
  • Loading branch information
billhenn committed Sep 11, 2023
1 parent 134d4d8 commit 4dc2fb5
Show file tree
Hide file tree
Showing 34 changed files with 1,270 additions and 39 deletions.
5 changes: 1 addition & 4 deletions Documentation/topics/conversion/converting-to-v20-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,7 @@ This list contains changes and removals only:
- `MenuSeparatorHighlightNormalBrushKey` property removed due to template simplification.
- `NavigationBarPopupButtonBackground*BrushKey` properties removed since they are no longer used.
- `RaftingWindowBorderActiveBrushKey`, `RaftingWindowBorderInactiveBrushKey`, and `RaftingWindowBorderNormalCornerRadiusKey` properties removed since they are no longer used.
- `RibbonGroupBackgroundPressedBrushKey`, `RibbonGroupBorderHoverBrushKey`, `RibbonGroupSeparatorOpacityMaskNormalBrushKey` properties removed since they are no longer used.
- `RibbonSeparatorBorderNormalBrushKey`, `RibbonSeparatorBorderNormalThicknessKey`, and `RibbonSeparatorOpacityMaskNormalBrushKey ` properties removed since they are no longer used.
- `RibbonTabItemBackgroundFocusedBrushKey`, `RibbonTabItemBackgroundSelectedBrushKey`, `RibbonTabItemBorderFocusedBrushKey`, `RibbonTabItemBorderHoverBrushKey`, `RibbonTabItemForegroundSelectedBrushKey`, `RibbonTabItemInnerBorderFocusedBrushKey`, RibbonTabItemInnerBorderHoverBrushKey properties removed since they are no longer used.
- `RibbonToolBarTrayInnerBorderNormalBrushKey` property removed since it is no longer used.
Expand Down Expand Up @@ -491,10 +492,6 @@ This list contains changes and removals only:

- `AreEffectsEnabled`, `MaxTitleAreaWidth`, `OuterGlowBrush`, `UseColors` properties removed since contextual tab groups no longer render UI in the title bar.

### Group (Ribbon product)

- `RibbonGroupBackgroundPressedBrushKey`, `RibbonGroupBorderHoverBrushKey`, `RibbonGroupSeparatorOpacityMaskNormalBrushKey` properties removed since they are no longer needed.

### QuickAccessToolBar (Ribbon product)

- `IsApplicationButtonVisible`, `IsItemOuterGlowEnabled` properties removed since they are no longer needed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,8 @@ Pointer values can be interctively changed, by the end-user, using the mouse whe
By default, the pointer is not animated when the value is changed using the mouse. This behavior can be altered by setting [IsDraggingAnimated](xref:@ActiproUIRoot.Controls.Gauge.Primitives.PointerBase.IsDraggingAnimated) to `true`.

If you wish for a left mouse down event anywhere in the gauge to trigger a pointer drag, set the pointer's [CanDrag](xref:@ActiproUIRoot.Controls.Gauge.Primitives.PointerBase.CanDrag) property to `true` and handle the gauge's `LeftMouseButtonDown` event. In the event handler, invoke the pointer's [StartDrag](xref:@ActiproUIRoot.Controls.Gauge.Primitives.PointerBase.StartDrag*) method, passing in the event arguments sent to the event handler.

## Scale Placement

Bar and marker pointers are positioned relative to the scale bar defined by the associated [CircularScale](xref:@ActiproUIRoot.Controls.Gauge.CircularScale) element. By default, these pointers will be overlayed and centered on the scale bar. The placement of these pointers can be altered using the [ScalePlacement](xref:@ActiproUIRoot.Controls.Gauge.Primitives.PointerBase.ScalePlacement) and [ScaleOffset](xref:@ActiproUIRoot.Controls.Gauge.Primitives.PointerBase.ScaleOffset) properties.
Expand Down
2 changes: 2 additions & 0 deletions Documentation/topics/gauge/linear-gauge-features/pointers.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ Pointer values can be interactively changed, by the end-user, using the mouse wh
By default, the pointer is not animated when the value is changed using the mouse. This behavior can be altered by setting [IsDraggingAnimated](xref:@ActiproUIRoot.Controls.Gauge.Primitives.PointerBase.IsDraggingAnimated) to `true`.

If you wish for a left mouse down event anywhere in the gauge to trigger a pointer drag, set the pointer's [CanDrag](xref:@ActiproUIRoot.Controls.Gauge.Primitives.PointerBase.CanDrag) property to `true` and handle the gauge's `LeftMouseButtonDown` event. In the event handler, invoke the pointer's [StartDrag](xref:@ActiproUIRoot.Controls.Gauge.Primitives.PointerBase.StartDrag*) method, passing in the event arguments sent to the event handler.

## Scale Placement

Bar and marker pointers are positioned relative to the scale bar defined by the associated [LinearScale](xref:@ActiproUIRoot.Controls.Gauge.LinearScale) element. By default, these pointers will be overlayed and centered on the scale bar. The placement of these pointers can be altered using the [ScalePlacement](xref:@ActiproUIRoot.Controls.Gauge.Primitives.PointerBase.ScalePlacement) and [ScaleOffset](xref:@ActiproUIRoot.Controls.Gauge.Primitives.PointerBase.ScaleOffset) properties.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/topics/licensing.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ The contents of a *licenses.licx* file are pretty simple. It needs a single lin
This single line (update the version to match the one you use) should be added to the *licenses.licx* file in any project that uses Actipro @@PlatformName control or SyntaxEditor add-on products:

```
ActiproSoftware.Products.ActiproLicenseToken, ActiproSoftware.Shared.Wpf, Version=23.1.2.0, Culture=neutral, PublicKeyToken=36ff2196ab5654b9
ActiproSoftware.Products.ActiproLicenseToken, ActiproSoftware.Shared.Wpf, Version=23.1.3.0, Culture=neutral, PublicKeyToken=36ff2196ab5654b9
```

### Notes on Build Machines When Using Licenses.licx Files
Expand Down
4 changes: 4 additions & 0 deletions Documentation/topics/recent-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ WPF Studio's documentation has frequent updates, so this topic is the best place

If you are looking for a list of recently added major new features to WPF Studio products, please see the Sample Browser's Recent Updates page instead.

## Updates for v23.1.3

- **SyntaxEditor:** Added the [Overlay Panes](syntaxeditor/user-interface/editor-view/overlay-panes.md) topic for developing custom overlay panes.

## Updates for v23.1.0

- **Bars:** Added [documentation](bars/index.md) for the new product.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The [DynamicImage](xref:@ActiproUIRoot.Controls.DynamicImage) class has these im
| `IsEnabled` Property | When set to `false`, the image content will be rendered in grayscale. Inherited from `Image`. |
| `Source` Property | The `ImageSource` for the image content. Inherited from `Image`. |
| [UseMonochrome](xref:@ActiproUIRoot.Controls.DynamicImage.UseMonochrome) Property | Whether the `ImageSource` value in the `Source` property should be rendered as monochrome. The default value is `false`. When this property is `true`, the resulting monochrome image will be in the control's current foreground color (gathered from the [Foreground](xref:@ActiproUIRoot.Controls.DynamicImage.Foreground) property). |
| `Width` Property | The height of the image control in device independent units. It's always a good idea to set this property to ensure the image is displayed at its intended size, and must be set if your [Image Provider](../../themes/image-provider.md) can swap in high-DPI images. Inherited from `Image`. |
| `Width` Property | The width of the image control in device independent units. It's always a good idea to set this property to ensure the image is displayed at its intended size, and must be set if your [Image Provider](../../themes/image-provider.md) can swap in high-DPI images. Inherited from `Image`. |

## Using ImageConverter

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
title: "Overlay Panes"
page-title: "Overlay Panes - SyntaxEditor Editor View Features"
order: 17
---
# Overlay Panes

Overlay panes are user interface elements that are displayed in the upper-right corner of an [IEditorView](xref:@ActiproUIRoot.Controls.SyntaxEditor.IEditorView). While any content can be displayed, most content will typically be relatively small and can host interactive controls.

The [Search Overlay Pane](../searching/search-overlay-pane.md) is an example of an overlay pane implementation.

## Creating an Overlay Pane

Any control can be an overlay pane, but it must implement the [IOverlayPane](xref:@ActiproUIRoot.Controls.SyntaxEditor.IOverlayPane) interface.

@if (wpf winforms) {

### Inherit OverlayPaneBase

When possible, inheriting a custom pane from [OverlayPaneBase](xref:@ActiproUIRoot.Controls.SyntaxEditor.Implementation.OverlayPaneBase) will simplify the development effort. This abstract class has a default implementation for most members of the [IOverlayPane](xref:@ActiproUIRoot.Controls.SyntaxEditor.IOverlayPane) interface, and individual members can be overridden, as needed, to extend functionality for the custom pane.

}

@if (wpf) {

### Special Consideration for Key Presses

> [!WARNING]
> When typing in an overlay pane, key presses are still sent to the ancestor [SyntaxEditor](xref:@ActiproUIRoot.Controls.SyntaxEditor.SyntaxEditor) control and could result in edit actions being performed.
Pressing keys like <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd>, which normally move focus, may result in text being indented or outdented in the editor.

To prevent these keys (or any other key combination) from reaching the `SyntaxEditor` control, override the overlay pane control's `OnKeyDown` method and set `KeyEventArgs.Handled = true`.

> [!TIP]
> The [OverlayPaneBase](xref:@ActiproUIRoot.Controls.SyntaxEditor.Implementation.OverlayPaneBase) control has built-in support for handling key presses. By default, <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> will be handled and used to move keyboard focus. Override the [OnMoveFocus](xref:@ActiproUIRoot.Controls.SyntaxEditor.Implementation.OverlayPaneBase.OnMoveFocus*) method to customize which elements receive focus. Set [AllowTabKeyToMoveFocus](xref:@ActiproUIRoot.Controls.SyntaxEditor.Implementation.OverlayPaneBase.AllowTabKeyToMoveFocus) = `false` to disable the automatic handling of these keys.
>
>To customize the handling of additional keys, override the [ProcessKeyDown](xref:@ActiproUIRoot.Controls.SyntaxEditor.Implementation.OverlayPaneBase.ProcessKeyDown*) method and return `true` for any keys that were handled by the overlay pane.
}

@if (winforms) {

> [!TIP]
> The [OverlayPaneBase](xref:@ActiproUIRoot.Controls.SyntaxEditor.OverlayPaneBase) control has built-in support for handling key presses. By default, <kbd>Esc</kbd> will be handled and used to close the overlay pane but can be disabled by setting [AllowEscKeyToClose](xref:@ActiproUIRoot.Controls.SyntaxEditor.OverlayPaneBase.AllowEscKeyToClose) = `false`.
>
>To customize the handling of additional keys, override the [ProcessKeyDown](xref:@ActiproUIRoot.Controls.SyntaxEditor.OverlayPaneBase.ProcessKeyDown) method and return `true` for any keys that were handled by the overlay pane. For example, the <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> keys can optionally be handled to keep keyboard focus within the pane.
}

## Control Key Down Opacity

Overlay panes can become semi-transparent when the <kbd>Ctrl</kbd> key is held down, thereby allowing the end user to see the text behind it. The [IOverlayPane](xref:@ActiproUIRoot.Controls.SyntaxEditor.IOverlayPane).[ControlKeyDownOpacity](xref:@ActiproUIRoot.Controls.SyntaxEditor.IOverlayPane.ControlKeyDownOpacity) property specifies the opacity when the popup is semi-transparent.

The property value `0.25` is recommended for transparency. Set this property to `1.0` to prevent the pane from becoming semi-transparent.

## Single or Multiple Views

The [IOverlayPane](xref:@ActiproUIRoot.Controls.SyntaxEditor.IOverlayPane).[InstanceKind](xref:@ActiproUIRoot.Controls.SyntaxEditor.IOverlayPane.InstanceKind) property specifies how many instances of the overlay pane are permitted across all views of the same `SyntaxEditor` control.

Set this property to [Single](xref:@ActiproUIRoot.Controls.SyntaxEditor.OverlayPaneInstanceKind.Single) to allow only one instance at a time for any view in the editor. Set this property to [SinglePerView](xref:@ActiproUIRoot.Controls.SyntaxEditor.OverlayPaneInstanceKind.SinglePerView) to allow one instance per view.

## Showing and Activating an Overlay Pane

The [IEditorView](xref:@ActiproUIRoot.Controls.SyntaxEditor.IEditorView).[OverlayPanes](xref:@ActiproUIRoot.Controls.SyntaxEditor.IEditorView.OverlayPanes) collection is used to manage which overlay panes are currently shown for a particular view.

An overlay pane will be displayed when it is added to the [OverlayPanes](xref:@ActiproUIRoot.Controls.SyntaxEditor.IEditorView.OverlayPanes) collection. If an overlay pane of the same key is already displayed, the existing pane can typically be reused instead of creating a new one.

Most overlay panes are interactive and should be activated when they are shown. Each overlay pane can provide its own implementation for what it means to be activated, but this will typically involve setting keyboard focus to a specific element on the pane.

A good practice is to define a static `Show` method on the class that defines an overlay pane. The following code example demonstrates how a `Show` method could be defined on a `CustomOverlayPane` class.


```csharp
/// <summary>
/// Shows the overlay pane within the specified <paramref name="view"/>.
/// </summary>
/// <param name="view">The editor view where the overlay pane will be displayed.</param>
public static void Show(IEditorView view) {
if (view is null)
throw new ArgumentNullException(nameof(view));

// Get or create the custom overlay pane
var overlayPanes = view.OverlayPanes;
var customPane = overlayPanes[Key] as CustomOverlayPane;
if (customPane is null) {
// Close any existing overlay panes before adding a new one
overlayPanes.Clear();

// Add a new custom overlay pane
customPane = new CustomOverlayPane(view);
overlayPanes.Add(customPane);
}

// Activate the pane
customPane.Activate();
}
```

> [!TIP]
> Use the [SyntaxEditor.ActiveView](xref:@ActiproUIRoot.Controls.SyntaxEditor.SyntaxEditor.ActiveView) property to determine which editor view is currently active.
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Search results can be highlighted as the find text and other search options are

The search overlay pane animates to be semi-transparent when the <kbd>Ctrl</kbd> key is held down, thereby allowing the end user to see the text behind it. [SearchOverlayPane](xref:@ActiproUIRoot.Controls.SyntaxEditor.Primitives.SearchOverlayPane).[ControlKeyDownOpacity](xref:@ActiproUIRoot.Controls.SyntaxEditor.Primitives.SearchOverlayPane.ControlKeyDownOpacity) property specifies the opacity when the popup is semi-transparent.

Set this property to `1.0` to prevent the list from being semi-transparent.
Set this property to `1.0` to prevent the pane from being semi-transparent.

## Programmatically Opening the Pane

Expand Down
4 changes: 2 additions & 2 deletions Documentation/topics/themes/windowchrome.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ This example shows how the attached `WindowChrome.TitleBarHeader` property can b
<themes:WindowChrome.TitleBarHeader>
<Button Content="{Binding ElementName=window, Path=Title}" Margin="20,0" MaxWidth="300"
Style="{DynamicResource {x:Static themes:SharedResourceKeys.WindowTitleBarButtonBaseStyleKey}}"
Foreground="{Binding RelativeSource={RelativeSource TemplatedParent}, Path=(TextElement.Foreground)}"
Foreground="{Binding RelativeSource={RelativeSource AncestorType=ContentControl}, Path=(TextElement.Foreground)}"
IsTabStop="False" Focusable="False" />
</themes:WindowChrome.TitleBarHeader>
...
Expand Down Expand Up @@ -355,7 +355,7 @@ This is an example of using the [TitleBarMenu](xref:@ActiproUIRoot.Controls.Titl
TitleBarLeftContentMaxWidthOverflowPercentage="0.75" TitleBarRightContentMaxWidthOverflowPercentage="0" />
</themes:WindowChrome.Chrome>
<themes:WindowChrome.TitleBarLeftContent>
<shared:TitleBarMenu x:Name="menu" Foreground="{Binding RelativeSource={RelativeSource TemplatedParent}, Path=(TextElement.Foreground)}">
<shared:TitleBarMenu x:Name="menu" Foreground="{Binding RelativeSource={RelativeSource AncestorType=ContentControl}, Path=(TextElement.Foreground)}">
<MenuItem Header="File">
<MenuItem Header="New" />
<MenuItem Header="Open..." />
Expand Down
2 changes: 2 additions & 0 deletions Documentation/topics/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1102,6 +1102,8 @@ items:
href: syntaxeditor/user-interface/editor-view/indentation-guides.md
- name: "Column Guides"
href: syntaxeditor/user-interface/editor-view/column-guides.md
- name: "Overlay Panes"
href: syntaxeditor/user-interface/editor-view/overlay-panes.md
- name: "Scrolling"
href: syntaxeditor/user-interface/editor-view/scrolling.md
- name: "Hit Testing"
Expand Down
4 changes: 2 additions & 2 deletions Samples/PrismIntegration/PrismIntegration.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<ApplicationIcon>Actipro.ico</ApplicationIcon>

<Version>23.1.2.0</Version>
<Version>23.1.3.0</Version>

<RootNamespace>ActiproSoftware.Windows.PrismIntegration</RootNamespace>
<Company>Actipro Software LLC</Company>
Expand All @@ -31,7 +31,7 @@
</ItemGroup>

<ItemGroup Label="Actipro References">
<PackageReference Include="ActiproSoftware.Controls.WPF.Docking" Version="23.1.2" />
<PackageReference Include="ActiproSoftware.Controls.WPF.Docking" Version="23.1.3" />
</ItemGroup>

</Project>
Loading

0 comments on commit 4dc2fb5

Please sign in to comment.