Add Method
- Namespace
TXTextControl
- Package
TXTextControl.asTextControl. WinForms. SDK TXTextControl.from the private NuGet feed or Text Control Offline Packagesdll
Description
Adds a new section to a document.
Syntax
Add(SectionBreakKind)
Adds a new section at the current text input position. The new section ends at the end position of the section containing the input position. If a new section is inserted in a paragraph or table, the paragraph or table is split into two paragraphs or tables.
public bool Add(SectionBreakKind sectionBreakKind);Public Function Add(sectionBreakKind As SectionBreakKind) As Boolean| Parameter | Description | ||||||
|---|---|---|---|---|---|---|---|
| sectionBreakKind | Specifies the kind of the section break. It can be one of the SectionBreakKind values. The following values are possible:
|
Add(SectionBreakKind, int)
Adds a new section at the specified text input position. The new section ends at the end position of the section containing the input position. If a new section is inserted in a paragraph or table, the paragraph or table is split into two paragraphs or tables.
public bool Add(SectionBreakKind sectionBreakKind, int textPosition);Public Function Add(sectionBreakKind As SectionBreakKind, textPosition As Integer) As Boolean| Parameter | Description | ||||||
|---|---|---|---|---|---|---|---|
| sectionBreakKind | Specifies the kind of the section break. It can be one of the SectionBreakKind values. The following values are possible:
| ||||||
| textPosition | Specifies the text position at which the section is to be inserted. |
Return Value
The return value is true, if the section could be added. Otherwise it is false.
Examples
The following example starts a new page with an independent document section and enables landscape layout for that section.
if (textControl.Sections.Add(SectionBreakKind.BeginAtNewPage, -1))
{
Section newSection = textControl.Sections[textControl.Sections.Count];
newSection.Format.Landscape = true;
}If textControl.Sections.Add(SectionBreakKind.BeginAtNewPage, -1) Then
Dim newSection As Section = textControl.Sections(textControl.Sections.Count)
newSection.Format.Landscape = True
End If