EditableRegionEventArgs Class

Class|Introduced in 25.0

Namespace: TXTextControl

Package: TXTextControl.TextControl.WPF.SDK from the private NuGet feed or Text Control Offline Packages

Assembly: TXTextControl.dll

Install: dotnet add package TXTextControl.TextControl.WPF.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.dll from the setup.

Inherits

EventArgs
EditableRegionEventArgs

Description

The EditableRegionEventArgs class provides data for the EditableRegionCreated, EditableRegionDeleted, EditableRegionEntered and EditableRegionLeft events. When an editable region is deleted, the EditableRegion object provided with the event data has the following valid properties: HighlightColor, HighlightMode, ID and UserName. All other properties are undefined.

Syntax

public class EditableRegionEventArgs : EventArgs

Public Class EditableRegionEventArgs
    Inherits EventArgs

Examples

The following example uses EditableRegionEventArgs.EditableRegion while handling EditableRegionEntered.

textControl.EditableRegionEntered += (_, e) =>
{
    e.EditableRegion?.ScrollTo();
};

AddHandler textControl.EditableRegionEntered,
    Sub(sender, e)
        If e.EditableRegion IsNot Nothing Then e.EditableRegion.ScrollTo()
    End Sub

Members

Properties

Property	Description
EditableRegion	Gets an object that represents the editable region which causes the event. It is of the type EditableRegion.