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

Interface DetailSymbolGroup

package com.ptc.pfc.pfcDetail; public interface DetailSymbolGroup extends com.ptc.pfc.pfcObject.Object

Description

This interface represents a symbol group contained in a drawing symbol.

Method Summary
`void`	`Delete ()` To delete the given symbol group.
`DetailSymbolGroupInstructions`	`GetInstructions ()` To get the instructions object describing how the symbol group is constructed.
`DetailSymbolDefItem`	`GetParentDefinition ()` Get method for attribute "ParentDefinition" The symbol definition of the given group.
`/optional/ DetailSymbolGroup`	`GetParentGroup ()` Get method for attribute "ParentGroup" The parent symbol group of the level to which the given group belongs.
`/optional/ DetailSymbolGroups`	`ListChildren ()` To list the subgroups of the given symbol group.
`void`	`Modify (DetailSymbolGroupInstructions Instructions)` To modify the given symbol group.

Method Detail

GetParentGroup

/*optional*/ DetailSymbolGroup GetParentGroup ()

The parent symbol group of the level to which the given group belongs.

Exceptions thrown (but not limited to):

XToolkitNotFound - The group is a top level group and does not have a parent.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups

GetParentDefinition

DetailSymbolDefItem GetParentDefinition ()

The symbol definition of the given group.

Exceptions thrown (but not limited to):

XToolkitNotFound - The group is a top level group and does not have a parent.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups

ListChildren

/*optional*/ DetailSymbolGroups ListChildren ()

To list the subgroups of the given symbol group.

Exceptions thrown (but not limited to):

XToolkitNotFound - No groups are stored in the symbol definition at this level.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups

GetInstructions

DetailSymbolGroupInstructions GetInstructions ()

To get the instructions object describing how the symbol group is constructed.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups

Modify

void Modify (DetailSymbolGroupInstructions Instructions)

To modify the given symbol group.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups

Parameters:

Delete

void Delete ()

To delete the given symbol group.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups