Category Creo Parametric user interface, Object ProCmd

Function ProCmdRadiogrpDesignate


Description
Designates the radio button to appear as placeable in the Screen Customization dialog. This may not be used for existing Creo Parametric system radio buttons.
Synopsis
#include <ProUICmd.h>
ProErrorProCmdRadiogrpDesignate(
uiCmdCmdId option_id
/* (In)
The identifier of the option
*/
int number_radio_group_items
/* (In)
The number of items in the radio group
*/
ProCmdItemName* radio_group_items
/* (In)
ProArray of names of the items in the radio group
*/
ProCmdItemLabel* radio_group_labels
/* (In)
ProArray of labels of the items in the radio group
*/
ProCmdLineHelp* one_line_helps
/* (In)
ProArray of one-line help strings for the radio group
*/
ProCmdItemIcon* radio_group_icons
/* (In)
ProArray of names of the icon file including the extension. It can be either a .PNG, .GIF, .JPG, .PCX, .BMP, .ICO, .CUR file or a Creo Parametric .BIF file. Make sure to provide the filename including a valid file extension, denoting the type of the image as one of the standard formats listed above. PTC recommends using .PNG file. All icons in Creo Parametric Ribbon are either 16x16 (small) or 32x32 (large) size. As a standard naming convention icon name should not have 32x32 or 20x20 or 16x16 postfix. When Creo Parametric wants to display small icon it looks for iconname.ext and when it looks for large icon it looks for iconname_large.ext file. In order to support legacy applications if iconname.ext is not of 16x16 or 20x20 then Creo Parametric looks iconname16x16.ext or iconname20x20.ext. This support will go away in future releases. PTC recommends using standard icon naming conventions i.e. iconname.ext or iconname_large.ext. For example in order to designate both small and large icon to a command, place both my_icon.png and my_icon_large.png in the resource directory and use my_icon.png as icon file name.

Note: The default search paths for finding the icons are:

  • Creo Parametric Loadpoint/text/resource
  • Application text dir/resource
  • Application text dir/(language)/resource
The location of the application text directory is specified in the registry file.

*/
ProCmdDescription description
/* (In)
Message in the customization dialog and click on "Description"
*/
ProFileName filename
/* (In)
The name of the message file that contains labels and help strings
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully added the radio group.
PRO_TK_MSG_NOT_FOUNDThe specified message was not found in the message file.
PRO_TK_E_FOUNDa menu item with this name already exists.
PRO_TK_GENERAL_ERRORThe function failed to add the radio group.

Manual References:

  1. User Interface: Menus, Commands, and Popupmenus: Designating the Command
  2. User Interface: Menus, Commands, and Popupmenus: Designating the Command
  3. Technical Summary of Changes for Creo 11.0.0.0: Functions superseded from Creo 1.0 to Creo 11.0