Accessors for class IliTablePropertyManager

Methods

getProperty
getPropertyCount
getPropertyNameAt
getScopedProperty
hasProperty
removeProperty
setIntProperty
setStringProperty

Description

The IliTablePropertyManager class defines objects that manage properties attached to parts of a table.
A property is identified by the property name and the part of the table to which it is attached. The part of the table can be one of the following:

The whole table (rowno == -1 and colno == -1)
A whole column (rowno == -1 and colno >= 0)
A whole row (rowno >= 0 and colno == -1)
A given cell (rowno >= 0 and colno >= 0)

In addition to specifying a given row (rowno >= 0) or all rows (rowno == -1), it is possible to specify the insertion row (rowno == -2).

Scoped Properties

In addition to the methods that manage the properties that are attached to a given part, there are member functions that access so-called scoped properties. A given part of the table has a given scoped property if it has the property of the same name or if it falls within another part which has this property.
For example, if a given row has a property called "background" and a cell in that row has no property of that name, the cell still has a scoped property called "background" that it inherits from its row.
The order in which scoped properties are searched is cell/row/column/table.

Type Name Description Notes

Variant getProperty(Int rowno, Int colno, String propName) If the part of the table identified by rowno and colno has a property named propName, this method returns the value of this property. Otherwise, null is returned. The exact type of the return value depends on the type of the property.

Int getPropertyCount(Int rowno, Int colno) Returns the number of properties attached to the part of the table identified by rowno and colno.

String getPropertyNameAt(Int rowno, Int colno, Int propIndex) Returns the property name of the part identified by rowno and colno positioned at propIndex. Returns null if propIndex is < 0 or if it is >= getPropertyCount(rowno, colno).

Variant getScopedProperty(Int rowno, Int colno, String propName) If the part of the table identified by rowno and colno has a scoped property named propName, this method returns the value of this property. Otherwise, null is returned. The exact type of the return value depends on the type of the property.

Boolean hasProperty(Int rowno, Int colno, String propName) Returns true if the part of the table identified by rowno and colno has a property named propName.

Void removeProperty(Int rowno, Int colno, String propName) Removes the property named propName from the part of the table identified by rowno and colno.

Void setIntProperty(Int rowno, Int colno, String propName, Int propVal) Attaches to the part of the table identified by rowno and colno a property named propName with a value of propVal.

Void setStringProperty Void setStringProperty(Int rowno,

Int colno Int colno,

String propName String propName,

String propVal Attaches to the part of the table identified by rowno and colno a property named propName with a value of propVal.

Type	Name	Description
`Variant`	`getProperty(Int rowno, Int colno, String propName)`	If the part of the table identified by `rowno` and `colno` has a property named `propName`, this method returns the value of this property. Otherwise, `null` is returned. The exact type of the return value depends on the type of the property.
`Int`	`getPropertyCount(Int rowno, Int colno)`	Returns the number of properties attached to the part of the table identified by `rowno` and `colno`.
`String`	`getPropertyNameAt(Int rowno, Int colno, Int propIndex)`	Returns the property name of the part identified by `rowno` and `colno` positioned at `propIndex`. Returns `null` if `propIndex` is `< 0` or if it is `>= getPropertyCount(rowno, colno)`.
`Variant`	`getScopedProperty(Int rowno, Int colno, String propName)`	If the part of the table identified by `rowno` and `colno` has a scoped property named `propName`, this method returns the value of this property. Otherwise, `null` is returned. The exact type of the return value depends on the type of the property.
`Boolean`	`hasProperty(Int rowno, Int colno, String propName)`	Returns `true` if the part of the table identified by `rowno` and `colno` has a property named `propName`.
`Void`	`removeProperty(Int rowno, Int colno, String propName)`	Removes the property named `propName` from the part of the table identified by `rowno` and `colno`.
`Void`	`setIntProperty(Int rowno, Int colno, String propName, Int propVal)`	Attaches to the part of the table identified by `rowno` and `colno` a property named `propName` with a value of `propVal`.
`Void`	`setStringProperty`	Void setStringProperty(Int rowno,
`Int`	`colno`	Int colno,
`String`	`propName`	String propName,
`String`	`propVal`	Attaches to the part of the table identified by `rowno` and `colno` a property named `propName` with a value of `propVal`.