TX Text Control .NET Server

TextFrame Property

Property|Introduced in 12.0

Namespace: TXTextControl

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

Also in: TXTextControl.TextControl.ASP.SDK as TXTextControl.dll

Description

Gets an object that represents the text frame which causes the event. It is of the type TextFrame.

Syntax

public TextFrame TextFrame { get; }

Public ReadOnly Property TextFrame As TextFrame

Examples

The following example uses TextFrameEventArgs.TextFrame while handling TextFrameClicked.

textControl.TextFrameClicked += (_, e) =>
{
    if (e.TextFrame != null)
    {
        e.TextFrame.DescriptiveText = "Quarterly sales by region";
    }
};

AddHandler textControl.TextFrameClicked,
    Sub(sender, e)
        If e.TextFrame IsNot Nothing Then
            e.TextFrame.DescriptiveText = "Quarterly sales by region"
        End If
    End Sub

Limitations

Read only.