Item class

Returns

Item object

Return type

Item

Example

To create a new blank Item object:

var i = new Item();

Details of functions

DeleteColumn(column[integer])

Description

Delete a column from a table. Valid for item type Item.TABLE and Item.AUTO_TABLE.

Returns

No return value

Example

To delete the second column from table item i:

i.DeleteColumn(1);

DeleteRow(row[integer])

Description

Delete a row from a table. Valid for item type Item.TABLE.

Returns

No return value

Example

To delete the second row from table item i:

i.DeleteRow(1);

Generate()

Description

Generate an item.

Returns

No return value

Example

To generate item i:

i.Generate();

GetAll(page[Page]) [static]

Description

Get all of the items on a page.

Returns

Array of Item objects

Return type

Array

Example

To get all of the items on page p:

var items = Item.GetAll(p);

GetCellProperties(row[integer], column[integer])

Description

Get the properties of the specified cell. Valid for item type Item.TABLE.

Returns

Example

To get the properties of the top-left cell in a table:

i.GetCellProperties(0, 0);

GetColumnProperties(column[integer], header[constant])

Description

Get an autotable column properties. Valid for item type Item.AUTO_TABLE.

Returns

Example

Returns the column properties of the header of the first column:

i.GetColumnProperties(0, Reporter.AUTO_TABLE_HEADER);

GetColumnWidth(row[integer])

Description

Get the width of a table column. Valid for item types Item.TABLE or Item.AUTO_TABLE.

Returns

Integer. The width of the specified column.

Return type

Number

Example

To get the width of the first column in a table:

i.GetColumnWidth(0);

GetCondition(index[integer])

Description

Get the conditional formatting data for an item. Valid for item types Item.TEXT_FILE, Item.PROGRAM, Item.TEXT or Item.TEXTBOX (for Item.AUTO_TABLE and Item.TABLE, see GetCondition functions with additional arguments below).

Returns

Example

To get the data for the 2nd condition in item i:

var condition = i.GetCondition(1);

GetCondition(index[integer], column[integer])

Description

Get the conditional formatting data for an Item.AUTO_TABLE item.

Returns

Example

To get the data for the 2nd condition from the 3rd column in autotable item i:

var condition = i.GetCondition(1, 2);

GetCondition(index[integer], row[integer], column[integer])

Description

Get the conditional formatting data for an Item.TABLE item.

Returns

Example

To get the data for the 2nd condition from the 4th row, 3rd column in table item i:

var condition = i.GetCondition(1, 3, 2);

GetFromName(page[Page], name[string]) [static]

Description

Get an Item from its name.

Returns

Item object (or null if item cannot be found)

Return type

Item

Example

To get the item with name test on page p:

var item = Item.GetFromName(p, "test");

GetGeneratedData(row_index[integer], column_index[integer])

Description

Get the text that appears in an autotable cell once generated. Valid for item type Item.AUTO_TABLE.

Returns

String: the text displayed in the specified row and column.

Return type

String

Example

Get the data from the first cell in the first row and column in an autotable.

i.GetGeneratedData(0, 0);

GetRowHeight(row[integer])

Description

Get the height of a table row. Valid for item type Item.TABLE.

Returns

integer

Return type

Number

Example

To get the height of the first row in a table:

i.GetRowHeight(0);

InsertColumn(column[integer])

Description

Insert a column into a table. Valid for item types Item.TABLE and Item.AUTO_TABLE.

Returns

No return value

Example

To insert a column that will become the second column from the left of the table:

i.InsertColumn(1);

InsertRow(row[integer])

Description

Insert a row into a table. Valid for item type Item.TABLE.

Returns

No return value

Example

To insert a row that will become the second row from the top of the table:

i.InsertRow(1);

MergeCells(topLeftRow[integer], topLeftColumn[integer], rows[integer], columns[integer])

Description

Merge specified cells in a table. Valid for item types Item.TABLE and Item.AUTO_TABLE.

Returns

No return value

Example

To merge the cells in first row and the first two columns in the table:

i.MergeCells(0, 0, 1, 2);

RemoveCondition(condition[integer])

Description

Remove the specified condition for an item. Valid for item types Item.TEXT_FILE, Item.PROGRAM, Item.TEXT or Item.TEXTBOX (for Item.AUTO_TABLE and Item.TABLE, see RemoveCondition functions with additional arguments below).

Returns

No return value

Example

To remove the condition for the condition index 1 in item i:

i.RemoveCondition(1);

RemoveCondition(condition[integer], column[integer])

Description

Remove the specified condition for an Item.AUTO_TABLE item.

Returns

No return value

Example

To remove the condition for condition index 1 in the third column in item i:

i.RemoveCondition(1, 2);

RemoveCondition(condition[integer], row[integer], column[integer])

Description

Remove the specified condition for an Item.TABLE item.

Returns

No return value

Example

To remove the condition for condition index 1 in the fourth row, third column in item i:

i.RemoveCondition(1, 3, 2);

SetCellProperties(properties[object], row[integer], column[integer])

Description

Set the properties of the specified cell. Valid for item type Item.TABLE.

Returns

No return value

Example

To set the properties of the cell object to those of the object cell_obj:

i.SetCellProperties(cell_obj, 0, 0);

SetColumnProperties(properties[object], column[integer], header[constant])

Description

Set the properties of an autotable column. Valid for item type Item.AUTO_TABLE.

Returns

No return value

Example

Sets the column properties of the header of the first column with the properties of the object column_obj.

i.SetColumnProperties(column_obj, 0, Reporter.AUTO_TABLE_HEADER);

SetColumnWidth(column[integer], width[real])

Description

Set the width of a table column. Valid for item type Item.TABLE.

Returns

No return value

Example

To set the width of the first column in a table to 10.0:

i.SetColumnWidth(0, 10.0);

SetCondition(condition[integer], properties[object])

Description

Set the specified condition for an item. Valid for item types Item.TEXT_FILE, Item.PROGRAM, Item.TEXT or Item.TEXTBOX (for Item.AUTO_TABLE and Item.TABLE, see SetCondition functions with additional arguments below).

Returns

No return value

Example

To set the conditions for the condition index 1 in item i to those of the object obj:

var obj = { name:"example", type:Reporter.CONDITION_EQUAL_TO, value:"Test", textColour:Colour.Red() };
i.SetCondition(1, obj);

SetCondition(condition[integer], column[integer], properties[object])

Description

Set the specified condition for an Item.AUTO_TABLE item.

Returns

No return value

Example

To set the conditions for condition index 1 in the third column in item i to those of the object obj:

var obj = { name:"example", type:Reporter.CONDITION_EQUAL_TO, value:"Test", textColour:Colour.Red() };
i.SetCondition(1, 2, obj);

SetCondition(condition[integer], row[integer], column[integer], properties[object])

Description

Set the specified condition for an Item.TABLE item.

Returns

No return value

Example

To set the conditions for condition index 1 in the fourth row, third column in item i to those of the object obj:

var obj = { name:"example", type:Reporter.CONDITION_EQUAL_TO, value:"Test", textColour:Colour.Red()
}; i.SetCondition(1, 3, 2, obj);

SetRowHeight(row[integer], height[real])

Description

Set the height of a table row. Valid for item type Item.TABLE and Item.AUTO_TABLE.

Returns

No return value

Example

To set the height of the first row in a table to 10.0:

i.SetRowHeight(0, 10.0);

UnmergeCells(row[integer], column[integer])

Description

Unmerge the specified cell in a table. All cells merged to the specified cell will be unmerged. Valid for item types Item.TABLE and Item.AUTO_TABLE.

Returns

No return value

Example

To unmerge the top-left cell in a table:

i.UnmergeCells(0, 0);