StructureLevel Property
- Namespace
TXTextControl
- Package
TXTextControl.asTextControl. Core. SDK TXTextControl.from the private NuGet feed or Text Control Offline PackagesCore. dll
- Also in
TXTextControl.asTextControl. ASP. SDK TXTextControl.dll
Description
Gets or sets the structure level of a paragraph in the document. The level can be between 0 and 10. A level of 0 indicates that the paragraph belongs to the body of the document.
Syntax
public int StructureLevel { get; set; }Public Property StructureLevel As IntegerExamples
The following example applies paragraph layout to selected report text by using ParagraphFormat.StructureLevel.
textControl.Text = "First item\nSecond item\nThird item";
textControl.Select(0, textControl.Text.Length);
ParagraphFormat paragraphFormat = textControl.Selection.ParagraphFormat;
paragraphFormat.StructureLevel = 10;
Console.WriteLine($"Structure Level used by Paragraph Format: {paragraphFormat.StructureLevel}");
textControl.Selection.ParagraphFormat = paragraphFormat;textControl.Text = "First item" & vbCrLf & "Second item" & vbCrLf & "Third item"
textControl.Select(0, textControl.Text.Length)
Dim paragraphFormat As ParagraphFormat = textControl.Selection.ParagraphFormat
paragraphFormat.StructureLevel = 10
Console.WriteLine($"Structure Level used by Paragraph Format: {paragraphFormat.StructureLevel}")
textControl.Selection.ParagraphFormat = paragraphFormatRemarks
The property's default value is 0.
The property returns its default value when the text selection contains multiple paragraphs with mixed structure levels. The Selection.IsCommonValueSelected method can be used to check for mixed attributes.