TextBox Class

API Index

uid

Return the uid of the annotation.

Syntax

readonly uid: string;

pageUid

Return the uid of the page where the annotation is located.

Syntax

readonly pageUid: string;

Remark

• It will return '', if the annotation is be deleted.

creationDate

Return the creation date of the annotation.

Syntax

readonly creationDate: string;

Remark

• The string would be D:YYYYMMDDHHmmSSOHH'mm', like D:20230101085959-08'00'.

modificationDate

Return the modification date of the annotation.

Syntax

readonly modificationDate: string;

Remark

• The string would be D:YYYYMMDDHHmmSSOHH'mm', like D:20230101085959-08'00'.
• It will return '', if the annotation is be deleted.
• If the annotation is created but not be modified after adding, it equals to creationDate.

getOptions()

Get the annotation options.

Syntax

getOptions(): TextBoxAnnotationOptions;

Return value

The object of text box annotation options. Please refer to TextBoxAnnotationOptions.

Code Snippet

// Given that editViewer is an existing instance of EditViewer and a document is currently open.
const pageUid = editViewer.indexToUid(0);
const textBox = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "textBox"); // Create a default TextBox annotation instance.
const textBoxOptions = textBox.getOptions();

updateOptions()

Update the annotation options.

Syntax

updateOptions(textBoxAnnotationOptions: TextBoxAnnotationOptions): boolean;

Parameters

textBoxAnnotationOptions: The new text box annotation options. Please refer to TextBoxAnnotationOptions.

Return value

true: Successfully.

false: Failed.

Code Snippet

// Given that editViewer is an existing instance of EditViewer and a document is currently open.
const pageUid = editViewer.indexToUid(0);
const textBox = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "textBox"); // Create a default TextBox annotation instance.
const textBoxOptions = {
    background: "red",
};
textBox.updateOptions(textBoxOptions); // Update the background of the text box to red.

Warning