CategoryOrGroupOrItem
String rw backgroundColor
The background color of the receiver in hex format (e.g. blue would be "#0000FF").
Category ro category
The category to which this object belongs.
boolean rw fontBold
True if font is bold.
String rw fontFace
The font family name.
boolean rw fontItalic
True if font is italic.
float rw fontSize
The point size of the font.
boolean rw fontStrikethrough
True if font is strikethrough.
boolean rw fontUnderline
True if font is underlined.
String rw foregroundColor
The foreground color of the receiver in hex format (e.g. blue would be "#0000FF").
String rw horizontalAlignment
The horizontal alignment of the receiver - one of "Left", "Right", "Center", or "Automatic".
String rw name
The name of this object.
Object rw value
When getting, returns the first value this object contains. When setting, sets all values in this object to the one given.
List<Object> ro values
The list of values this object contains.
String rw verticalAlignment
The vertical alignment of the receiver - one of "Top", "Bottom", or "Middle".
boolean canDelete()
True if this object can be deleted.
boolean canSetName()
True if this object's name can be set.
void delete()
Deletes this object and its children, if any.
If the object is a Category
GroupOrItemCreateList ro children
The list of this object's immediate children (not recursive).
List<String> ro itemDescriptors
The list of item descriptors in this category, whether visible or not.
SNamedList<Item> ro items
The list of all items beneath this object. Does not include groups.
SNamedList<Matrix> ro matrices
The list of all matrices (visible to the current user) that contain this category.
Set<String> ro visibleItemDescriptors
The set of all visible item descriptors in this category.
void replace(List<String> names)
Remove all the groups and items along this category (clearing any data in any matrices that reference it) and replace them with new items named as per
names.
If
names contains duplicates, numbers will be appended to differentiate the names.
A category must have at least one item, so
names must not be
null or empty.
Parameters:
If the category is linked to other matrices, it replaces this category with a new one that is not linked to any other matrices and returns it. It returns this category otherwise.
If the object is a Group
Group ro cellsOnly
Gets only the cells from this group (excludes items).
int ro childIndex
The index of this object within its parent's child list.
boolean rw collapsed
True if this object is collapsed.
int rw columnWidth
The column width for this selection.
If the selection does not designate a set of columns, this property will return -1 and setting it will have no effect.
Returns the current number format string for this object. May return null for a non-standard format.
CategoryOrGroup ro parent
The parent of this object.
int rw rowHeight
The row height for this selection.
If the selection does not designate a set of rows, this property will return -1 and setting it will have no effect.
Inserts the contents of
items immediately after this one in the current child list. Returns a list of the added items.
Parameters:
Inserts the specified items immediately after this one in the current child list. Returns a list of the added items.
Parameters:
True if it is possible to set the number format of this object.
void setToAccountingNumberFormat()
Sets this object's number format to accounting.
void setToCurrencyNumberFormat()
Sets this object's number format to currency.
void setToPercentNumberFormat()
Sets this object's number format to percent.
void ungroup()
Ungroups the items in this group.
If the object is an Item
int ro itemIndex
The index of this item within its parent's child list.
void copy()
Copy the item (along with its data) to the clipboard
void cut()
Remove the item and place it (along with its data) on the clipboard
void paste()
Paste from the clipboard into the selection for this item. May have different results depending on what's on the clipboard. If nothing valid is on the clipboard, this will have no effect.