CIP JAVA documentation for class "com.ptc.wfc.wfcModelItem.WModelItem"

Interface WModelItem

package com.ptc.wfc.wfcModelItem; public interface WModelItem extends com.ptc.wfc.wfcModelItem.WParameterOwner, com.ptc.wfc.wfcModelItem.WRelationOwner, com.ptc.pfc.pfcModelItem.ModelItem

Description

Extends the functionality of ModelItem

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

Direct Known Subclasses:: MaterialItem, ViewModelitem, LayerState, WLayer, WSolidGeometryLayerItem, WAxis, WSurface, WCurve, WCsys, WEdge, WQuilt, Annotation, AnnotationPlane, AnnotationElement, WXSection, WFeature, CombState, WSimpRep, StyleState, WRefDimension, WUDFDimension, WDimension2D, WSolidBody, WExplodedState, WDetailEntityItem, WDetailSymbolDefItem, WDetailGroupItem, WDetailOLEObject, WNote, WTable

Method Summary
`void`	`DeleteUserDefinedName ()`
`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.
`void`	`Hide ()` Identifies if the item is hidden via the "Hide" menu choice in Creo Parametric.
`boolean`	`IsHidden ()` Identifies if the item is hidden via the "Hide" menu choice in Creo Parametric.
`boolean`	`IsNameReadOnly ()` Identifies whether or not the item's name is readonly.
`boolean`	`IsZoneFeature ()` Check if ProModelitem is a zone feature.
`void`	`Unhide ()` Unhides the item, similar to the Creo Parametric menu choice "Unhide".

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WParameterOwner`
`ExportParameterTable`, `ApplyParameterTableset`, `MathcadParametersSet`, `MathcadInputParametersGet`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WRelationOwner`
`GetRelationConstraints`, `UnitsUsed`, `UseUnits`, `EvaluateExpressionWithUnits`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Method Detail

DeleteUserDefinedName

void DeleteUserDefinedName ()

Removes the user-defined name from the object.

Exceptions thrown (but not limited to):

XToolkitNotFound - Name was not deleted.

XToolkitNotImplemented - Not supported for this item type.

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

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.

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

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.

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

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.

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

Returns:: xtrue if item is hidden otherwise xfalse.

IsNameReadOnly

boolean 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.

IsZoneFeature

boolean 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.

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.

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

Returns:: Model item default name.