DS Server

FormattingStyle Object

Object|Introduced in 28.0

Description

The FormattingStyle object represents a styling for a text range.

Syntax

FormattingStyle

Examples

The following example demonstrates FormattingStyle in a practical document-editing workflow. The FormattingStyle object represents a styling for a text range.

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

function inspectFormattingStyle(formattingStyle) {
    formattingStyle.getAutoBaseline(
        function(result) {
            if (!result) {
                console.warn("No auto baseline was returned.");
                return;
            }
            
            console.log("get auto baseline result:", result);
        },
        onTxError
    );
}

Members

Methods

Method	Description
apply	Applies all set attributes of the style to the current document.
getAutoBaseline	Gets values specifying automatic sub- or superscripted text. When using automatic sub- and superscript the font is scaled and moved above or below the baseline with values defined through the font itself. Automatic sub- and superscript can be combined with a user-defined baseline which can be set with the Baseline property.
getBaseline	Gets the baseline alignment, in twips, of the style.
getBaseStyle	Gets the FormattingStyle which is the base style of this style.
getBold	Gets the bold attribute of the style.
getCapitals	Gets values specifying wheather lowercase letters are displayed with capital letters. Lowercase letters are displayed either with capital letters of the same size or with capital letters which have a smaller size. The smaller size is either the size of the lowercase 'x' (petite caps) or the size of the lowercase 'x' + 10% (small caps).
getCharacterScaling	Gets or sets the style's character scaling, in percent of the average character width.
getCharacterSpacing	Gets the style's character spacing value, in twips. This value is added to each character. When it is negative, character spacing is reduced, otherwise it is extended.
getCulture	Gets the culture as a languagecode2-country / regioncode2 string value. Takes a callback function as a parameter which is called with a languagecode2-country / regioncode2 string ("de-DE", "en-US" or "en", for example) as a parameter upon receiving the culture value.
getFontName	Gets the font of the style.
getFontSize	Gets the font's size of the style.
getForeColor	Gets the style's color used to display the text.
getItalic	Gets the italic attribute of the style.
getName	Gets the name of the style.
getStrikeout	Gets the strikeout attribute of the style.
getTextBackColor	Gets the style's text background color.
getUnderline	Gets the underlining styles for the style.
setAutoBaseline	Sets values specifying automatic sub- or superscripted text. When using automatic sub- and superscript the font is scaled and moved above or below the baseline with values defined through the font itself. Automatic sub- and superscript can be combined with a user-defined baseline which can be set with the Baseline property.
setBaseline	Sets the baseline alignment, in twips, of the style.
setBold	Sets the bold attribute of the style.
setCapitals	Sets values specifying wheather lowercase letters are displayed with capital letters. Lowercase letters are displayed either with capital letters of the same size or with capital letters which have a smaller size. The smaller size is either the size of the lowercase 'x' (petite caps) or the size of the lowercase 'x' + 10% (small caps).
setCharacterScaling	Sets or sets the style's character scaling, in percent of the average character width.
setCharacterSpacing	Sets the style's character spacing value, in twips. This value is added to each character. When it is negative, character spacing is reduced, otherwise it is extended.
setCulture	Sets the culture as a languagecode2-country / regioncode2 string value.
setFontName	Sets the font of the style.
setFontSize	Sets the font's size of the style.
setForeColor	Sets the style's color used to display the text.
setItalic	Sets the italic attribute of the style.
setName	Sets the name of the style.
setStrikeout	Sets the strikeout attribute of the style.
setTextBackColor	Sets the style's text background color.
setUnderline	Sets the underlining styles for the style.