TXTextControl.DocumentTarget Class

The DocumentTarget class represents a text position in a Text Control document that is a target of a document link. Because a target cannot have visible text, the Textfield.Text property is not supported for this class. For more information see the technical article Text Fields and Hypertext Links.

Syntax

[C#]
public class DocumentTarget : TextField
[Visual Basic]
Public Class DocumentTarget
  Inherits TextField

Constructors

Constructor Description
DocumentTarget Initializes a new instance of the DocumentTarget class.

Properties

Property Description
Bounds Gets the bounding rectangle of a text field. (Inherited from TextField.)
ContainsInputPosition Returns true, if the Textfield contains the current text input position. (Inherited from TextField.)
Deleteable Specifies whether a text field can be deleted by the end-user while a TX Text Control document is being edited. (Inherited from TextField.)
DoubleClickEvent Specifies whether a TextControl.TextFieldDoubleClicked event is raised, if the end-user doubleclicks the text field. (Inherited from TextField.)
DoubledInputPosition Specifies whether a text field has a doubled input position in front of its first character and behind its last character. (Inherited from TextField.)
Editable Specifies whether the text of a text field can be changed by the end-user while a TX Text Control document is being edited. (Inherited from TextField.)
FormattingBounds Gets the formatting rectangle of a text field. (Inherited from TextField.)
ID Gets or sets an identifier for a text field. (Inherited from TextField.)
IsSpellCheckingEnabled Specifies whether a text field's text is checked on misspelled words. (Inherited from TextField.)
Length Gets the number of characters in a text field. (Inherited from TextField.)
Name Relates a user-defined name to a text field. (Inherited from TextField.)
ShowActivated Specifies whether a text field toggles its background to gray, if the current input position is in the field. (Inherited from TextField.)
Start Gets the first character position (one-based) of a text field. (Inherited from TextField.)
TargetName Gets or sets the name of the target.
Text Returns or sets the text which is contained within a text field. (Inherited from TextField.)

Methods

Method Description
ScrollTo Sets the current input position to the beginning of a text field and scrolls it into the visible part of the document. (Inherited from TextField.)

Example

The following example shows how to insert a DocumentTarget and a corresponding DocumentLink into a document.

[C#]
textControl1.ViewMode = TXTextControl.ViewMode.PageView;
textControl1.Text = "Page 1\fPage 2\fPage 3";
textControl1.Select(3, 0);

TXTextControl.DocumentTarget newTarget = new TXTextControl.DocumentTarget("Page1");

textControl1.DocumentTargets.Add(newTarget);
textControl1.InputPosition = new TXTextControl.InputPosition(2, 1, 3);
TXTextControl.DocumentLink newLink = new TXTextControl.DocumentLink("Jump to page 1", newTarget);
textControl1.DocumentLinks.Add(newLink);
[Visual Basic]
TextControl1.ViewMode = TXTextControl.ViewMode.PageView
TextControl1.Text = "Page 1" + Chr(12) + "Page 2" + Chr(12) + "Page 3"
TextControl1.Select(3, 0)

Dim newTarget As TXTextControl.DocumentTarget = New TXTextControl.DocumentTarget("Page1")

TextControl1.DocumentTargets.Add(newTarget)
TextControl1.InputPosition = New TXTextControl.InputPosition(2, 1, 3)
Dim newLink As TXTextControl.DocumentLink = New TXTextControl.DocumentLink("Jump to page 1", newTarget)
TextControl1.DocumentLinks.Add(newLink)

See Also