Go to: Synopsis. Return value. Flags. Python examples.


setUITemplate( [string] , [popTemplate=boolean], [pushTemplate=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

setUITemplate is undoable, queryable, and NOT editable.

This command sets the current(default) command template for the ELF commands. The special name NONE can be used to set no templates current. See "uiTemplate" command also.

Return value

stringThe name of the currently selected command template.

In query mode, return type is based on queried flag.


popTemplate, pushTemplate
Long name (short name) Argument types Properties
pushTemplate(pst) boolean create
Push the current template onto a stack that can later be popped.
popTemplate(ppt) boolean create
Pop the current template off of the stack and sets the next template on the stack to be current.

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.

Python examples

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.button( label='One' )
cmds.button( label='Two' )
cmds.button( label='Three' )
cmds.setParent( '..' )
cmds.setParent( '..' )

cmds.button( label='Red' )
cmds.button( label='Green' )
cmds.button( label='Blue' )
cmds.setParent( '..' )
cmds.setParent( '..' )

cmds.setUITemplate( popTemplate=True )

cmds.showWindow( window )