# DocumentTarget Object

> The DocumentTarget object represents a text position in a Text Control document that is a target of a document link.

- **Product:** DS Server
- **Section:** Reference
- **Kind:** Object
- **Introduced:** 28.0
- **Path:** DS Server > Reference > JavaScript API > DocumentTarget Object
- **925 words**
- **Web URL:** https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/
- **LLMs URL:** https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/llms-full.txt

---

### Description

The DocumentTarget object represents a text position in a Text Control document that is a target of a document link.

### Syntax

```javascript
DocumentTarget
```

### Examples

The following example demonstrates `DocumentTarget` in a practical document-editing workflow. The DocumentTarget object represents a text position in a Text Control document that is a target of a document link.

```javascript
function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

TXTextControl.textParts.getMainText(function(mainText) {
    const documentTargets = mainText.documentTargets;
    documentTargets.getItem(function(documentTarget) {
        if (!documentTarget) {
            console.warn("No document target is available at the current input position.");
            return;
        }
    
        documentTarget.getID(
            function(result) {
                console.log("get id result:", result);
            },
            onTxError
        );
    }, onTxError);
}, onTxError);
```

---

## In This Section

- [Javascript: DocumentTarget.getAutoGenerationType Method](https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/getautogenerationtype-method/llms-full.txt): Gets the type of auto-generation. A document target which is the target of an entry in a table of contents is automatically generated when the table of contents is inserted into the document.
- [Javascript: DocumentTarget.getDeleteable Method](https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/getdeleteable-method/llms-full.txt): Gets whether a document target can be deleted by the end-user while a TX Text Control document is being edited.
- [Javascript: DocumentTarget.getID Method](https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/getid-method/llms-full.txt): Gets an identifier for a document target.
- [Javascript: DocumentTarget.getName Method](https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/getname-method/llms-full.txt): Relates a user-defined name to a document target.
- [Javascript: DocumentTarget.getNumber Method](https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/getnumber-method/llms-full.txt): Gets the one-based number of the document target in the document.
- [Javascript: DocumentTarget.getStart Method](https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/getstart-method/llms-full.txt): Gets the first character position (one-based) of a document target.
- [Javascript: DocumentTarget.getTargetName Method](https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/gettargetname-method/llms-full.txt): Gets the name of the document target.
- [Javascript: DocumentTarget.scrollTo Method](https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/scrollto-method/llms-full.txt): Sets the current input position to the beginning of the document target and scrolls it into the visible part of the document.
- [Javascript: DocumentTarget.setDeleteable Method](https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/setdeleteable-method/llms-full.txt): Sets whether a document target can be deleted by the end-user while a TX Text Control document is being edited.
- [Javascript: DocumentTarget.setID Method](https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/setid-method/llms-full.txt): Sets an identifier for the document target.
- [Javascript: DocumentTarget.setName Method](https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/setname-method/llms-full.txt): Sets the name of a document target.
- [Javascript: DocumentTarget.setTargetName Method](https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/settargetname-method/llms-full.txt): Sets the name of the document target.

---

## Nearby

- **Previous:** [Javascript: DocumentSettings.setUserDefinedDocumentProperties Method](https://docs.textcontrol.com/ds-server/reference/javascript/documentsettings/setuserdefineddocumentproperties-method/llms-full.txt)
- **Next:** [Javascript: DocumentTarget.getAutoGenerationType Method](https://docs.textcontrol.com/ds-server/reference/javascript/documenttarget/getautogenerationtype-method/llms-full.txt)