Library | Module

Interface IpfcSelectionBuffer



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:
IpfcChild



Property Summary

PropertyContentsas IpfcSelections [readonly, optional]
Contents of the active selection buffer.



Method Summary

SubAddSelection (ToAdd as IpfcSelection)
Add an item to the selection buffer.
SubClear ()
Clear the selection buffer of all contents.
SubRemoveSelection (IndexToRemove as Long)
Removes the selection at the indicated location from the selection tool.



Property Detail


PropertyContentsas IpfcSelections [readonly, optional]

Contents of the active selection buffer.

Exceptions thrown (but not limited to):

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

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







Method Detail


SubAddSelection (ToAdd as IpfcSelection)

Add an item to the selection buffer.

Exceptions thrown (but not limited to):

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

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

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

IpfcXToolkitBadContext - 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).

IpfcXToolkitCantModify - Buffer modification is prohibited.


Parameters:
ToAdd
Selection to be added to the buffer.



SubClear ()

Clear the selection buffer of all contents.

Exceptions thrown (but not limited to):

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

IpfcXToolkitCantModify - Buffer modification is prohibited.





SubRemoveSelection (IndexToRemove as Long)

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

Exceptions thrown (but not limited to):

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

IpfcXToolkitCantModify - Buffer modification is prohibited.


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