removeDocumentEditor

Description

Deletes a specified document editor.

Syntax

DCSObject.removeDocumentEditor(string documentEditorContainerId);

Parameters

<string> documentEditorContainerId: The id of a document editor container.

Return value

bool

true indicates success. false indicates failure.

Remarks

If the document editor with the specified container id doesn't exist, it returns false and when you check getErrorString(), you will get an error "The object [object name] does not exist.".

Example

if (DCSObject) {
   DCSObject.removeDocumentEditor("DCSDocumentEditorContainer2");
}

See Also

getErrorCode
getErrorString