setDocumentBoundaryColor()

Description

Sets the color of the document boundaries. It is a value specifying the 32-bit RGBA. The default value is 0x5EB7E4FF.

Syntax

DocumentEditorObject.ui.setDocumentBoundaryColor(iValue);

Parameters

<int> iValue: the value to set, ranging from 0x00000000 to 0xFFFFFFFF.

Return value

bool

true indicates success. false indicates failure.

Remarks

The byte-ordering of the 32-bit RGBA value is RRGGBBAA. RR represents red, GG represents green, BB represents blue, AA represents opacity, all ranging from 0 to 0xFF. For AA, 0 is transparent, 0xFF is non-transparent.
In browsers, opacity is from 0 to 1. We will transform it, so sometimes the value you get might be different from the value you set.
For non-HTML5 browsers like IE 6-9, AA value larger than 0 will be regarded as non-transparent.

Example

if (DCSObject)
{
    var documenteditor = DCSObject.getDocumentEditor("DocumentEditorContainer");  // Gets a specified document editor
    documenteditor.ui.setDocumentBoundaryColor(0xFFFF00FF); // Sets the color of the document boundary
}
      

See also

.ui.getDocumentBoundaryColor()