TextPartCollection Class
- Namespace
TXTextControl.Web
- Package
TXTextControl.from nuget.org, the private NuGet feed or Text Control Offline PackagesWeb
- Assembly
TXTextControl.Web. DocumentEditor. dll
- Install
dotnet add package TXTextControl.Web
- Implements
- ICollection<IFormatted
Text> , IEnumerable<IFormattedText> , IEnumerable
Description
An instance of the Web.TextPartCollection class contains all text parts in a TX Text Control document. A text part can either be the document's main text, a text frame or a header or footer. A text frame is represented through a Web.TextFrame object, a header or footer through a Web.HeaderFooter object and the document's main text is represented through a Web.MainText object. A Web.TextPartCollection object contains all these objects in a geometric order. The first object in the collection is the main text, followed by all text frames in geometric order. At the end of the collection all headers and footers are contained also geometrically ordered. All objects in a text part collection implement the Web.IFormattedText interface. The collection can be obtained with the Web.TextControl.TextParts property. The Web.TextPartCollection class implements the interface ICollection<Web.IFormattedText>.
Syntax
public class TextPartCollection : ICollection<IFormattedText>, IEnumerable<IFormattedText>, IEnumerablePublic Class TextPartCollection
Implements ICollection(Of IFormattedText), IEnumerable(Of IFormattedText), IEnumerableExamples
The following example creates a Text Part Collection object and prepares it for a document workflow.
TXTextControl.Web.TextPartCollection textPartCollection = new(new TXTextControl.Web.WebSocketHandler());
Console.WriteLine("Text Part Collection is ready for the document workflow.");Dim textPartCollection As New TXTextControl.Web.TextPartCollection(New TXTextControl.Web.WebSocketHandler())
Console.WriteLine("Text Part Collection is ready for the document workflow.")Members
Constructors
| Constructor | Description |
|---|---|
| TextPartCollection | Not described in the reference. public TextPartCollection(WebSocketHandler wsHandler); |
Properties
| Property | Description |
|---|---|
| Count | Not described in the reference. public int Count { get; } |
| IsReadOnly | Not described in the reference. public bool IsReadOnly { get; } |
Methods
| Method | Description |
|---|---|
| Activate | Sets the input focus to the specified text part. If the activated text part is not in the visible part of the document, the document is scrolled. |
| Add | Not described in the reference. public void Add(IFormattedText item); |
| Clear | Not described in the reference. public void Clear(); |
| Contains | Not described in the reference. public bool Contains(IFormattedText item); |
| CopyTo | Not described in the reference. public void CopyTo(IFormattedText[] array, int arrayIndex); |
| GetEnumerator | Not described in the reference. public TextPartEnumerator GetEnumerator(); |
| Remove | Not described in the reference. public bool Remove(IFormattedText item); |