FormFieldGetEmptyWidth

Description

Gets the empty width (that is, the width of the field when there is no text displayed) set for a form field. The type of the form field may be FormFieldCheckBox, FormFieldComboBox, FormFieldText, and FormFieldDate.

Applies to

RichTextEdit control

Syntax

rtename.FormFieldGetEmptyWidth(integer fieldID)

Argument

Description

fieldID

The unique ID assigned to the form field.


Return value

Integer.

If it succeeds, returns the width of the field, in twips, when the field is empty. If a form field is inserted without the emptyWidth setting, a default width of 2000 twips is used. For almost all units of measurement in the RichTextEdit control, twips are used. Twip is a fabricated word meaning twentieth of a point (pt).

Returns -1 if the field ID maps to a checkbox form field. Returns -2 if the field ID maps to a non-form field. If any argument's value is null, returns null. Returns -1 if an error occurs.

Examples

This example gets the empty width of the specified form field.

integer li_formid,li_rtn

li_formid = rte_1.FormDateFieldInsert(today(),false)
li_rtn = rte_1.FormFieldGetEmptyWidth(li_formid)