CIP C++ documentation for class "pfcDetailSymbolInstItem"

Class pfcDetailSymbolInstItem

# include <pfcDetail.h> class pfcDetailSymbolInstItem : public virtual pfcDetailItem { xaideclare(pfcDetailSymbolInstItem) ... };

Description

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

See Also:: pfcDetailItemOwner::GetDetailItem(pfcDetailType, xint), pfcDetailItemOwner::ListDetailItems(optional pfcDetailType, optional xint), pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr)

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Direct Known Subclasses:: wfcWDetailSymbolInstItem

Method Summary


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

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

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

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

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

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

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

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Methods Inherited from Class pfcDetailItem:: GetDetailType, Delete

Method Detail

void Draw ()

Draws a symbol instance.

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

Returns:

void Erase ()

Erases a symbol instance.

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

Returns:

void Show ()

Shows a symbol instance.

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

Returns:

void Remove ()

Removes a symbol instance.

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

Returns:

pfcDetailSymbolInstInstructions_ptr GetInstructions (xbool GiveParametersAsNames)

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

Manual References:: Drawings: Detail Symbol Instances

Parameters:

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

Returns:: The instructions data object.

void Modify (pfcDetailSymbolInstInstructions_ptr 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.

Manual References:: Drawings: Detail Symbol Instances

Parameters:

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

Returns:

optional pfcDetailSymbolGroups_ptr 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.

Manual References:: Drawings: Detail Symbol Groups

Parameters:

Filter: The type of symbol groups to be listed.

Returns:: The list of symbol groups.