CIP JavaScript documentation for class " pfcDetailGroupInstructions"

Class pfcDetailGroupInstructions

Description

This interface contains information used to describe a detail group item. It may be used when creating detail groups (pfcDetailItemOwner.CreateDetailItem()), or accessing existing groups (pfcDetailGroupItem.Modify() and pfcDetailGroupItem.GetInstructions()).

Direct Parent Classes:: pfcDetailCreateInstructions

Property Summary


`pfcDetailItems`	`Elements`
	Sequence of detail items contained in the group.

`/* optional */ boolean`	`IsDisplayed`
	`true` if the group is displayed in the drawing, otherwise `false`.

`string`	`Name`
	The name of the detail group.

Method Summary


`static pfcDetailGroupInstructions`	`Create (string inName, pfcDetailItems inElements)`
	Creates an instructions data object used to describe the construction of a detail group, for use in the methods `pfcDetailItemOwner.CreateDetailItem()` and `pfcDetailGroupItem.Modify()`.

Property Detail

pfcDetailItems Elements

Sequence of detail items contained in the group.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - Invalid type of one of item.

pfcXToolkitOutOfMemory - Not enough memory.

pfcXToolkitNotFound - The group does not contain any items.

/* optional */ boolean IsDisplayed

true if the group is displayed in the drawing, otherwise false.

string Name

The name of the detail group.

Method Detail

static pfcDetailGroupInstructions Create (string inName, pfcDetailItems inElements)

Creates an instructions data object used to describe the construction of a detail group, for use in the methods pfcDetailItemOwner.CreateDetailItem() and pfcDetailGroupItem.Modify().

Parameters:

inName: The name of the group to create.
inElements: Sequence of detail items (these must be entities, groups or notes).

Returns:: The instructions data object.