TXTextControl.DocumentLinkCollection.Remove Method

Removes a document link from a Text Control document.

Remove(DocumentLink)

Removes a document link including its visible text from a Text Control document.

[C#]
public bool Remove(DocumentLink documentLink);
[Visual Basic]
Public Function Remove(ByVal documentLink As DocumentLink) As Boolean
Parameter Description
documentLink

Specifies the document link to remove.

Remove(DocumentLink, Boolean)

Removes a document link from a Text Control document. The visible text is deleted depending on the keepText parameter.

[C#]
public bool Remove(DocumentLink documentLink, bool keepText);
[Visual Basic]
Public Function Remove(ByVal documentLink As DocumentLink, ByVal keepText As Boolean) As Boolean
Parameter Description
documentLink

Specifies the document link to remove.

keepText

If this parameter is set to true, the document link is removed without deleting its text. Otherwise, the link's text is also deleted.

Return Value

The return value is true, if the document link could be removed. Otherwise it is false.

See Also