CIP JavaScript documentation for class " pfcFeatureGroup"

Class pfcFeatureGroup

Description

This class describes a feature group.

Property Summary


`/* readonly */ pfcFeature`	`GroupLeader`
	The group leader Feature

`/* readonly / / optional */ string`	`GroupName`
	The name of the group.

`/* readonly */ boolean`	`IsTableDriven`
	Reports whether the UDF is table-driven.

`/* readonly / / optional */ pfcGroupPattern`	`Pattern`
	The group pattern, if the group is a member of a pattern.

`/* readonly / / optional */ string`	`UDFInstanceName`
	If the group is an instance of a UDF, this is the UDF instance name. Otherwise this will be NULL.

`/* readonly / / optional */ string`	`UDFName`
	If the group represents a UDF, this is the UDF name. If the group is not a UDF, this will be NULL.

Method Summary


`/* optional */ pfcDimensions`	`CollectUDFDimensions ()`


`string`	`GetUDFDimensionName (pfcDimension Dim)`


`pfcFeatures`	`ListMembers ()`
	Lists the members of a feature group.

`/* optional */ pfcUDFDimensions`	`ListUDFDimensions ()`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): FeatureGroup.CollectUDFDimensions`
Lists the dimensions of a user defined feature group.

Property Detail

/* readonly */ pfcFeature GroupLeader

The group leader Feature

/* readonly */ /* optional */ string GroupName

The name of the group.

/* readonly */ boolean IsTableDriven

Reports whether the UDF is table-driven.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The feature is not part of a UDF

/* readonly */ /* optional */ pfcGroupPattern Pattern

The group pattern, if the group is a member of a pattern.

/* readonly */ /* optional */ string UDFInstanceName

If the group is an instance of a UDF, this is the UDF instance name. Otherwise this will be NULL.

/* readonly */ /* optional */ string UDFName

If the group represents a UDF, this is the UDF name. If the group is not a UDF, this will be NULL.

Method Detail

/* optional */ pfcDimensions CollectUDFDimensions ()

string GetUDFDimensionName (pfcDimension Dim)

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The group is not a UDF.

Parameters:

pfcFeatures ListMembers ()

Lists the members of a feature group.

/* optional */ pfcUDFDimensions ListUDFDimensions ()


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): FeatureGroup.CollectUDFDimensions`
Lists the dimensions of a user defined feature group. The UDF dimensions are the dimensions in the UDF for which Creo Parametric prompts when creating the UDF. Returns: Sequence of UDF Dimensions.