SectionCollection Class
- Namespace
TXTextControl
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WPF. SDK
- Assembly
TXTextControl.dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WPF. SDK TXTextControl.from the setup.dll
- Implements
- ICollection, IEnumerable
Description
An instance of the SectionCollection class contains all sections of a document. A document has at least one section. An instance of this class can be obtained with the TextControl.Sections property. The SectionCollection class implements the IEnumerable and the ICollection interfaces.
Syntax
public sealed class SectionCollection : ICollection, IEnumerablePublic NotInheritable Class SectionCollection
Implements ICollection, IEnumerableExamples
The following example shows how to add a new section and get the actual section number:
textControl1.Sections.Add(TXTextControl.SectionBreakKind.BeginAtNewPage);
Console.WriteLine("Section " + textControl1.Sections.GetItem().Number.ToString()
+ " of " + textControl1.Sections.Count.ToString());TextControl1.Sections.Add(TXTextControl.SectionBreakKind.BeginAtNewPage)
Console.WriteLine("Section " + TextControl1.Sections.GetItem().Number.ToString() _
+ " of " + TextControl1.Sections.Count.ToString())The following example works with sections in the current document.
SectionCollection sectionCollection = textControl.Sections;
sectionCollection.Add(SectionBreakKind.BeginAtNewPage, -1);Dim sectionCollection As SectionCollection = textControl.Sections
sectionCollection.Add(SectionBreakKind.BeginAtNewPage, -1)Members
Properties
| Property | Description |
|---|---|
| Count | Gets the number of elements contained in the collection. |
| Item | Gets a section from the collection. In C# this property is the indexer for the SectionCollection class. |
Methods
| Method | Description |
|---|---|
| Add | Adds a new section to a document. |
| CopyTo | Copies the elements of the collection to an array, starting at a particular index. |
| GetEnumerator | Returns an enumerator that can be used to iterate through the collection. |
| GetItem | Gets the Section with the current text input position from the collection. |