DS Server

TextViewGeneratorColors Object

Object|Introduced in 28.0

Description

The TextViewGeneratorColors object provides methods for getting, setting or resetting the display colors of the TextControl. By default the display colors depend on sytem colors on the server. With this object all colors can be individually designed.

Syntax

TextViewGeneratorColors

Examples

The following example demonstrates TextViewGeneratorColors in a practical document-editing workflow. The TextViewGeneratorColors object provides methods for getting, setting or resetting the display colors of the TextControl. By default the display colors depend on sytem colors on the server. With this object all colors can be individually designed.

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

TXTextControl.displayColors.getActiveFormFieldColor(
    function(result) {
        console.log("get active form field color result:", result);
    },
    onTxError
);

Members

Methods

MethodDescription
getActiveFormFieldColorGets the highlight color of a form field containing the current text input position. If the property is not set, the return value is null.
getDarkShadowColorGets the display color for the shadow at the right and the bottom edge of the pages.
getDesktopColorGets the display color for the area around the pages.
getFormFieldColorGets the default highlight color of form fields. If the property is not set, the return value is null.
getHeaderFooterLabelColorGets the display color for the label showing which header or footer is activated.
getHeaderFooterLineColorGets the display color for the dividing line between headers and footers and the main text.
getLightShadowColorGets the display color for the shadow at the left and the top edge of the pages.
resetDarkShadowColorResets the text control's DarkShadowColor to its system dependent default value.
resetDesktopColorResets the text control's DesktopColor to its system dependent default value.
resetHeaderFooterLabelColorResets the text control's HeaderFooterLabelColor to its system dependent default value.
resetHeaderFooterLineColorResets the text control's HeaderFooterLineColor to its system dependent default value.
resetLightShadowColorResets the text control's LightShadowColor to its system dependent default value.
setActiveFormFieldColorSets the highlight color of a form field containing the current text input position. To suppress highlighting the active FormField the property value can be set to null.
setDarkShadowColorSets the display color for the shadow at the right and the bottom edge of the pages.
setDesktopColorSets the display color for the area around the pages.
setFormFieldColorSets the default highlight color of a form field. To suppress highlighting the FormField the property value can be set to null.
setHeaderFooterLabelColorSets the display color for the label showing which header or footer is activated.
setHeaderFooterLineColorSets the display color for the dividing line between headers and footers and the main text.
setLightShadowColorSets the display color for the shadow at the left and the top edge of the pages.