Category Creo Parametric user interface, Object ProMenubarmenu

Function ProMenubarmenuRadiogrpAdd


DEPRECATED: Since Creo 1
SUPERSEDED BY: ProCmdRadiogrpDesignate
Description
Note: This API is deprecated. Use ProCmdRadiogrpDesignate() to designate a Radiogrp and Customize UI dialog to add it in Creo Parametric Ribbon UI.

Adds a new radio group to the menu of Creo Parametric.

This function affects the top-level Creo Parametric menu bar only.

This function is executed only once during a Creo Parametric session for each radio group. Subsequent calls to this function for a previously loaded radio group are ignored.

Note:

To find the name of an existing item to use as a neighbor, select that item in Creo Parametric and look at your trail file.

Synopsis
#include <ProMenuBar.h>
ProErrorProMenubarmenuRadiogrpAdd(
ProMenuItemName parent_menu
/* (In)
The name of the parent menu
*/
ProMenuItemName radio_group_name
/* (In)
The name of the radio group (must be unique)
*/
int number_radio_group_items
/* (In)
The number of items in the radio group
*/
ProMenuItemName* radio_group_items
/* (In)
The names of the items in the radio group
*/
ProMenuItemLabel* radio_group_labels
/* (In)
The labels of the items in the radio group
*/
ProMenuLineHelp* one_line_helps
/* (In)
The one-line help strings for the radio group
*/
ProMenuItemName neighbor
/* (In)
The neighbor item in the parent menu.

Note: If you are adding the first item to a new menu (created using either ProMenubarMenuAdd() or ProMenubarmenuMenuAdd()), set the neighbor argument to NULL.

*/
ProBoolean add_after_neighbor
/* (In)
Defines whether to add the group before or after the neighbor item; PRO_B_TRUE specifes after
*/
uiCmdCmdId option_id
/* (In)
The identifier of the option
*/
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 menubar entity with this name already exists.
PRO_TK_GENERAL_ERRORThe function failed to add the radio group.

Manual References:

  1. Technical Summary of Changes for Creo 11.0.0.0: Functions superseded from Creo 1.0 to Creo 11.0

Sample Code References:

  1. pt_examples ( TestMenubar.c )