CustomParameterGroup Object

Description

The CustomParameterGroup object represents a grouping of certain parameters in the parameters dialog. These groups serve as a logical grouping of parameters to allow the user to more easily find a specific parameter.

Methods

Name	Description
Add	Method that adds a parameter to the group. Adding a parameter to a group does not remove it from group(s) that it currently resides in.
Delete	Method that deletes the group and optionally deletes the parameters that it contains.
Remove	Method that removes a parameter from the group. This does not delete the parameter.

Properties

Name	Description
Application	Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
ClientId	Property that returns the string that uniquely identifies the client. This is the CLSID of the AddIn in a string form, e.g. "{C9A6C580-3817-11D0-BE4E-080036E87B02}".
Count	Property that returns the number of parameters in this group.
DisabledActionTypes
DisplayName
InternalName	Property that returns the name of the custom group. The name is the internal English name of the group. This name will remain constant and is not affected by locale. The name is never displayed to the user. The display name is what's shown to the user.
Item	Returns the specified Parameter object.
Type	Returns an ObjectTypeEnum indicating this object's type.

Accessed From

CustomParameterGroups.Add, CustomParameterGroups.Item

Samples

Name	Description
Creating a new parameter group	This sample demonstrates the creation of model, reference and user parameters and copying these parameters to a newly created group.

Version

Introduced in version 10