SetRichTextAlign

Description

Sets the alignment value to use while editing columns with the RichText edit style.

Applies to

DataWindow control

Syntax

Integer dwcontrol.SetRichTextAlign ( Alignment sAlign )

Argument

Description

dwcontrol

A reference to the DataWindow control

sAlign

Value for specifying the alignment that you want to set for columns with the RichText edit style. Allowable values are:

Left!
Right!
Center!
Justified!

Return value

Returns 0 if it succeeds and -1 if an error occurs. If the argument's value is null, SetRichTextAlign returns null.

0 -- Success

-1 -- No RichText column is being edited

Usage

You can call this method from a button in a custom toolbar that you use to set display characteristics of columns with the RichText edit style.

Examples

This example sets the alignment value for editing columns that have a RichText edit style:

Integer ll_temp
Alignment l_align
l_align = Right!
ll_temp = dw_1.SetRichTextAlign(l_align)

See also

GetRichTextAlign

GetRichTextColor

GetRichTextFaceName

GetRichTextSize

GetRichTextStyle