panelConfiguration is undoable, queryable, and editable.
This command creates a panel configuration object. Typically you would
not call this method command directly. Instead use the Panel Editor.
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
-exists(-ex)
|
|
|
|
Returns true|false depending upon whether the
specified object exists. Other flags are ignored.
|
|
-defineTemplate(-dt)
|
string
|
|
|
Puts a command in a mode where any other flags and args are
parsed and added to the command template specified in the argument.
They will be used as default arguments in any subsequent
invocations of the command when templateName is set as the
current template.
|
|
-useTemplate(-ut)
|
string
|
|
|
Force the command to use a command template other than
the current one.
|
|
-label(-l)
|
string
|
|
|
-defaultImage(-di)
|
string
|
|
|
The default image for this configuration. Once the default image
is set it may not be changed. If an image is set with the -i/image
flag then it's value will take precedence.
|
|
-image(-i)
|
string
|
|
|
The user specified image for this configuration. Use this flag
to override the default image.
|
|
-sceneConfig(-sc)
|
boolean
|
|
|
Specifies whether the configuration is associated with the scene.
Scene configurations are created when the scene is opened and deleted when
the scene is closed.
|
|
-configString(-cfs)
|
string
|
|
|
Specifies the string that arranges the panels.
|
|
-numberOfPanels(-np)
|
|
|
|
Returns the number of panels in the configuration.
|
|
-addPanel(-ap)
|
boolean string string string string
|
|
|
Adds the specified panel to the configuration. Arguments are:
isFixed, label string, type string, create string, edit string.
|
|
-replacePanel(-rp)
|
int boolean string string string string
|
|
|
Replaces the specified panel in the configuration. Arguments are:
index, isFixed, label string, type string, create string, edit string.
The index is 1 based.
|
|
-replaceLabel(-rl)
|
int string
|
|
|
Replaces the specified label. The index is 1 based.
|
|
-replaceEditString(-res)
|
int string
|
|
|
Replaces the specified edit string. The index is 1 based.
|
|
-replaceCreateString(-rcs)
|
int string
|
|
|
Replaces the specified create string. The index is 1 based.
|
|
-replaceFixedState(-rfs)
|
int boolean
|
|
|
Replaces the specified fixed state value (true|false). The index is 1 based.
|
|
-replaceTypeString(-rts)
|
int string
|
|
|
Replaces the specified type string. The index is 1 based.
|
|
-removeLastPanel(-rlp)
|
|
|
|
Removes the last panel in the config.
|
|
-removeAllPanels(-rap)
|
|
|
|
Removes the last panel in the config.
|
|
-isFixedState(-if)
|
|
|
|
Returns an integer array of whether the panels have fixed states or not.
|
|
-labelStrings(-ls)
|
|
|
|
Returns an string array of the panel labels.
|
|
-typeStrings(-ts)
|
|
|
|
Returns an string array of the panel types.
|
|
-createStrings(-cs)
|
|
|
|
Returns an string array of the panel creation strings.
|
|
-editStrings(-es)
|
|
|
|
Returns an string array of the panel edit strings.
|
|