TextBoxCollection
Contents
[
Hide
]TextBoxCollection class
Encapsulates a collection of TextBox objects.
class TextBoxCollection implements Iterable<TextBox>;
Methods
[Symbol.iterator](): Iterator<TextBox>
Returns an iterator over the items in the collection. Enables use of for...of, spread syntax, and Array.from().
get(number)
Gets the TextBox element at the specified index.
get(index: number) : TextBox;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The 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:
| Parameter | Type | Description |
|---|---|---|
| name | string | The name of the text box. |
Returns
add(number, number, number, number)
Adds a textbox to the collection.
add(topRow: number, leftColumn: number, height: number, width: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| topRow | number | Upper left row index. |
| leftColumn | number | Upper left column index. |
| height | number | Height of textbox, in unit of pixel. |
| width | number | Width of textbox, in unit of pixel. |
Returns
TextBox object index.
removeAt(number)
Remove a text box from the file.
removeAt(index: number) : void;
Parameters:
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;