pymel.core.system.preloadRefEd

preloadRefEd(*args, **kwargs)

This creates an editor for managing which references will be read in (loaded) and which deferred (unloaded) upon opening a file.

Flags:

Long Name / Short Name Argument Types Properties
control / ctl bool ../../../_images/query.gif
  Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus. Caution: It is possible for an editor to exist without a control. The query will return NONEif no control is present.
defineTemplate / dt unicode ../../../_images/create.gif
  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.
docTag / dtg unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Attaches a tag to the editor.
exists / ex bool ../../../_images/create.gif
  Returns whether the specified object exists or not. Other flags are ignored.
filter / f unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the name of an itemFilter object to be used with this editor. This filters the information coming onto the main list of the editor.
forceMainConnection / fmc unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.
highlightConnection / hlc unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the name of a selectionConnection object that the editor will synchronize with its highlight list. Not all editors have a highlight list. For those that do, it is a secondary selection list.
lockMainConnection / lck bool ../../../_images/create.gif ../../../_images/edit.gif
  Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor. Further changes to the original mainConnection are ignored.
mainListConnection / mlc unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will only display items contained in the selectionConnection object.
panel / pnl unicode ../../../_images/create.gif ../../../_images/query.gif
  Specifies the panel for this editor. By default if an editor is created in the create callback of a scripted panel it will belong to that panel. If an editor does not belong to a panel it will be deleted when the window that it is in is deleted.
parent / p unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
selectCommand / sc callable  
   
selectFileNode / sf bool ../../../_images/query.gif
  Query the currently selected load setting. Returns the id of the currently selected load setting. This id can be used as an argument to the selLoadSettings command.
selectionConnection / slc unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the name of a selectionConnection object that the editor will synchronize with its own selection list. As the user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes changes, the editor updates to show the changes.
stateString / sts bool ../../../_images/query.gif
  Query only flag. Returns the MEL command that will create an editor to match the current editor state. The returned command string uses the string variable $editorName in place of a specific name.
unParent / up bool ../../../_images/create.gif ../../../_images/edit.gif
  Specifies that the editor should be removed from its layout. This cannot be used in query mode.
unlockMainConnection / ulk bool ../../../_images/create.gif ../../../_images/edit.gif
  Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.
updateMainConnection / upd bool ../../../_images/create.gif ../../../_images/edit.gif
  Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
useTemplate / ut unicode ../../../_images/create.gif
  Force the command to use a command template other than the current one. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.preloadRefEd

Example:

import pymel.core as pm

window = pm.window()
pm.paneLayout()
# Result: ui.PaneLayout('window1|paneLayout10') #
pm.preloadRefEd()
# Result: u'preloadRefEd1' #
pm.showWindow(window)