CIP Visual Basic.NET documentation for interface "IpfcDetailSymbolInstItem"

Interface IpfcDetailSymbolInstItem

Description

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

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

Method Summary


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

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

`Function`	`GetInstructions (GiveParametersAsNames as Boolean) as IpfcDetailSymbolInstInstructions`
	Returns a data object detailing how a symbol instance is constructed.

`Function`	`ListGroups (Filter as IpfcSymbolGroupFilter) as IpfcDetailSymbolGroups [optional]`
	List the symbol groups included in a symbol instance.

`Sub`	`Modify (Instructions as IpfcDetailSymbolInstInstructions)`
	Modifies the definition of a symbol instance.

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

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

Method Detail

Sub Draw ()

Draws a symbol instance.

Sub Erase ()

Erases a symbol instance.

Function GetInstructions (GiveParametersAsNames as Boolean) as IpfcDetailSymbolInstInstructions

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.

Function ListGroups (Filter as IpfcSymbolGroupFilter) as IpfcDetailSymbolGroups [optional]

List the symbol groups included in a symbol instance.

Exceptions thrown (but not limited to):

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

Parameters:

Sub Modify (Instructions as IpfcDetailSymbolInstInstructions)

Modifies the definition of a symbol instance.

Exceptions thrown (but not limited to):

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

Parameters:

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

Sub Remove ()

Removes a symbol instance.

Sub Show ()

Shows a symbol instance.