CIP JavaScript documentation for class " pfcDetailSymbolInstItem"

Class pfcDetailSymbolInstItem

Description

This interface represents a symbol instance in a Creo Parametric model.

See Also:: pfcDetailItemOwner.GetDetailItem(), pfcDetailItemOwner.ListDetailItems(), pfcDetailItemOwner.CreateDetailItem()

Method Summary


`void`	`Draw ()`
	Draws a symbol instance.

`void`	`Erase ()`
	Erases a symbol instance.

`pfcDetailSymbolInstInstructions`	`GetInstructions (boolean GiveParametersAsNames)`
	Returns a data object detailing how a symbol instance is constructed.

`/* optional */ pfcDetailSymbolGroups`	`ListGroups (pfcSymbolGroupFilter Filter)`
	List the symbol groups included in a symbol instance.

`void`	`Modify (pfcDetailSymbolInstInstructions Instructions)`
	Modifies the definition of a symbol instance.

`void`	`Remove ()`
	Removes a symbol instance.

`void`	`Show ()`
	Shows a symbol instance.

Method Detail

void Draw ()

Draws a symbol instance.

void Erase ()

Erases a symbol instance.

pfcDetailSymbolInstInstructions GetInstructions (boolean GiveParametersAsNames)

Returns a data object detailing how a symbol instance is constructed.

Parameters:

GiveParametersAsNames: true to get symbolic representations of parameter entries in the text, false to get the actual text shown to the user.

/* optional */ pfcDetailSymbolGroups ListGroups (pfcSymbolGroupFilter Filter)

List the symbol groups included in a symbol instance.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No groups with the designated status were found in the symbol instance.

Parameters:

void Modify (pfcDetailSymbolInstInstructions Instructions)

Modifies the definition of a symbol instance.

Exceptions thrown (but not limited to):

pfcXToolkitCantWrite - Could not modify the given item because it has read-only access.

Parameters:

Instructions: Data object containing the new placement instructions for the instance.

void Remove ()

Removes a symbol instance.

void Show ()

Shows a symbol instance.