DS Server

Selection Object

Object|Introduced in 24.0

Description

Describes and handles the attributes of a text selection. Each of the properties of this class returns the property's default value if the selection does not contain a common value.

Syntax

Selection

Examples

The following example demonstrates Selection in a practical document-editing workflow. Describes and handles the attributes of a text selection. Each of the properties of this class returns the property's default value if the selection does not contain a common value.

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

TXTextControl.selection.getText(
    function(result) {
        console.log("get text result:", result);
    },
    onTxError
);

Members

Properties

Property	Description
listFormat	Gets a bulleted or numbered list and / or its formatting attributes for the selected text.
paragraphFormat	Gets the formatting attributes of the selected paragraphs.
sectionFormat	Gets page settings such as margins, size and orientation for the selected text.

Methods

Method	Description
changeCapitalization	Changes the capitalization of all selected characters depending on the 'capitalizationParameter' parameter.
changeDirection	Changes the writing direction of all selected paragraphs. When the direction of a paragraph is changed, this paragraph's alignment is toggled from left to right or from right to left. The alignment of centered and justified paragraphs is not changed. Left and right tabulators are also toggled.
decreaseIndent	Decreases the left indent of all paragraphs contained in the current text selection. If no text is selected, this method decreases the left indent at the text input position. Left indent positions are defined through the paragraphs' tab positions and the indents of the paragraphs in front and behind the paragraph with the text input position.
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 selected text. Takes a callback function as a parameter which is called with the baseline alignment, in twips, of the selected text. Positive values moves the baseline to superscript, negative values move the baseline to subscript.
getBold	Gets the bold attribute of the selected text.
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 selection information from the server.
getFontName	Gets the font name of the selected text.
getFontSize	Gets the font's size, in points, of the selected text.
getForeColor	Gets the color used to display the selected text.
getFormattingStyle	Gets the formatting style of the selected text.
getItalic	Gets the italic attribute of the selected text.
getLength	Gets the number of selected characters.
getStart	Gets the starting point of selected text.
getStrikeout	Gets the strikeout attribute of the selected text.
getText	Gets the currently selected text.
getTextBackColor	Gets the background color of the selected text.
getUnderline	Gets the underlining styles of the selected text.
growFont	Increases the font size of each font contained in the current text selection.If no text is selected, this method increases the font size at the text input position.
increaseIndent	Increases the left indent of all paragraphs contained in the current text selection. If no text is selected, this method increases the left indent at the text input position. Left indent positions are defined through the paragraphs' tab positions and the indents of the paragraphs in front and behind the paragraph with the text input position.
isCommonListFormatValueSelected	Informs about whether an attribute from the ListFormat.Attribute enumeration has the same value for the complete selection.
isCommonPageBorderValueSelected	Informs about whether an attribute from the PageBorder.Attribute enumeration has the same value for the complete selection.
isCommonPageMarginsValueSelected	Informs about whether an attribute from the PageMargins.Attribute enumeration has the same value for the complete selection.
isCommonPageSizeValueSelected	Informs about whether an attribute from the PageSize.Attribute enumeration has the same value for the complete selection.
isCommonPargraphFormatValueSelected	Informs about whether an attribute from the ParagraphFormat.Attribute enumeration has the same value for the complete selection.
isCommonSectionFormatValueSelected	Informs about whether an attribute from the SectionFormat.Attribute enumeration has the same value for the complete selection.
isCommonSelectionValueSelected	Informs about whether an attribute from the Selection.Attribute enumeration has the same value for the complete selection.
load	Loads text in a certain format into the current selection.
removeFormatting	Resets all character based formatting attributes of the selected text to its default values. If nothing or more than one paragraph is selected, all paragraph based formatting attributes are also reset.
removeInlineStyles	Removes all character based styles of the selected text so that all attributes are reset to the attributes of the paragraph style.
save	Saves the current selection in a certain format and sends the result back asynchronously by calling a given callback function.
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 selected text.
setBold	Sets the bold attribute of the selected text.
setBounds	Obsolete. This method will be removed in one of the next versions. Sets the selection's start position and length.
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's name of the selected text.
setFontSize	Sets the font's size, in points, of the selected text.
setForeColor	Sets the selection's foreground color.
setFormattingStyle	Sets the formatting style of the selected text.
setItalic	Sets the italic attribute of the selected text.
setLength	Sets the number of selected characters.
setStart	Sets the starting point of selected text.
setStrikeout	Sets the strikeout attribute of the selected text.
setText	Sets the currently selected text.
setTextBackColor	Sets the selection's background color.
setUnderline	Sets the underlining styles for the selected text.
shrinkFont	Decreases the font size of each font contained in the current text selection. If no text is selected, this method decreases the font size at the text input position.

Enumerations

Enumeration	Description
Attribute	Determines a certain selection attribute.