TX Text Control .NET for WPF

TextContextMenuEventArgs Class

Class|Introduced in 19.0
Namespace
TXTextControl.WPF
Package
TXTextControl.TextControl.WPF.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.WPF.dll
Install
dotnet add package TXTextControl.TextControl.WPF.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.WPF.dll from the setup.
Inherits
  1. CancelEventArgs
  2. TextContextMenuEventArgs

Description

The WPF.TextContextMenuEventArgs class provides data for the WPF.TextControl.TextContextMenuOpening event. This event occurs, immediately before a built-in context menu will be opened. A TextControl provides context menus for different parts of a document. The ContextMenuLocation property informs for which part the menu will be opened. The pre-defined menu provided with the TextContextMenu property can be altered or expanded.

Syntax

public class TextContextMenuEventArgs : CancelEventArgs

Examples

The following example includes the context menu location value from a Text Context Menu Event Args object in application diagnostics. The created object is then available to the surrounding document workflow.

Console.WriteLine($"Context Menu Location: {textContextMenuEventArgs.ContextMenuLocation}");
Console.WriteLine("Text Context Menu Event Args is ready for use.");

Members

Properties

PropertyDescription
ContextMenuLocationGets the location in the document for which the context menu will be opened. The context menu items, which will be shown, depend on this location. The property value can be a combination (bitwise or) of the ContextMenuLocation values.
HorizontalOffsetGets the horizontal distance between the top-left corner of the screen and the location where the menu is displayed.
TextContextMenuGets or sets the context menu, which will be shown. The items depend on the document location where the mouse click occurs. The menu can be altered, extended or completely replaced. When this property is set to null, the WPF.TextControl uses system menu items. To completely suppress a context menu, the Cancel Property must be set the true.
VerticalOffsetGets the vertical distance between the top-left corner of the screen and the location where the menu is displayed.