CIP JavaScript documentation for class " pfcSelectionBuffer"

Class pfcSelectionBuffer

Description

This class represents a selection buffer, where items preselected by the user are stored to be used by tools and popupmenus.

Direct Parent Classes:: pfcChild

Property Summary


`/* readonly / / optional */ pfcSelections`	`Contents`
	Contents of the active selection buffer.

Method Summary


`void`	`AddSelection (pfcSelection ToAdd)`
	Add an item to the selection buffer.

`void`	`Clear ()`
	Clear the selection buffer of all contents.

`void`	`RemoveSelection (number IndexToRemove)`
	Removes the selection at the indicated location from the selection tool.

Property Detail

/* readonly */ /* optional */ pfcSelections Contents

Contents of the active selection buffer.

Exceptions thrown (but not limited to):

pfcXToolkitCantAccess - There is no Object/Action selection tool active.

pfcXToolkitNotFound - There are no objects in the current selection tool.

Method Detail

void AddSelection (pfcSelection ToAdd)

Add an item to the selection buffer.

Exceptions thrown (but not limited to):

pfcXToolkitCantAccess - There is no Object/Action selection tool active.

pfcXToolkitInvalidItem - The selection does not correctly reference the current model.

pfcXToolkitNotDisplayed - The item is not currently displayed and so cannot be added to the buffer.

pfcXToolkitBadContext - The selection cannot be added to the buffer in combination with one or more objects that are already in the buffer (e.g. geometry and features selected at the same time).

pfcXToolkitCantModify - Buffer modification is prohibited.

Parameters:

ToAdd: Selection to be added to the buffer.

void Clear ()

Clear the selection buffer of all contents.

Exceptions thrown (but not limited to):

pfcXToolkitCantAccess - There is no Object/Action selection tool active.

pfcXToolkitCantModify - Buffer modification is prohibited.

void RemoveSelection (number IndexToRemove)

Removes the selection at the indicated location from the selection tool.

Exceptions thrown (but not limited to):

pfcXToolkitCantAccess - There is no Object/Action selection tool active.

pfcXToolkitCantModify - Buffer modification is prohibited.

Parameters:

IndexToRemove: Index of the item to remove from the currently active selection tool.