CIP JavaScript documentation for class " pfcDetailSymbolGroup"

Class pfcDetailSymbolGroup

Description

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

Property Summary


`/* readonly */ pfcDetailSymbolDefItem`	`ParentDefinition`
	The symbol definition of the given group.

`/* readonly / / optional */ pfcDetailSymbolGroup`	`ParentGroup`
	The parent symbol group of the level to which the given group belongs.

Method Summary


`void`	`Delete ()`
	To delete the given symbol group.

`pfcDetailSymbolGroupInstructions`	`GetInstructions ()`
	To get the instructions object describing how the symbol group is constructed.

`/* optional */ pfcDetailSymbolGroups`	`ListChildren ()`
	To list the subgroups of the given symbol group.

`void`	`Modify (pfcDetailSymbolGroupInstructions Instructions)`
	To modify the given symbol group.

Property Detail

/* readonly */ pfcDetailSymbolDefItem ParentDefinition

The symbol definition of the given group.

Exceptions thrown (but not limited to):

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

/* readonly */ /* optional */ pfcDetailSymbolGroup ParentGroup

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

Exceptions thrown (but not limited to):

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

Method Detail

void Delete ()

To delete the given symbol group.

pfcDetailSymbolGroupInstructions GetInstructions ()

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

/* optional */ pfcDetailSymbolGroups ListChildren ()

To list the subgroups of the given symbol group.

Exceptions thrown (but not limited to):

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

void Modify (pfcDetailSymbolGroupInstructions Instructions)

To modify the given symbol group.

Parameters: