ApiComboBoxForm

class ApiComboBoxForm extends ApiFormBase

Description

Class representing a document combo box / dropdown list.

GetListValues(): string[]: Returns the list values from the current combo box.
SetListValues(aListString): boolean: Sets the list values to the current combo box.
SelectListValue(sValue): boolean: Selects the specified value from the combo box list values.
SetText(sText): boolean: S.
IsEditable(): boolean: C.
GetClassType(): Returns a type of the ApiFormBase class.
GetFormType(): Returns a type of the current form.
GetFormKey(): Returns the current form key.
SetFormKey(sKey): Sets a key to the current form.
GetTipText(): Returns the tip text of the current form.
SetTipText(sText): Sets the tip text to the current form.
IsRequired(): Checks if the current form is required.
SetRequired(bRequired): Specifies if the current form should be required.
IsFixed(): Checks if the current form is fixed size.
ToFixed(nWidth, nHeight): Converts the current form to a fixed size form.
ToInline(): C.
SetBorderColor(r, g, b, bNone): Sets the border color to the current form.
SetBackgroundColor(r, g, b, bNone): Sets the background color to the current form.
GetText(): R.
Clear(): Clears the current form.
GetWrapperShape(): R.
SetPlaceholderText(sText): S.
SetTextPr(oTextPr): S.
GetTextPr(): R.
MoveCursorOutside(isAfter): Places a cursor before/after the current form.
Copy(): Copies the current form (copies with the shape if it exists).