workspaceControl is undoable, queryable, and editable.
Creates and manages the widget used to host windows in a layout that enables docking and stacking windows together.
In query mode, return type is based on queried flag.
| Long name (short name) |
Argument types |
Properties |
|
-checksPlugins(-cp)
|
boolean
|
 
|
|
Sets whether the UI (as defined by the uiScript) checks the loaded state of one or more plug-ins in its code.
The UI will not be loaded until the auto-loading of plug-ins is complete. Default value is false.
|
|
-close(-cl)
|
|
|
|
Closes the workspace control.
|
|
-closeCommand(-cc)
|
script
|
|
|
Command that gets executed when the workspace control is closed.
|
|
-collapse(-clp)
|
boolean
|
|
|
Collapse or expand the tab widget parent of the workspace control.
|
|
-defineTemplate(-dt)
|
string
|
|
|
Puts the 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.
|
|
-dockToControl(-dtc)
|
string string
|
|
|
Dock this workspace control next to the given control. The first argument is the control name,
the second is dock position relative to the control (valid values are: "left", "right", "top", "bottom").
|
|
-dockToMainWindow(-dtm)
|
string boolean
|
|
|
Dock this workspace control into the main window. The first argument is dock position along the sides of
the main window (valid values are: "left", "right", "top", "bottom"), the second is whether or not the
control should be tabbed into the first control found at the dock position.
|
|
-dockToPanel(-dtp)
|
string string boolean
|
|
|
Dock this workspace control into the given workspace docking panel. The first argument is the panel name,
the second is dock position along the sides of the panel (valid values are: "left", "right", "top", "bottom"),
the third is whether or not the control should be tabbed into the first control found at the dock position.
|
|
-exists(-ex)
|
|
|
|
Returns whether the
specified object exists or not. Other flags are ignored.
|
|
-floating(-fl)
|
boolean
|
|
|
Whether the workspace control is floating.
|
|
-height(-h)
|
|
|
|
Query only flag returning the current height of the control.
|
|
-heightProperty(-hp)
|
string
|
|
|
Sets height property to the workspace control.
Valid values are:
- fixed - Can not be resized manually and will not be given any extra space while maximizing/dynamic resizing
- preferred - Can be resized manually but will not be given any extra space while maximizing/dynamic resizing
- free - Can be resized manually and will be given extra space while maximizing/dynamic resizing
Default: free
In query mode returns the current height property of the workspace control.
|
|
-initialHeight(-ih)
|
int
|
|
|
The initial height of the workspace control when first shown.
|
|
-initialWidth(-iw)
|
int
|
|
|
The initial width of the workspace control when first shown.
|
|
-label(-l)
|
string
|
|
|
The label text. The default label is the name of the workspace control.
|
|
-loadImmediately(-li)
|
boolean
|
|
|
Sets whether the UI (as defined by the uiScript) will be built immediately on workspace control
creation (true) or delayed until the control is actually shown (false). Default value is false.
|
|
-minimumWidth(-mw)
|
boolean
|
|
|
Sets the minimum width of control to the initial width. This should be used along with initial width flag.
|
|
-raise(-r)
|
|
|
|
Whether the workspace control widget is visible and either floating or at the top of its workspace area.
|
|
-requiredControl(-rc)
|
string
|
|
|
The name of a workspace control that this workspace control needs to be open in order to properly function.
This workspace control will not be created if the required control is not open, and will be closed when the
required control is closed.
|
|
-requiredPlugin(-rp)
|
string
|
|
|
The name of a plug-in that needs to be loaded in order to build the workspace control UI.
|
|
-restore(-rs)
|
|
|
|
Restores the control according to the following rules:
- If collapsed then the control will be expanded
- If hidden then the control will be shown
- If minimized then the control will be restored
- If the control is an inactive tab into a tab group then it will become the active tab
|
|
-retain(-rt)
|
boolean
|
|
|
Sets whether the workspace control is retained (i.e. only hidden) or deleted when closed. Default value is true.
|
|
-tabToControl(-ttc)
|
string int
|
|
|
Tab this workspace control into the given control. The first argument is the control name,
the second is the index position within the containing tab widget (invalid values mean append).
|
|
-uiScript(-ui)
|
script
|
|
|
The specified script will be invoked to build the UI of the workspaceControl. This is a required flag.
|
|
-useTemplate(-ut)
|
string
|
|
|
Forces the command to use a command template other than
the current one.
|
|
-visible(-vis)
|
boolean
|
|
|
The visible state of the workspace control. A control is created visible by default.
|
|
-visibleChangeCommand(-vcc)
|
script
|
|
|
Command that gets executed when visible state of the workspace control changes.
|
|
-width(-w)
|
|
|
|
Query only flag returning the current width of the control.
|
|
-widthProperty(-wp)
|
string
|
|
|
Sets width property to the workspace control.
Valid values are:
- fixed - Can not be resized manually and will not be given any extra space while maximizing/dynamic resizing
- preferred - Can be resized manually but will not be given any extra space while maximizing/dynamic resizing
- free - Can be resized manually and will be given extra space while maximizing/dynamic resizing
Default: free
In query mode returns the current width property of the workspace control.
|
|