DS Server

Javascript: FormattingStyle.getUnderline Method

Method|Introduced in 28.0

Description

Gets the underlining styles for the style.

Syntax

<void> FormattingStyle.getUnderline(<RequestFontUnderlineStyleCallback> callback)

Parameters

ParameterDescription
callback

Receives the underlining styles for the style.

Examples

The following example demonstrates FormattingStyle.getUnderline in a practical document-editing workflow. It gets the underlining styles for the style.

function inspectUnderline(formattingStyle) {
    formattingStyle.getUnderline(
        function(result) {
            if (!result) {
                console.warn("No font underline style was returned.");
                return;
            }
            
            console.log("get underline result:", result);
        }
    );
}