TXTextControl.DocumentLinkCollection Class

An instance of the DocumentLinkCollection class contains all links in a Text Control document that point to targets in the same document. An instance of this class can be obtained with the TextControl.DocumentLinks property. The DocumentLinkCollection class implements the IEnumerable and the ICollection interfaces. Document links are represented through the DocumentLink class. For more information see the technical article Text Fields and Hypertext Links.

Syntax

[C#]
public sealed class DocumentLinkCollection: TextFieldCollectionBase
[Visual Basic]
Public NotInheritable Class DocumentLinkCollection
  Inherits TextFieldCollectionBase

Properties

Property Description
CanAdd Gets a value indicating whether a new text field can be inserted at the current input position. (Inherited from TextFieldCollectionBase.)
Count Gets the number of elements contained in the collection. (Inherited from TextFieldCollectionBase.)
IsSynchronized Returns true if the collection is designed to be thread safe, otherwise, it returns false. (Inherited from TextFieldCollectionBase.)
SyncRoot Gets an object that can be used to synchronize access to the collection. (Inherited from TextFieldCollectionBase.)

Methods

Method Description
Add Inserts a new document link at the current input position.
Clear Removes all document links from a Text Control 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. (Inherited from TextFieldCollectionBase.)
GetItem Overloaded. Gets a particular document link from the collection.
Remove Overloaded. Removes a document link from a Text Control document.

See Also