Interface SelectionBuffer
Description
This class represents a selection buffer, where items preselected by the user are stored to be used by tools and popupmenus.
User Guide References:
Selection Buffer:SelectionBuffer, Reading the Contents of the Selection Buffer:SelectionBuffer, Removing the Items of the Selection Buffer:SelectionBuffer, Adding Items to the Selection Buffer:SelectionBuffer, Selection Level Action Listeners:SelectionBuffer
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Method Summary
void | |
Add an item to the selection buffer. | |
void | Clear () |
Clear the selection buffer of all contents. | |
/*cipOptional*/ Selections | GetContents () |
Get method for attribute "Contents" Contents of the active selection buffer. | |
void | RemoveSelection (int IndexToRemove) |
Removes the selection at the indicated location from the selection tool. |
Method Detail
GetContents | ||
/*cipOptional*/ Selections | GetContents | () |
Contents of the active selection buffer.
Exceptions thrown (but not limited to):
XToolkitCantAccess - There is no Object/Action selection tool active.
XToolkitNotFound - There are no objects in the current selection tool.
User Guide References:
AddSelection | ||
void | AddSelection |
Add an item to the selection buffer.
Exceptions thrown (but not limited to):
XToolkitCantAccess - There is no Object/Action selection tool active.
XToolkitInvalidItem - The selection does not correctly reference the current model.
XToolkitNotDisplayed - The item is not currently displayed and so cannot be added to the buffer.
XToolkitBadContext - 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).
XToolkitCantModify - Buffer modification is prohibited.
User Guide References:
Parameters:
ToAdd
Selection to be added to the buffer.
Returns:
RemoveSelection | ||
void | RemoveSelection | (int IndexToRemove) |
Removes the selection at the indicated location from the selection tool.
Exceptions thrown (but not limited to):
XToolkitCantAccess - There is no Object/Action selection tool active.
XToolkitCantModify - Buffer modification is prohibited.
User Guide References:
Parameters:
IndexToRemove
Index of the item to remove from the currently active selection tool.
Returns:
Clear | ||
void | Clear | () |
Clear the selection buffer of all contents.
Exceptions thrown (but not limited to):
XToolkitCantAccess - There is no Object/Action selection tool active.
XToolkitCantModify - Buffer modification is prohibited.
User Guide References:
Returns: