Category Creo Parametric user interface, Object ProCmd

Function ProCmdDesignate


Description
Designates the command or Chkbutton option to appear as placeable in the Screen Customization dialog. This may not be used for existing Creo Parametric system commands. Use ProCmdRadiogropDesignate() for designating Radiogrp option.
Replacement in Object TOOLKIT: pfcUICommand::Designate
Synopsis
#include <ProUICmd.h>
ProErrorProCmdDesignate(
uiCmdCmdId cmd_id
/* (In)
The command identifier.
*/
ProCmdItemLabel button_label
/* (In)
Message keystring referring to the button label . If the command was not assigned an icon, the button name will appear on the menu button by default.
*/
ProCmdLineHelp one_line_help
/* (In)
Message keystring referring to the button one line help.
*/
ProCmdDescription description
/* (In)
Message in the customization dialog and click on "Description"
*/
ProFileName msg_file
/* (In)
Message file name for the two keystrings.
*/
)
Returns
PRO_TK_NO_ERRORThe command was designated. Use the Screen Customization dialog box to place it.
PRO_TK_BAD_INPUTSOne or more input arguments was invalid.
PRO_TK_E_NOT_FOUNDThe message file was not found.
PRO_TK_MSG_NOT_FOUNDOne or more messages was not found in the message file.

Manual References:

  1. User Interface: Ribbon Tabs, Groups, and Menu Items: Workflow to Add Menu Items to the Ribbon User Interface
  2. User Interface: Menus, Commands, and Popupmenus: Adding a PushButton
  3. User Interface: Menus, Commands, and Popupmenus: Adding a PushButton
  4. User Interface: Menus, Commands, and Popupmenus: Adding a Check Button to the Ribbon User Interface
  5. User Interface: Menus, Commands, and Popupmenus: Adding a Radio Button Group to the Ribbon
  6. User Interface: Menus, Commands, and Popupmenus: Designating the Command
  7. User Interface: Menus, Commands, and Popupmenus: Designating the Command

Sample Code References:

  1. pt_af_examples ( PTAFExampleMain.c )
  2. pt_af_examples ( PTAFExampleMain.c )
  3. pt_af_examples ( PTAFExampleMain.c )
  4. pt_userguide ( UgMain.c )
  5. pt_userguide ( UgMain.c )
  6. pt_userguide ( UgMain.c )
  7. pt_userguide ( UgMain.c )