CIP C++ documentation for class "wfcWModelItem"

Class wfcWModelItem

# include <wfcModelItem.h> class wfcWModelItem : public virtual wfcWParameterOwner, : public virtual wfcWRelationOwner, : public virtual pfcModelItem { xaideclare(wfcWModelItem) ... };

Description

Extends the functionality of pfcModelItem

This is the actual type of Model Items in Object Toolkit.

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes, Overview of Creo Object TOOLKIT C++: Visit Methods

Direct Known Subclasses:: wfcMaterialItem, wfcViewModelitem, wfcLayerState, wfcWLayer, wfcWSolidGeometryLayerItem, wfcWAxis, wfcWSurface, wfcWCurve, wfcWCsys, wfcWEdge, wfcWQuilt, wfcAnnotation, wfcAnnotationPlane, wfcAnnotationElement, wfcWXSection, wfcWFeature, wfcCombState, wfcWSimpRep, wfcStyleState, wfcWRefDimension, wfcWUDFDimension, wfcWDimension2D, wfcWSolidBody, wfcWExplodedState, wfcWDetailEntityItem, wfcWDetailSymbolDefItem, wfcWDetailGroupItem, wfcWDetailOLEObject, wfcWNote, wfcWTable

Method Summary


`void`	`DeleteUserDefinedName ()`


`xstring`	`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.

`void`	`Hide ()`
	Identifies if the item is hidden via the "Hide" menu choice in Creo Parametric.

`xbool`	`IsHidden ()`
	Identifies if the item is hidden via the "Hide" menu choice in Creo Parametric.

`xbool`	`IsNameReadOnly ()`
	Identifies whether or not the item's name is readonly.

`xbool`	`IsZoneFeature ()`
	Check if ProModelitem is a zone feature.

`void`	`Unhide ()`
	Unhides the item, similar to the Creo Parametric menu choice "Unhide".

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class wfcWParameterOwner:: ExportParameterTable, ApplyParameterTableset

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class wfcWRelationOwner:: GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Method Detail

void DeleteUserDefinedName ()

Removes the user-defined name from the object.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - Name was not deleted.

pfcXToolkitNotImplemented - Not supported for this item type.

Manual References:: ModelItem: ModelItem Information, ModelItem: ModelItem Information

Returns:

void Unhide ()

Unhides the item, similar to the Creo Parametric menu choice "Unhide".

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - The item was already shown.

pfcXToolkitInvalidType - The item is not permitted to be shown or hidden.

Manual References:: ModelItem: ModelItem Information, ModelItem: ModelItem Information

Returns:

void Hide ()

Identifies if the item is hidden via the "Hide" menu choice in Creo Parametric.

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - The item was already hidden.

pfcXToolkitInvalidType - The item is not permitted to be hidden.

Manual References:: ModelItem: ModelItem Information, ModelItem: ModelItem Information

Returns:

xbool IsHidden ()

Identifies if the item is hidden via the "Hide" menu choice in Creo Parametric.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - The item is not permitted to be shown or hidden.

Manual References:: ModelItem: ModelItem Information, ModelItem: ModelItem Information

Returns:: xtrue if item is hidden otherwise xfalse.

xbool IsNameReadOnly ()

Identifies whether or not the item's name is readonly.

Manual References:: ModelItem: ModelItem Information, ModelItem: ModelItem Information

Returns:: xtrue if name is readonly otherwise xfalse.

xbool IsZoneFeature ()

Check if ProModelitem is a zone feature.

Manual References:: ModelItem: ModelItem Information, ModelItem: ModelItem Information

Returns:: xtrue if Modelitem is zone feature otherwise xfalse.

xstring 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):

pfcXToolkitNotFound - Default name was not found.

pfcXToolkitNotImplemented - Not supported for this item type.

Manual References:: ModelItem: ModelItem Information, ModelItem: ModelItem Information

Returns:: Model item default name.