DS Server

StatusBarViewGenerator Object

Object|Introduced in 30.0

Description

Provides functions and properties for requesting properties and executing server side methods for the status bar.

Syntax

StatusBarViewGenerator

Examples

The following example demonstrates StatusBarViewGenerator in a practical document-editing workflow. It provides functions and properties for requesting properties and executing server side methods for the status bar.

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

TXTextControl.statusBar.getBorderStyle(
    function(borderStyle) {
        if (!borderStyle) {
            console.warn("No status bar border style was returned.");
            return;
        }
        
        console.log("get border style result:", borderStyle);
    },
    onTxError
);

Members

Properties

PropertyDescription
displayColorsThe displayed colors of the status bar.

Methods

MethodDescription
getBorderStyleGets the border style of the status bar. Always returns Fixed3D.
getColumnTextGets the text in the 'Column' area of the status bar.
getLineTextGets the text in the 'Line' area of the status bar.
getPageCounterTextGets the text in the 'Page counter' area of the status bar.
getPageTextGets the text in the 'Page' area of the status bar.
getSectionCounterTextGets the text in the 'Section counter' area of the status bar.
getSectionTextGets the text in the 'Section' area of the status bar.
getShowColumnSpecifies whether the status bar shows the column number of the current text input position.
getShowKeyStatesSpecifies whether the status bar shows the key state of the current insertion mode, insert or overwrite.
getShowLanguageSpecifies whether the status bar shows the language of the text selection or the text input position.
getShowLineSpecifies whether the status bar shows the line number of the current text input position.
getShowPageSpecifies whether the status bar shows the page number of the current text input position.
getShowPageCounterSpecifies whether the status bar shows the number of pages the document consists of.
getShowSectionSpecifies whether the status bar shows the section number of the current text input position.
getShowSectionCounterSpecifies whether the status bar shows the number of sections the document consists of.
getShowZoomSpecifies whether the status bar shows the current zoom factor.
getShowZoomTrackBarSpecifies whether the status bar displays a track bar instead of a simple number to show and to set the zooming factor.
resetDisplayColorsResets all display colors of a status bar to their system dependent default values.
setBorderStyleObsolete. This method will be removed in one of the next versions. Since version 33.0 it's not possible to change the border style of the status bar anymore. Sets the border style of the status bar.
setColumnTextSets the text in the 'Column' area of the status bar.
setLineTextSets the text in the 'Line' area of the status bar.
setPageCounterTextSets the text in the 'Page counter' area of the status bar.
setPageTextSets the text in the 'Page' area of the status bar.
setSectionCounterTextSets the text in the 'Section counter' area of the status bar.
setSectionTextSets the text in the 'Section' area of the status bar.
setShowColumnSpecifies whether the status bar shows the column number of the current text input position.
setShowKeyStatesSpecifies whether the status bar shows the key state of the current insertion mode, insert or overwrite.
setShowLanguageSpecifies whether the status bar shows the language of the text selection or the text input position.
setShowLineSpecifies whether the status bar shows the line number of the current text input position.
setShowPageSpecifies whether the status bar shows the page number of the current text input position.
setShowPageCounterSpecifies whether the status bar shows the number of pages the document consists of.
setShowSectionSpecifies whether the status bar shows the section number of the current text input position.
setShowSectionCounterSpecifies whether the status bar shows the number of sections the document consists of.
setShowZoomSpecifies whether the status bar shows the current zoom factor.
setShowZoomTrackBarSpecifies whether the status bar displays a track bar instead of a simple number to show and to set the zooming factor.