Share

CommandControls.AddButtonPopup Method

Parent Object: CommandControls

Description

Method that creates a new popup CommandControl object. An example of this type of control is the 'Display Mode' drop down (Shaded, Hidden Edge, Wireframe) available on the 'View' tab of the ribbon in parts and assemblies.

Syntax

CommandControls.AddButtonPopup( ButtonDefinitions As ObjectCollection, [UseLargeIcon] As Boolean, [ShowText] As Boolean, [TargetControlInternalName] As String, [InsertBeforeTargetControl] As Boolean ) As CommandControl

Parameters

Name Type Description
ButtonDefinitions ObjectCollection Input ObjectCollection containing the ButtonDefinition objects hosted by this control. The first ButtonDefinition is used as the displayed control. Also, the internal and display names of the first definition are used for the control. The internal name of the control remains unchanged regardless of the currently displayed control.
UseLargeIcon Boolean Optional input Boolean that specifies whether to use large icon or small icon for the control. If not specified, the small icon is used by default.

This is an optional argument whose default value is False.
ShowText Boolean Optional input Boolean that specifies whether to display text (display name) for the control. If not specified, text is displayed by default.

This is an optional argument whose default value is True.
TargetControlInternalName String Optional input String that specifies the internal name of an existing control to position the new control next to. If specified, the InsertBeforeTargetControl argument indicates whether to place the new control before or after the target control. If not specified, the new control is positioned at the end.

This is an optional argument whose default value is "".
InsertBeforeTargetControl Boolean Optional input Boolean that specifies whether to position the new control before or after the target control. The argument defaults to False and is not used if the TargetControlInternalName argument is not specified.

This is an optional argument whose default value is False.

Version

Introduced in version 2010

Was this information helpful?