DescriptiveText Property
- Namespace
TXTextControl
- Package
TXTextControl.asTextControl. WPF. SDK TXTextControl.from the private NuGet feed or Text Control Offline Packagesdll
Description
Gets or sets a descriptive text for the frame. An empty string indicates that the frame has no such text. An empty string can also be used to delete a previously set text.
Syntax
public string DescriptiveText { get; set; }Public Property DescriptiveText As StringExamples
The following example adds a callout frame and works with it through the common frame API by using FrameBase.DescriptiveText.
TextFrame callout = new(new System.Drawing.Size(3000, 1200)) { Name = "Callout" };
textControl.TextFrames.Add(callout, TextFrameInsertionMode.DisplaceText);
FrameBase frameBase = callout;
frameBase.DescriptiveText = "Quarterly sales by region";
if (!string.IsNullOrWhiteSpace(frameBase.DescriptiveText))
{
Console.WriteLine($"Descriptive Text: {frameBase.DescriptiveText}");
}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.DescriptiveText = "Quarterly sales by region"
If Not String.IsNullOrWhiteSpace(frameBase.DescriptiveText) Then
Console.WriteLine($"Descriptive Text: {frameBase.DescriptiveText}")
End If