DS Server

Javascript: TextViewGeneratorColors.getHeaderFooterLineColor Method

Method|Introduced in 28.0

Description

Gets the display color for the dividing line between headers and footers and the main text.

Syntax

<void> TextViewGeneratorColors.getHeaderFooterLineColor(<RequestStringCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives the color for the dividing line between headers and footers and the main text.

errorCallback

Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates TextViewGeneratorColors.getHeaderFooterLineColor in a practical document-editing workflow. It gets the display color for the dividing line between headers and footers and the main text.

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

TXTextControl.displayColors.getHeaderFooterLineColor(
    function(result) {
        console.log("get header footer line color result:", result);
    },
    onTxError
);