setDocumentBoundaryThickness()

Description

Sets the width of the document boundaries in the editor (in px). The default value is 2px.

Syntax

DocumentEditorObject.ui.setDocumentBoundaryThickness(thickness);

Parameters

<int> thickness: the width to set

Return value

bool

true indicates success. false indicates failure.

Remarks

If the value you set is bigger than 100,000 or smaller than 0, this method will return false and the width of the boundaries will remain unchanged. When you check getErrorString(), you will get an error "The value of parameter thickness is out of range.".

If the value you set equals 0, this method will return true, but no boundary will be drawn to the document.

Example

if (DCSObject)
{
    var documenteditor = DCSObject.getDocumentEditor("DocumentEditorContainer");  // Gets a specified document editor
    documenteditor.ui.setDocumentBoundaryThickness(4);
}

See also

.ui.getDocumentBoundaryThickness()