FrameEventArgs Class

Class|Introduced in 24.0

Namespace: TXTextControl

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

Assembly: TXTextControl.Core.dll

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

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

Inherits

EventArgs
FrameEventArgs

Description

The FrameEventArgs class provides data for all events that occur with frames. A frame can be an image, a text frame, a chart, a barcode or a drawing.

Syntax

public class FrameEventArgs : EventArgs

Public Class FrameEventArgs
    Inherits EventArgs

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

Members

Properties

Property	Description
Frame	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.