Description

Returns options for the nIdx underline.

Correspond to the fifth parameter of the >under...< GNML tag.

nIdx must be between 0 (first underline) and GetNUnderlines-1 (last defined underline). A run-time error occurs if nIdx is outside the valid range.

Syntax

object

Required. Object name, returned by Text.GetTextStatus, Text.GetParaTextStatus and Text.GetDefaultTextStatus functions

nIdx

Required. Underline index. Must be between 0 and GetNUnderlines.

iModes

Required. The sum of three possible values: 1 that disables the underlining of spaces, 2 that disables the underlining of letters with descenders and 4 that disables the underlining of letters higher than a standard lowercase 'x'. E.g. 0 produces a continuous underline, 3=2+1 produces an underline that stops under spaces and letters with descenders.

See also

Other underlines properties and functions