CIP JAVA documentation for class "com.ptc.pfc.pfcDetail.DetailSymbolInstItem"

Interface DetailSymbolInstItem

package com.ptc.pfc.pfcDetail; public interface DetailSymbolInstItem extends com.ptc.pfc.pfcDetail.DetailItem

Description

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

See Also:: DetailItemOwner.GetDetailItem(DetailType, int), DetailItemOwner.ListDetailItems(/*optional*/ DetailType, /*optional*/ Integer), DetailItemOwner.CreateDetailItem(DetailCreateInstructions)

Direct Known Subclasses:: WDetailSymbolInstItem

Method Summary
`void`	`Draw ()` Draws a symbol instance.
`void`	`Erase ()` Erases a symbol instance.
`DetailSymbolInstInstructions`	`GetInstructions (boolean GiveParametersAsNames)` Returns a data object detailing how a symbol instance is constructed.
`/optional/ DetailSymbolGroups`	`ListGroups (SymbolGroupFilter Filter)` List the symbol groups included in a symbol instance.
`void`	`Modify (DetailSymbolInstInstructions Instructions)` Modifies the definition of a symbol instance.
`void`	`Remove ()` Removes a symbol instance.
`void`	`Show ()` Shows a symbol instance.

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Methods Inherited from Interface `com.ptc.pfc.pfcDetail.DetailItem`
`GetDetailType`, `Delete`

Method Detail

Draw

void Draw ()

Draws a symbol instance.

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

Returns:

Erase

void Erase ()

Erases a symbol instance.

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

Returns:

Show

void Show ()

Shows a symbol instance.

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

Returns:

Remove

void Remove ()

Removes a symbol instance.

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

Returns:

GetInstructions

DetailSymbolInstInstructions GetInstructions (boolean 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.

Modify

void Modify (DetailSymbolInstInstructions Instructions)

Modifies the definition of a symbol instance.

Exceptions thrown (but not limited to):

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

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

Parameters:

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

Returns:

ListGroups

/*optional*/ DetailSymbolGroups ListGroups (SymbolGroupFilter Filter)

List the symbol groups included in a symbol instance.

Exceptions thrown (but not limited to):

XToolkitNotFound - 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.