TextBoxCollection

TextBoxCollection class

Encapsulates a collection of TextBox objects.

class TextBoxCollection;

Methods

MethodDescription
get(number)Gets the TextBox element at the specified index.
get(string)Gets the TextBox element by the name.
add(number, number, number, number)Adds a textbox to the collection.
removeAt(number)Remove a text box from the file.
clear()Clear all text boxes.
getCount()@deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in.
isNull()Checks whether the implementation object is null.

get(number)

Gets the TextBox element at the specified index.

get(index: number) : TextBox;

Parameters:

ParameterTypeDescription
indexnumberThe zero based index of the element.

Returns

The element at the specified index.

get(string)

Gets the TextBox element by the name.

get(name: string) : TextBox;

Parameters:

ParameterTypeDescription
namestringThe name of the text box.

Returns

TextBox

add(number, number, number, number)

Adds a textbox to the collection.

add(upperLeftRow: number, upperLeftColumn: number, height: number, width: number) : number;

Parameters:

ParameterTypeDescription
upperLeftRownumberUpper left row index.
upperLeftColumnnumberUpper left column index.
heightnumberHeight of textbox, in unit of pixel.
widthnumberWidth of textbox, in unit of pixel.

Returns

TextBox object index.

removeAt(number)

Remove a text box from the file.

removeAt(index: number) : void;

Parameters:

ParameterTypeDescription
indexnumberThe text box index.

clear()

Clear all text boxes.

clear() : void;

getCount()

@deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in.

getCount() : number;

isNull()

Checks whether the implementation object is null.

isNull() : boolean;