In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
-viewList(-vl)
|
|
|
|
Used in query mode, command will return a list of all views defined for this container.
|
|
-itemList(-il)
|
|
|
|
Used in query mode, the command will return a list of information for each item in
the view. The viewName flag is used to select the view to query.
The information returned about each item is determined by the itemInfo argument value.
For efficiency, it is best to query all necessary item information at one time
(to avoid recomputing the view information on each call).
|
|
-itemInfo(-ii)
|
string
|
|
|
Used in query mode in conjunction with the itemList flag.
The command will return a list of information for each item in the view, the
information fields returned for each item are determined by this argument value.
The information fields will be listed in the string array returned.
The order in which the keyword is specified will determine the order in which
the data will be returned by the command.
One or more of the following keywords, separated by colons ':' are used to
specify the argument value.
- itemIndex : sequential item number (0-based)
- itemName : item name (string)
- itemLabel : item display label (string)
- itemDescription : item description field (string)
- itemLevel : item hierarchy level (0-n)
- itemIsGroup : (boolean 0 or 1) indicates whether or not this item is a group
- itemIsAttribute : (boolean 0 or 1) indicates whether or not this item is an attribute
- itemNumChildren: number of immediate children (groups or attributes) of this item
- itemAttrType : item attribute type (string)
In query mode, this flag needs a value.
|
|
-viewName(-vn)
|
|
|
|
Used in query mode, returns name of the currently active view associated
with the container. This value may be empty if the current view is not
a valid template view or is generated by one of the built-in view modes.
For this reason, the view label is generally more suitable for display purposes.
|
|
-viewLabel(-vb)
|
|
|
|
Used in query mode, returns the display label associated with the view.
An appropriate label suitable for the user interface will be
returned based on the current container settings. Use of the view label
is usually more suitable than the view name for display purposes.
|
|
-viewDescription(-vd)
|
|
|
|
Used in query mode, returns the description field associated with the
currently active view.
If no description was defined for this view, the value will be empty.
|
|