struct EdmCmdData

SolidWorks Enterprise PDM passes an array of 0 or more EdmCmdData structures when it calls to IEdmAddIn5::OnCmd.

Typically there is one structure for each file affected by the command. For instance, if the user has selected five files and two folders and launches an add-in-implemented menu command, the add-in receives seven structures, one for each of the selected files and folders. If the reason for calling IEdmAddIn5::OnCmd is a hook on a command like Check out, Check in, Get, Change state, etc., the add-in receives one structure per file. The actual meaning of each structure member varies with the reason for calling IEdmAddIn5::OnCmd. The reason for a call can be determined by examining the meCmdType member of the EdmCmd structure that is passed in the first argument of IEdmAddIn5::OnCmd.

The following tables contain all members for each EdmCmdType. Members that are not listed for a certain type of command are undefined.

EdmCmdType.EdmCmd_Menu

The user has activated a menu item or toolbar button that your add-in has added. This command returns a combination of refresh flags in the mlEdmRefreshFlags member of the EdmCmd structure.

Note: You will also receive pointers to the IEdmEnumeratorVariable5 and IEdmCard5 interfaces in the EdmCmd::mpoExtra member. The content of the EdmCmd::mbsComment member is the button command string entered in the Card Editor.

EdmCmdType.EdmCmd_CardInput

The user has modified some data in a file or folder data card.

Note: You will also receive pointers to the IEdmEnumeratorVariable5 and IEdmCard5 interfaces in the EdmCmd::mpoExtra member. The content of the EdmCmd::mbsComment member is the name of the modified variable.

EdmCmdType.EdmCmd_CardListSrc

A file or folder data card containing a list box or combo box is displayed. The add-in’s IEdmAddIn5::OnCmd method is given the opportunity to fill in the rows in the list instead of using the list contents defined in the card editor.

Note: You will also receive a pointer to the IEdmEnumeratorVariable5 and IEdmCard5 interfaces via the EdmCmd::mpoExtra member. The content of the EdmCmd::mbsComment member is the return value from your add-in's IEdmAddIn5::OnCmd implementation. This variable should be set to a newline delimited list of strings to be inserted into the list box or combo box. Leave this variable untouched to use the standard values from the card editor.

EdmCmdType.EdmCmd_PreAdd

A file is about to be added.

EdmCmdType.EdmCmd_PostAdd

A file has been added.

EdmCmdType.EdmCmd_PreAddFolder

A folder is about to be added.

EdmCmdType.EdmCmd_PostAddFolder

A folder has been added.

EdmCmdType.EdmCmd_PreCopy and EdmCmdType.EdmCmd_PostCopy

A file is copied.

EdmCmdType.EdmCmd_PreCopyFolder

A folder is about to be copied.

EdmCmdType.EdmCmd_PostCopyFolder

A folder has been copied.

EdmCmdType.EdmCmd_PreDelete

A file is about to be deleted.

EdmCmdType.EdmCmd_PostDelete

A file has been deleted.

EdmCmdType.EdmCmd_PreDeleteFolder and EdmCmdType.EdmCmd_PostDeleteFolder

A folder is deleted.

EdmCmdType.EdmCmd_PreGet and EdmCmdType.EdmCmd_PostGet

A file is retrieved from the archive to the local hard disk.

EdmCmdType.EdmCmd_PreLock and EdmCmdType.EdmCmd_PostLock

A file is checked out.

EdmCmdType.EdmCmd_PreMove and EdmCmdType.EdmCmd_PostMove

A file is moved from one folder to another one.

EdmCmdType.EdmCmd_PreMoveFolder and EdmCmdType.EdmCmd_PostMoveFolder

A folder is moved from one parent folder to another one.   

EdmCmdType.EdmCmd_PreRename and EdmCmdType.EdmCmd_PostRename

A file is renamed.

EdmCmdType.EdmCmd_PreRenameFolder and EdmCmdType.EdmCmd_PostRenameFolder

A folder is renamed.

EdmCmdType.EdmCmd_PreShare and EdmCmdType.EdmCmd_PostShare

A file is shared from one folder to another one.

EdmCmdType.EdmCmd_PreState and EdmCmdType.EdmCmd_PostState

The user changes the workflow state of a file.

You will receive an IEdmCmdNode interface in the mpoExtra member of the struct as of Enterprise PDM 2011 during the change state operation.

EdmCmdType.EdmCmd_PreUndoLock and EdmCmdType.EdmCmd_PostUndoLock

The user runs the command Undo check-out on a file. (This is the same as check-in of an unmodified file.)

EdmCmdType.EdmCmd_PreUnlock and EdmCmdType.EdmCmd_PostUnlock

The user runs a check-in on a modified file. (Check-in on unmodified files results in an Undo check-out operation.)

EdmCmdType.EdmCmd_SerialNo

New serial number(s) should be generated by your add-in.

EdmCmdType.EdmCmd_TaskSetup

This call is made to your add-in when the task definition property dialog box is called. The call makes it possible for you to add your own custom pages to the wizard. The EdmCmd::mpoExtra pointer points to IEdmTaskProperties, the interface of the task definition.

You typically do the following in this call:

• Call IEdmTaskProperties::SetSetupPages to add property dialog box pages.
• Call IEdmTaskProperties::SetMenuCmds to add menu commands to show in Windows Explorer.
• Update the IEdmTaskProperties::TaskFlags property to inform the framework about what your add-in is capable of.

None of the members in the EdmCmdData structure are used.

EdmCmdType.EdmCmd_TaskSetupButton

This call is made to your add-in when the task definition property dialog box is closed. The EdmCmd::mbsComment string is either "OK" or "Cancel", depending on how the dialog box closed. (The string is the same in all localized versions of the program.) The call makes it possible for you to save your own properties when OK is clicked. You can prevent the dialog box from closing by setting the EdmCmd::mbCancel member to true. You can return the name of an add-in page to set focus to in the EdmCmd::mbsComment string if EdmCmd::mbCancel is set to true. EdmCmd::mpoExtra points to IEdmTaskProperties, the interface of the task definition.

None of the members in the EdmCmdData structure are used.

EdmCmdType.EdmCmd_TaskDetails

This call is made to your add-in when the task details dialog box is displayed from the task list in the administration tool. You must specify the flag EdmTaskFlag.EdmTask_SupportsDetails in the IEdmTaskProperties::TaskFlags property in order to get the EdmCmd_TaskDetails call. You can set the flag when you get the EdmCmdType.EdmCmd_TaskSetup call. EdmCmd::mpoExtra points to IEdmTaskInstance, the interface of the task instance.

The EdmCmd::mpoExtra pointer should be set to your implementation of the extra page. The framework keeps this pointer referenced until the dialog box is closed. You return the window handle of the extra page in the member EdmCmd::mlParentWnd. The property dialog box calls ShowWindow when the page is displayed or hidden.

None of the members in the EdmCmdData structure are used.

EdmCmdType.EdmCmd_TaskRun

This is the callback that is called when the actual work of the task is supposed to be executed. The task is usually executed on a remote server so you must not display any user interface during this call. See the OnTaskRun function in the task sample code for an example of how to return status information and errors to the user.

The EdmCmd::mlCurrentFolderID argument is the ID of the current folder when the task was launched. It is zero if the task was launched from the administration tool.

EdmCmd::mpoExtra points to the IEdmTaskInstance interface of the task instance.

EdmCmdType.EdmCmd_TaskLaunch

You need to specify the EdmTask_SupportsInitExec in the IEdmTaskProperties::TaskFlags property in order to get this call. The launch call makes it possible for you to display a user interface where the user selects files or enters data in a custom dialog box. As an alternative, you can create a card with the card editor and use that instead. EdmCmd::mpoExtra points to IEdmTaskInstance, the interface of the task instance in this call.

You can return a dialog box implementation (user control) in the EdmCmd::mpoExtra argument. In this case you must also return the window of the control in EdmCmd::mlParentWnd. The form is then put in the same parent dialog box as the card, if you are using one.

You can set EdmCmd::mbCancel to true to halt further execution of the task.

The call can update the selection of objects to execute the task on by altering the content of the EdmCmdData structure.

EdmCmdType.EdmCmd_TaskLaunchButton

This callback is made if the framework displays its own dialog box during the launching of a task. The framework displays its own dialog box if a card has been selected for the task or if you returned a user control from the EdmCmdType.EdmCmd_TaskLaunch hook. EdmCmd::mbsComment contains the string "OK" or "Cancel", depending on which button was clicked. The strings are the same on all localized versions of the program. EdmCmd::mpoExtra points to IEdmTaskInstance, the interface of the task. You can set EdmCmd::mbCancel to true to halt further execution of the task.

None of the members in the EdmCmdData structure are used.

EdmCmdType.EdmCmd_PreLabel and EdmCmdType.EdmCmd_PostLabel

A label is being created on files and/or folders.

EdmCmdType.EdmCmd_PreLabelDelete, EdmCmdType.EdmCmd_PostLabelDelete, EdmCmdType.EdmCmd_PreLabelModify, and EdmCmdType.EdmCmd_PostLabelModify

A label is being deleted or modified.

EdmCmdType.EdmCmd_PreLabelAddItem and EdmCmdType.EdmCmd_PostLabelAddItem

A file or folder is being added to an existing label.