TX Text Control .NET Server

CaretStateEventArgs Class

Class|Introduced in 21.0
Namespace
TXTextControl.ServerVisualisation
Package
TXTextControl.TextControl.Core.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.Server.Core.dll
Install
dotnet add package TXTextControl.TextControl.Core.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.Server.dll from the setup.
Also in
TXTextControl.TextControl.ASP.SDK as TXTextControl.Server.dll
Inherits
  1. EventArgs
  2. CaretStateEventArgs

Description

The CaretStateEventArgs class provides data about the state of the caret, such as position, size and visibility. It is used with the CaretStateChanged event of the ServerVisualization.TextViewGenerator and the ServerVisualization.DialogViewGenerator class.

Syntax

public class CaretStateEventArgs : EventArgs

Examples

The following example includes the location value from a Caret State Event Args object in application diagnostics. The created object is then available to the surrounding document workflow.

Console.WriteLine($"Location: {caretStateEventArgs.Location}");
Console.WriteLine("Caret State Event Args is ready for use.");

Members

Properties

PropertyDescription
DirectionGets the caret's direction.
LocationGets the caret's location in pixels.
SizeGets the caret's visibility.
VisibilityGets the caret's visibility.