Library | Module Frames | Expand

Class MpfcSelect




Method Summary

pfcSelectionCreateComponentSelection (pfcComponentPath Path)
Used to create a pfcSelection object, based on the path to a specified component.
pfcSelectionCreateModelSelection (pfcModel Model)
Used to create a pfcSelection object, based on a pfcModel
pfcSelectionCreateModelItemSelection (pfcModelItem SelItem, /* optional */ pfcComponentPath Path)
Used to create a pfcSelection object, based on a pfcModelItem and, optionally, its pfcComponentPath in an assembly.
pfcSelectionCreateSelectionFromString (string SelectionString)
Creates a new selection object, given a Web.Link style selection string.


Method Detail

pfcSelectionCreateComponentSelection (pfcComponentPath Path)

Used to create a pfcSelection object, based on the path to a specified component.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidPtr - The selection argument is an invalid pointer.


Parameters:
Path
The pfcComponentPath of the object to selected within an assembly.
Returns:
The pfcSelection object.


pfcSelectionCreateModelSelection (pfcModel Model)

Used to create a pfcSelection object, based on a pfcModel
Parameters:
Model
The Selected pfcModel
Returns:
The pfcSelection object.


pfcSelectionCreateModelItemSelection (pfcModelItem SelItem, /* optional */ pfcComponentPath Path)

Used to create a pfcSelection object, based on a pfcModelItem and, optionally, its pfcComponentPath in an assembly.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidPtr - The selection argument is an invalid pointer.


Parameters:
SelItem
The Selected pfcModelItem
Path
The pfcComponentPath of the selected object within an assembly.
Returns:
The pfcSelection object.


pfcSelectionCreateSelectionFromString (string SelectionString)

Creates a new selection object, given a Web.Link style selection string.
See Also:
MpfcSelect.CreateModelItemSelection(), MpfcSelect.CreateComponentSelection()
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.