API Documentation > Classes > Class CMpfcSelect
Class CMpfcSelect
Method Summary
Function
Used to create a IpfcSelection object, based on the path to a specified component.
Function
Used to create a IpfcSelection object, based on a IpfcModel
Function
Used to create a IpfcSelection object, based on a IpfcModelItem and, optionally, its IpfcComponentPath in an assembly.
Function
CreateSelectionFromString (SelectionString as String) as IpfcSelection
Creates a new selection object, given a JavaScript style selection string.
Method Detail
Function
CreateComponentSelection
Used to create a IpfcSelection object, based on the path to a specified component.
Exceptions thrown (but not limited to):
IpfcXToolkitInvalidPtr - The selection argument is an invalid pointer.
Parameters:
Path
The IpfcComponentPath of the object to selected within an assembly.
Returns:
The IpfcSelection object.
User Guide References:
Function
CreateModelSelection
(Model as IpfcModel) as IpfcSelection
Used to create a IpfcSelection object, based on a IpfcModel
Parameters:
Model
The Selected IpfcModel
Returns:
The IpfcSelection object.
User Guide References:
Function
CreateModelItemSelection
(SelItem as IpfcModelItem, Path as IpfcComponentPath [optional]) as IpfcSelection
Used to create a IpfcSelection object, based on a IpfcModelItem and, optionally, its IpfcComponentPath in an assembly.
Exceptions thrown (but not limited to):
IpfcXToolkitInvalidPtr - The selection argument is an invalid pointer.
Parameters:
SelItem
The Selected IpfcModelItem
Path
The IpfcComponentPath of the selected object within an assembly.
Returns:
The IpfcSelection object.
User Guide References:
Function
CreateSelectionFromString
(SelectionString as String) as IpfcSelection
Creates a new selection object, given a JavaScript style selection string.
See Also:
Parameters:
SelectionString
The selection string. The string should follow the following formats (items in brackets [] are optional): TopLevelObject:[SubAsm]:[SubAs:LeafComponent]/[ModelItem]
The top level object should provided as: "name.type"
Each component in the path can have one of the following formats: "name.type" "name.type(#comp_id)" "name.type(comp_name)" The component name is the name of the component feature in the context of its parent assembly.
The model item can have one of the following formats: "itemtype(#item_id) "itemtype(item_name) Itemtype must one of the following: Feature Dimension
Returns:
The created selection object.
Was this helpful?