Go to: Synopsis. Return value. Flags. Python examples.
uiTemplate(
[string]
, [defineTemplate=string], [exists=boolean], [useTemplate=string])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
uiTemplate is undoable, queryable, and editable.
This command creates a new command template object. Template objects can
hold default flag arguments for multiple UI commands. The command arguments
are specified with the individual commands using the -defineTemplate
flag and the desired flags and arguments. See also setUITemplate.
| string | The name of the uiTemplate created. |
In query mode, return type is based on queried flag.
defineTemplate, exists, useTemplate
| Long name (short name) |
Argument types |
Properties |
|
defineTemplate(dt)
|
string
|
|
|
Puts the command in a mode where any other flags and arguments 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.
|
|
exists(ex)
|
boolean
|
|
|
Returns whether the
specified object exists or not. Other flags are ignored.
|
|
useTemplate(ut)
|
string
|
|
|
Forces the command to use a command template other than
the current one.
|
|
|
Flag can appear in Create mode of command
|
Flag can appear in Edit mode of command
|
Flag can appear in Query mode of command
|
Flag can have multiple arguments, passed either as a tuple or a list.
|
import maya.cmds as cmds
# Create a new template.
#
if cmds.uiTemplate( 'ExampleTemplate', exists=True ):
cmds.deleteUI( 'ExampleTemplate', uiTemplate=True )
cmds.uiTemplate( 'ExampleTemplate' )
cmds.button( defineTemplate='ExampleTemplate', width=100, height=40, align='left' )
cmds.frameLayout( defineTemplate='ExampleTemplate', borderVisible=True, labelVisible=False )
# Create a window and apply the template.
#
window = cmds.window()
cmds.setUITemplate( 'ExampleTemplate', pushTemplate=True )
cmds.columnLayout( rowSpacing=5 )
cmds.frameLayout()
cmds.columnLayout()
cmds.button( label='One' )
cmds.button( label='Two' )
cmds.button( label='Three' )
cmds.setParent( '..' )
cmds.setParent( '..' )
cmds.frameLayout()
cmds.columnLayout()
cmds.button( label='Red' )
cmds.button( label='Green' )
cmds.button( label='Blue' )
cmds.setParent( '..' )
cmds.setParent( '..' )
cmds.setUITemplate( popTemplate=True )
cmds.showWindow( window )