# Javascript: TextFrame.setDescriptiveText Method

> Sets a descriptive text for the text frame. An empty string or null can be used to delete a previously set text.

- **Product:** DS Server
- **Section:** Reference
- **Kind:** Method
- **Introduced:** 34.0
- **Path:** DS Server > Reference > JavaScript API > Javascript: TextFrame.setDescriptiveText Method
- **386 words**
- **Web URL:** https://docs.textcontrol.com/ds-server/reference/javascript/textframe/setdescriptivetext-method/
- **LLMs URL:** https://docs.textcontrol.com/ds-server/reference/javascript/textframe/setdescriptivetext-method/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/ds-server/reference/javascript/textframe/setdescriptivetext-method/llms-full.txt

---

### Description

Sets a descriptive text for the text frame. An empty string or null can be used to delete a previously set text.

### Syntax

```javascript
<void> TextFrame.setDescriptiveText(<string> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])
```

### Parameters

| Parameter | Description |
|---|---|
| value | The new property value. |
| callback | Optional. Is called when the operation completed. |
| errorCallback | Optional. Is called when the operation failed with an error. |

### Examples

The following example demonstrates `TextFrame.setDescriptiveText` in a practical document-editing workflow. It sets a descriptive text for the text frame. An empty string or null can be used to delete a previously set text.

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

function configureDescriptiveText(textFrame) {
    textFrame.setDescriptiveText(
        "Quarterly report",
        function() {
            console.log("set descriptive text completed.");
        },
        onTxError
    );
}
```

---

## Nearby

- **Previous:** [Javascript: TextFrame.setBorderWidth Method](https://docs.textcontrol.com/ds-server/reference/javascript/textframe/setborderwidth-method/llms-full.txt)
- **Next:** [Javascript: TextFrame.setID Method](https://docs.textcontrol.com/ds-server/reference/javascript/textframe/setid-method/llms-full.txt)