Description

Sets the nIdx underline.

0 correspond to the baseline, positive values are under the baseline. Correspond to the first parameter of the >under...< markup command.

nIdx must be between 0 and GetNUnderlines, when nIdx is equal to GetNUnderlines a new underline is added. 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 NUnderlines, when nIdx is equal to NUnderlines a new underline is added.

Y

Required. Vertical position.

Y

Required. Weight.

ColorName

Required. Color name.

ColorGray

Required. Gray.

DashName

Required. Dash name.

Flags

Required. 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