TX Text Control .NET for Windows Forms

Frame Property

Property|Introduced in 24.0

Namespace: TXTextControl

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

Description

Gets an object that represents the frame which causes the event. It is of the type Image, TextFrame, DataVisualization.ChartFrame, DataVisualization.BarcodeFrame or DataVisualization.DrawingFrame.

Syntax

public FrameBase Frame { get; }

Public ReadOnly Property Frame As FrameBase

Examples

The following example uses FrameEventArgs.Frame while handling FrameClicked.

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

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

Limitations

Read only.