API Documentation > Interfaces > Interface WModelItem
Interface WModelItem
Description
Extends the functionality of ModelItem
This is the actual type of Model Items in Object Toolkit.
Direct Known Subclasses:
User Guide References:
Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WParameterOwner :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WRelationOwner :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItem :
Method Summary
void
String
Gets the "default" name for the item. This is the name assigned by Creo Parametric to the item when it was created, before it may or may not have been modified by the user. For feature names where the default name would include spaces, this function will substitute underscore characters ("_") for spaces.
void
Hide ()
Identifies if the item is hidden via the "Hide" menu choice in Creo Parametric.
boolean
Identifies if the item is hidden via the "Hide" menu choice in Creo Parametric.
boolean
Identifies whether or not the item's name is readonly.
boolean
Check if ProModelitem is a zone feature.
void
Unhides the item, similar to the Creo Parametric menu choice "Unhide".
Method Detail
DeleteUserDefinedName
void
DeleteUserDefinedName
()
Exceptions thrown (but not limited to):
XToolkitNotFound - Name was not deleted.
XToolkitNotImplemented - Not supported for this item type.
User Guide References:
Returns:
Unhide
void
Unhide
()
Unhides the item, similar to the Creo Parametric menu choice "Unhide".
Exceptions thrown (but not limited to):
XToolkitNoChange - The item was already shown.
XToolkitInvalidType - The item is not permitted to be shown or hidden.
User Guide References:
Returns:
Hide
void
Hide
()
Identifies if the item is hidden via the "Hide" menu choice in Creo Parametric.
Exceptions thrown (but not limited to):
XToolkitNoChange - The item was already hidden.
XToolkitInvalidType - The item is not permitted to be hidden.
User Guide References:
Returns:
IsHidden
boolean
IsHidden
()
Identifies if the item is hidden via the "Hide" menu choice in Creo Parametric.
Exceptions thrown (but not limited to):
XToolkitInvalidType - The item is not permitted to be shown or hidden.
User Guide References:
Returns:
xtrue if item is hidden otherwise xfalse.
IsNameReadOnly
boolean
IsNameReadOnly
()
Identifies whether or not the item's name is readonly.
User Guide References:
Returns:
xtrue if name is readonly otherwise xfalse.
IsZoneFeature
boolean
IsZoneFeature
()
Check if ProModelitem is a zone feature.
User Guide References:
Returns:
xtrue if Modelitem is zone feature otherwise xfalse.
GetDefaultName
String
GetDefaultName
()
Gets the "default" name for the item. This is the name assigned by Creo Parametric to the item when it was created, before it may or may not have been modified by the user. For feature names where the default name would include spaces, this function will substitute underscore characters ("_") for spaces.
Exceptions thrown (but not limited to):
XToolkitNotFound - Default name was not found.
XToolkitNotImplemented - Not supported for this item type.
User Guide References:
Returns:
Model item default name.
Was this helpful?