FrameBase.Name Property — TX Text Control .NET for Windows Forms

Name Property

Property|Introduced in 15.1

Namespace: TXTextControl

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

Description

Gets or sets a name for the frame. An empty string indicates that the frame has no name. An empty string can also be used to delete a previously set name.

Syntax

public string Name { get; set; }

Public Property Name As String

Examples

The following example adds a callout frame and works with it through the common frame API by using FrameBase.Name.

TextFrame callout = new(new System.Drawing.Size(3000, 1200)) { Name = "Callout" };
textControl.TextFrames.Add(callout, TextFrameInsertionMode.DisplaceText);
FrameBase frameBase = callout;

frameBase.Name = "FrameBase1";
if (!string.IsNullOrWhiteSpace(frameBase.Name))
{
    Console.WriteLine($"Name: {frameBase.Name}");
}

Dim callout As New TextFrame(New System.Drawing.Size(3000, 1200)) With { .Name = "Callout" }
textControl.TextFrames.Add(callout, TextFrameInsertionMode.DisplaceText)
Dim frameBase As FrameBase = callout

frameBase.Name = "FrameBase1"
If Not String.IsNullOrWhiteSpace(frameBase.Name) Then
    Console.WriteLine($"Name: {frameBase.Name}")
End If