BreakKind 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 kind of the section break the section starts with. The property's value is a member of the SectionBreakKind enumeration.
Syntax
public SectionBreakKind BreakKind { get; set; }Public Property BreakKind As SectionBreakKindMembers
| Value | Description |
|---|---|
| BeginAtNewLine | The section begins on the next line with a new paragraph. |
| BeginAtNewPage | The section begins on the next page with a new paragraph. |
Examples
The following example configures the layout of the first document section by using SectionFormat.BreakKind.
SectionFormat sectionFormat = textControl.Sections[1].Format;
sectionFormat.BreakKind = SectionBreakKind.BeginAtNewLine;
Console.WriteLine($"Break Kind used by Section Format: {sectionFormat.BreakKind}");Dim sectionFormat As SectionFormat = textControl.Sections(1).Format
sectionFormat.BreakKind = SectionBreakKind.BeginAtNewLine
Console.WriteLine($"Break Kind used by Section Format: {sectionFormat.BreakKind}")Remarks
The property's default value is SectionBreakKind.BeginAtNewPage.
The property returns its default value when the text selection contains multiple sections with mixed alignment. The Selection.IsCommonValueSelected method can be used to check for mixed attributes.