CIP JavaScript documentation for class " pfcScript"

Class pfcScript

Description

Contains old-style Web.Link methods.

Methods in this class are deprecated and are provided for backward compatibility with old-style Web.Link pages. Equivalent object-oriented methods exist elsewhere in the library.

Direct Parent Classes:: pfcObject

Method Summary


`number`	`eval (string EnumName)`
	Returns a constant integer given its string name.

`pfcPWLConstants`	`GetPWLConstants ()`
	Returns an object that contains Web.Link defined constants.

`pfcPWLFeatureConstants`	`GetPWLFeatureConstants ()`
	Returns an object that contains Web.Link defined feature constants.

`pfcAccessRequestReturn`	`pwlAccessRequest (boolean WantProERead, boolean WantProEWrite, boolean WantDiskRead, boolean WantDiskWrite)`
	This method does nothing in the embedded browser Web.Link. It is provided solely for backwards compatiblity with old applications.

`pfcStandardReturn`	`pwlApplicationStart (string AppName)`
	This method does nothing in the embedded browser Web.Link. It is provided solely for backwards compatiblity with old applications.

`pfcStandardReturn`	`pwlAssemblyComponentReplace (string AsmNameExt, string NewComponentNameExt, number NumComponentIDs, intseq ComponentIDs)`
	Replaces one assembly component for another

`pfcAssemblyComponentsGetReturn`	`pwlAssemblyComponentsGet (string AsmNameExt)`
	Retrieves all the components in the specified assembly

`pfcStandardReturn`	`pwlAssemblyExplodeDefaultSet (string AsmNameExt)`
	Sets the assembly to use the default component locations when it is exploded

`pfcStandardReturn`	`pwlAssemblyExplodeStateSet (string AsmNameExt, string ExpldstateName)`
	Sets a predefined explode state to the specified assembly

`pfcAssemblyExplodeStatesGetReturn`	`pwlAssemblyExplodeStatesGet (string AsmNameExt)`
	Gets the number and names of the explode states for the specified assembly

`pfcAssemblyExplodeStatusGetReturn`	`pwlAssemblyExplodeStatusGet (string AsmNameExt)`
	Gets the current, predefined explode state of the specified assembly

`pfcStandardReturn`	`pwlAssemblyExplodeStatusSet (string AsmNameExt, boolean ExplodeStatus)`
	Set the explode status for the specified assembly

`pfcDimensionInfoGetReturn`	`pwlDimensionInfoGetByID (string MdlNameExt, number DimensionID, number DimensionType)`
	Gets the information about a dimension, given its identifier

`pfcDimensionInfoGetReturn`	`pwlDimensionInfoGetByName (string MdlNameExt, string DimensionName, number DimensionType)`
	Gets the information about a dimension, given its name

`pfcStandardReturn`	`pwlDimensionToleranceSetByID (string MdlNameExt, number DimensionID, number TolPlus, number TolMinus)`
	Sets the tolerance of the specified dimension

`pfcStandardReturn`	`pwlDimensionValueSetByID (string MdlNameExt, number DimensionID, number Value)`
	Sets the value of a dimension, given its identifier

`pfcDirectoryCurrentGetReturn`	`pwlDirectoryCurrentGet ()`
	Gets the current directory

`pfcStandardReturn`	`pwlDirectoryCurrentSet (string DirectoryPath)`
	Sets the current directory to the one specified by the argument DirectoryPath

`pfcDirectoryFilesGetReturn`	`pwlDirectoryFilesGet (string DirectoryPath, string Filter)`
	Lists the files and subdirectories in the specified directory. You can pass a filter to get only those files that have the specified extensions.

`pfcEnvVariableGetReturn`	`pwlEnvVariableGet (string VarName)`
	Gets the value of the specified environment variable

`pfcStandardReturn`	`pwlFamtabInstanceAdd (string MdlNameExt, string Name)`
	Adds a "row" to a family table

`pfcStandardReturn`	`pwlFamtabInstanceLockAdd (string MdlNameExt, string Name)`
	Locks the specified instance

`pfcFamtabInstanceLockGetReturn`	`pwlFamtabInstanceLockGet (string MdlNameExt, string Name)`
	Gets the locked status of the specified instance

`pfcStandardReturn`	`pwlFamtabInstanceLockRemove (string MdlNameExt, string Name)`
	Unlocks the specified instance

`pfcStandardReturn`	`pwlFamtabInstanceRemove (string MdlNameExt, string Name)`
	Removes a "row" from the family table.

`pfcFamtabInstancesGetReturn`	`pwlFamtabInstancesGet (string MdlNameExt)`
	Gets the rows of a family table

`pfcFamtabInstanceValueGetReturn`	`pwlFamtabInstanceValueGet (string MdlNameExt, string Name, number FamItemType, string ItemName)`
	Retrieves the value of a cell in a family table

`pfcStandardReturn`	`pwlFamtabInstanceValueSet (string MdlNameExt, string Name, number FamItemType, string ItemName, number ValueType, number IntVal, number DoubleVal, string StringVal, boolean BooleanVal)`
	Sets the value of a cell in a family table

`pfcStandardReturn`	`pwlFamtabItemAdd (string MdlNameExt, number FamItemType, string Name)`
	Adds a column to the family table

`pfcStandardReturn`	`pwlFamtabItemRemove (string MdlNameExt, number FamItemType, string Name)`
	Removes a coulmn from the family table

`pfcFamtabItemsGetReturn`	`pwlFamtabItemsGet (string MdlNameExt)`
	Gets the columns of the family table

`pfcFeatureChildrenGetReturn`	`pwlFeatureChildrenGet (string MdlNameExt, number FeatureID)`
	Retrieves all the children of the specified feature

`pfcStandardReturn`	`pwlFeatureDeleteByID (string MdlNameExt, number FeatureID)`
	Deletes a feature, given its identifier

`pfcStandardReturn`	`pwlFeatureDeleteByIDList (string MdlNameExt, number NumFeatures, intseq FeatureIDs)`
	Suppresses features using a list of identifiers

`pfcStandardReturn`	`pwlFeatureDeleteByLayer (string MdlNameExt, string LayerName)`
	Deletes all the features in the specified layer

`pfcStandardReturn`	`pwlFeatureDeleteByName (string MdlNameExt, string FeatureName)`
	Deletes a feature, given its name

`pfcDimensionsGetReturn`	`pwlFeatureDimensionsGet (string MdlNameExt, number FeatID)`
	Retrieves the feature dimensions of the specified model

`pfcFeatureInfoGetReturn`	`pwlFeatureInfoGetByID (string MdlNameExt, number FeatureID)`
	Retrieves the information about a feature, given its identifier

`pfcFeatureInfoGetReturn`	`pwlFeatureInfoGetByName (string MdlNameExt, string FeatureName)`
	Retrieves the information about a feature, given its name

`pfcFeatureNameGetByIDReturn`	`pwlFeatureNameGetByID (string MdlNameExt, number FeatureID)`
	Retrieves the name of a feature, given its identifier

`pfcStandardReturn`	`pwlFeatureNameSetByID (string MdlNameExt, number FeatureID, string FeatureName)`
	Sets the name of a feature, given its identifier

`pfcNotesGetReturn`	`pwlFeatureNotesGet (string MdlNameExt, number FeatureID)`
	Lists the notes of the specified feature This function does not apply to drawings

`pfcStandardReturn`	`pwlFeatureParametersDisplay (string SelString, number ItemType)`
	Shows various parameter types in the graphics window, given a feature The possible values for ItemType are as follows: PWL_USER_PARAM PWL_DIM_PARAM PWL_PATTERN_PARAM PWL_REFDIM_PARAM PWL_ALL_PARAM PWL_GTOL_PARAM PWL_SURFFIN_PARAM

`pfcParametersGetReturn`	`pwlFeatureParametersGet (string MdlNameExt, number FeatureID)`
	Lists the feature parameters

`pfcFeatureParentsGetReturn`	`pwlFeatureParentsGet (string MdlNameExt, number FeatureID)`
	Retrieves all the parents of the specified feature

`pfcStandardReturn`	`pwlFeatureResumeByID (string MdlNameExt, number FeatureID, boolean ResumeParents)`
	Resumes a feature, given its identifier

`pfcStandardReturn`	`pwlFeatureResumeByIDList (string MdlNameExt, number NumFeatures, intseq FeatureIDs, boolean ResumeParents)`
	Resumes features using a list of identifiers

`pfcStandardReturn`	`pwlFeatureResumeByLayer (string MdlNameExt, string LayerName, boolean ResumeParents)`
	Resumes all the features in the specified layer

`pfcStandardReturn`	`pwlFeatureResumeByName (string MdlNameExt, string FeatureName, boolean ResumeParents)`
	Resumes a feature, given its name

`pfcFeatureStatusGetReturn`	`pwlFeatureStatusGet (string MdlNameExt, number FeatureID)`
	Gets the feature status

`pfcStandardReturn`	`pwlFeatureSuppressByID (string MdlNameExt, number FeatureID)`
	Suppresses a feature, given its identifier

`pfcStandardReturn`	`pwlFeatureSuppressByIDList (string MdlNameExt, number NumFeatures, intseq FeatureIDs)`
	Suppresses features using a list of identifiers

`pfcStandardReturn`	`pwlFeatureSuppressByLayer (string MdlNameExt, string LayerName)`
	Suppresses all the features in the specified layer

`pfcStandardReturn`	`pwlFeatureSuppressByName (string MdlNameExt, string FeatureName)`
	Suppresses a feature, given its name

`pfcStandardReturn`	`pwlGeomSimprepActivate (string MdlNameExt)`
	Activates the geometry simplified representation for the specified model

`pfcMdlOpenReturn`	`pwlGeomSimprepOpen (string AsmNameExt, string Path, boolean DisplayInWindow)`
	Retrieves the geometry representation for the specified model

`pfcStandardReturn`	`pwlGraphicsSimprepActivate (string MdlNameExt)`
	Activates the graphics simplified representation for the specified model

`pfcMdlOpenReturn`	`pwlGraphicsSimprepOpen (string AsmNameExt, string Path, boolean DisplayInWindow)`
	Retrieves the graphics representation for the specified model

`pfcStandardReturn`	`pwlInstanceErase (string MdlNameExt, string Name)`
	Removes an instance from memory

`pfcMdlOpenReturn`	`pwlInstanceOpen (string MdlNameExt, string InstanceName, boolean DisplayInWindow)`
	Opens an instance in a Creo Parametric session

`pfcStandardReturn`	`pwlItemHighlight (string SelString)`
	Highlights the specified item

`pfcItemIDToNameReturn`	`pwlItemIDToName (string MdlNameExt, number ItemID, number ItemType)`
	Retrieves the name of an item, given its identifier

`pfcStandardReturn`	`pwlItemNameSetByID (string MdlNameExt, number ItemID, number ItemType, string ItemName)`
	Sets the name of an item, given its identifier

`pfcItemNameToIDReturn`	`pwlItemNameToID (string MdlNameExt, string ItemName, number ItemType)`
	Retrieves the identifier of an item, given its name

`pfcStandardReturn`	`pwlItemUnhighlight (string SelString)`
	Removes the highlighting from the specified item

`pfcStandardReturn`	`pwlLayerCreate (string MdlNameExt, string LayerName)`
	Creates a new layer

`pfcStandardReturn`	`pwlLayerDelete (string MdlNameExt, string LayerName)`
	Deletes a layer, given its name

`pfcLayerDisplayGetReturn`	`pwlLayerDisplayGet (string MdlNameExt, string LayerName)`
	Gets the display type for the specified layer

`pfcStandardReturn`	`pwlLayerDisplaySet (string MdlNameExt, string LayerName, number DisplayType)`
	Sets the display type for the specified layer The possible values for DisplayType are as follows: PWL_DISPLAY_TYPE_NORMAL -- List the normal layers. PWL_DISPLAY_TYPE_DISPLAY -- List the layers selected for display. PWL_DISPLAY_TYPE_BLANK -- List the blanked layers. PWL_DISPLAY_TYPE_HIDDEN -- List the hidden layers. This applies to Assembly mode only.

`pfcStandardReturn`	`pwlLayerItemAdd (string MdlNameExt, string LayerName, number ItemType, number ItemID, string ItemOwner)`
	Adds an item to the specified layer The possible values for ItemType are as follows: PWL_PART PWL_FEATURE PWL_DIMENSION PWL_REF_DIMENSION PWL_GTOL PWL_ASSEMBLY PWL_QUILT PWL_CURVE PWL_POINT PWL_NOTE PWL_IPAR_NOTE PWL_SYMBOL_INSTANCE PWL_DRAFT_ENTITY PWL_DIAGRAM_OBJECT

`pfcStandardReturn`	`pwlLayerItemRemove (string MdlNameExt, string LayerName, number ItemType, number ItemID, string ItemOwner)`
	Removes the specified item from the layer The possible values for ItemType are as follows: PWL_PART PWL_FEATURE PWL_DIMENSION PWL_REF_DIMENSION PWL_GTOL PWL_ASSEMBLY PWL_QUILT PWL_CURVE PWL_POINT PWL_NOTE PWL_IPAR_NOTE PWL_SYMBOL_INSTANCE PWL_DRAFT_ENTITY PWL_DIAGRAM_OBJECT

`pfcLayerItemsGetReturn`	`pwlLayerItemsGet (string MdlNameExt, string LayerName)`
	Retrieves the items on the specified layer

`pfcMdlCurrentGetReturn`	`pwlMdlCurrentGet ()`
	Retrieves the current model in session

`pfcMdlDependenciesGetReturn`	`pwlMdlDependenciesGet (string MdlNameExt)`
	Retrieves all the top-level dependent models in the specified model

`pfcDimensionsGetReturn`	`pwlMdlDimensionsGet (string MdlNameExt, number DimType)`
	Gets the dimension identifiers of the specified model

`pfcStandardReturn`	`pwlMdlErase (string MdlNameExt)`
	Erases the specified model from memory

`pfcMdlFeaturesGetReturn`	`pwlMdlFeaturesGet (string MdlNameExt, number FeatureType)`
	Retrieves all the features in the specified model

`pfcMdlInfoGetReturn`	`pwlMdlInfoGet (string NameExt)`
	Retrieves information about the specified model

`pfcMdlIntralinkInfoGetReturn`	`pwlMdlIntralinkInfoGet (string NameExt)`
	Retrieves the Pro/INTRALINK information for the specified model.

`pfcMdlLayersGetReturn`	`pwlMdlLayersGet (string MdlNameExt)`


`pfcNotesGetReturn`	`pwlMdlNotesGet (string MdlNameExt)`
	Lists the notes in the specified model

`pfcMdlOpenReturn`	`pwlMdlOpen (string MdlNameExt, string Path, boolean DisplayInWindow)`
	Retrieves the specified model into the current Creo Parametric session

`pfcParametersGetReturn`	`pwlMdlParametersGet (string MdlNameExt)`
	Lists the model parameters

`pfcStandardReturn`	`pwlMdlRegenerate (string MdlNameExt)`
	Regenerates the specified model

`pfcStandardReturn`	`pwlMdlRename (string OrigNameExt, string NewNameExt)`
	Renames the specified model in the current Creo Parametric session

`pfcStandardReturn`	`pwlMdlSaveAs (string OrigNameExt, /* optional / string NewPath, / optional */ string NewNameExt)`
	Saves the model under the specified path and name. To save under the original path and name pass null for NewPath and NewNameExt

`pfcMdlSimprepsGetReturn`	`pwlMdlSimprepsGet (string MdlNameExt)`
	Lists the simplified representations for the specified model

`pfcMdlViewsGetReturn`	`pwlMdlViewsGet (string MdlNameExt)`
	Gets the number and names of all the views in the specified model

`pfcNoteNameGetReturn`	`pwlNoteNameGet (string MdlNameExt, number NoteID)`
	Gets the name of the note, given its identifier This function does not apply to drawings

`pfcStandardReturn`	`pwlNoteNameSet (string MdlNameExt, number NoteID, string NewName)`
	Sets the name of the specified note This function does not apply to drawings

`pfcNoteOwnerGetReturn`	`pwlNoteOwnerGet (string MdlNameExt, number NoteID)`
	Gets the owner of the specified note You cannot modify the owner of the note The function pwlNoteOwnerGet does not apply to drawings

`pfcNoteTextGetReturn`	`pwlNoteTextGet (string MdlNameExt, number NoteID)`
	Gets the text of the specified note. Symbols are replaced by a "*"

`pfcStandardReturn`	`pwlNoteTextSet (string MdlNameExt, number NoteID, number NumTextLines, stringseq NoteText)`
	Sets the text of the specified note

`pfcNoteURLGetReturn`	`pwlNoteURLGet (string MdlNameExt, number NoteID)`
	Gets the Uniform Resource Locator (URL) of the specified note This function does not apply to drawings

`pfcStandardReturn`	`pwlNoteURLSet (string MdlNameExt, number NoteID, string NoteURL)`
	Sets the Uniform Resource Locator (URL) of the specified note This function does not apply to drawings

`pfcStandardReturn`	`pwlObjMdlsCheckOut (boolean LinkOrCopy, string WorkspaceName, number NumObj, stringseq ObjNames, intseq ObjVersions, number RelCriteria)`
	Checks out Pro/INTRALINK objects from the Commonspace to a Workspace.

`pfcStandardReturn`	`pwlParameterCreate (string MdlNameExt, number ItemType, number ItemID, string ParamName, number ValueType, number IntVal, number DoubleVal, string StringVal, boolean BooleanVal)`
	Creates a new parameter

`pfcStandardReturn`	`pwlParameterDelete (string MdlNameExt, number ItemType, number ItemId, string ParamName)`
	Deletes the specified parameter

`pfcStandardReturn`	`pwlParameterDesignationAdd (string MdlNameExt, string ParamName)`
	Designates the specified parameter for Windchill

`pfcStandardReturn`	`pwlParameterDesignationRemove (string MdlNameExt, string ParamName)`
	Removes the designation from the specified parameter

`pfcParameterDesignationVerifyReturn`	`pwlParameterDesignationVerify (string MdlNameExt, string ParamName)`
	Determines whether the specified parameter has been designated for Windchill

`pfcStandardReturn`	`pwlParameterRename (string MdlNameExt, number ItemType, number ItemId, string ParamName, string NewName)`
	Renames the specified parameter

`pfcStandardReturn`	`pwlParameterReset (string MdlNameExt, number ItemType, number ItemId, string ParamName)`
	Resets the specified parameter value to its last regenerated value

`pfcParameterValueGetReturn`	`pwlParameterValueGet (string MdlNameExt, number ItemType, number ItemID, string ParamName)`
	Retrieves the value of the specified parameter

`pfcStandardReturn`	`pwlParameterValueSet (string MdlNameExt, number ItemType, number ItemID, string ParamName, number ValueType, number IntVal, number DoubleVal, string StringVal, boolean BooleanVal)`
	Sets the value of the specified parameter

`pfcPartMaterialCurrentGetReturn`	`pwlPartMaterialCurrentGet (string MdlNameExt)`
	Gets the current material name of the specified part

`pfcStandardReturn`	`pwlPartMaterialCurrentSet (string MdlNameExt, string MaterialName)`
	Sets the current material name for the specified part. The material must already be associated with the part.

`pfcPartMaterialdataGetReturn`	`pwlPartMaterialDataGet (string MdlNameExt, string MaterialName)`
	Get the properties of the specified material

`pfcStandardReturn`	`pwlPartMaterialDataSet (string MdlNameExt, string MaterialName, number YoungModulus, number PoissonRatio, number ShearModulus, number MassDensity, number ThermExpCoef, number ThermExpRefTemp, number StructDampCoef, number StressLimTension, number StressLimCompress, number StressLimShear, number ThermConductivity, number Emissivity, number SpecificHeat, number Hardness, string Condition, number InitBendYFactor, string BendTable)`
	Sets the properties of the specified material

`pfcPartMaterialCurrentGetReturn`	`pwlPartMaterialGet (string MdlNameExt)`
	Gets the material name of the specified part. This function is identical to `pfcScript.pwlPartMaterialCurrentGet()` and is maintained for backwards compatibility.

`pfcStandardReturn`	`pwlPartMaterialSet (string MdlNameExt, string MaterialName)`
	Sets the material name for the specified part from a material file

`pfcPartMaterialsGetReturn`	`pwlPartMaterialsGet (string MdlNameExt)`
	Gets all the material names for the specified part

`pfcStandardReturn`	`pwlProEngineerConnect ()`
	This method does nothing in the embedded browser Web.Link. It is provided solely for backwards compatiblity with old applications.

`pfcStandardReturn`	`pwlProEngineerDisconnect ()`
	This method does nothing in the embedded browser Web.Link. It is provided solely for backwards compatiblity with old applications.

`pfcStandardReturn`	`pwlProEngineerDisconnectAndStop ()`
	This method does nothing in the embedded browser Web.Link. It is provided solely for backwards compatiblity with old applications.

`pfcStandardReturn`	`pwlProEngineerStartAndConnect ()`
	This method does nothing in the embedded browser Web.Link. It is provided solely for backwards compatiblity with old applications.

`pfcSelectReturn`	`pwlSelect (string SelectableFilter, number MaxSelectable)`
	Selects an item in Creo Parametric. The form for SelectableFilter is a comma-separated list of any or all of the following: dimension feature part prt_or_asm

`pfcSelectionCreateReturn`	`pwlSelectionCreate (string TopModel, number NumComponents, stringseq ComponentPath, intseq ComponentIDs, number ItemType, number ItemID)`


`pfcSelectionParseReturn`	`pwlSelectionParse (string SelString)`
	Parses the components from the specified selection string

`pfcSessionMdlsGetReturn`	`pwlSessionMdlsGet (number MdlType)`
	Lists the models of the specified type in the current Creo Parametric session. The possible values for MdlType are as follows: PWL_ASSEMBLY PWL_PART PWL_DRAWING PWL_2DSECTION PWL_LAYOUT PWL_DWGFORM PWL_MFG PWL_REPORT PWL_MARKUP PWL_DIAGRAM

`pfcSessionWindowsGetReturn`	`pwlSessionWindowsGet ()`
	Lists the identifiers of the windows currently in the Creo Parametric session

`pfcStandardReturn`	`pwlSimprepActivate (string MdlNameExt, string SimprepName)`
	Activates a simplified representation for the specified model

`pfcSimprepGetReturn`	`pwlSimprepCurrentGet (string AsmNameExt)`
	Returns the current active simplified representation for the specified assembly

`pfcStandardReturn`	`pwlSimprepMasterActivate (string MdlNameExt)`
	Activates the master simplified representation for the specified model

`pfcMdlOpenReturn`	`pwlSimprepOpen (string AsmNameExt, string Path, string RepName, boolean DisplayInWindow)`
	Retrieves the specified simplified representation

`pfcSolidMassPropertiesGetReturn`	`pwlSolidMassPropertiesGet (string MdlNameExt, string CoordinateSys)`
	Gets the mass properties for the specified solid

`pfcStandardReturn`	`pwlSolidXSectionDisplay (string MdlNameExt, string CrossSectionName)`
	Displays the specified cross section

`pfcSolidXSectionsGetReturn`	`pwlSolidXSectionsGet (string MdlNameExt)`
	Retrieves the cross sections from the specified model

`number`	`pwlTypeFromModelItemType (pfcModelItemType Type)`
	Converts a `pfcModelItemType` to the corresponding `PWL` constant

`number`	`pwlTypeFromModelType (pfcModelType Type)`
	Converts a `pfcModelType` to the corresponding `PWL` constant

`pfcModelItemType`	`pwlTypeToModelItemType (number Type)`
	Converts a `PWL` constant to the corresponding `pfcModelItemType`

`pfcModelType`	`pwlTypeToModelType (number Type)`
	Converts a `PWL` constant to the corresponding `pfcModelType`

`booleanseq`	`pwluBooleanArrayAlloc (number ArraySize)`
	Allocates an array of boolean values

`realseq`	`pwluDoubleArrayAlloc (number ArraySize)`
	Allocates an array of doubles

`intseq`	`pwluIntArrayAlloc (number ArraySize)`
	Allocates an array of integers

`stringseq`	`pwluStringArrayAlloc (number ArraySize)`
	Allocates an array of strings

`pfcStandardReturn`	`pwlViewDefaultSet (string MdlNameExt)`
	Sets the specified model to the default view for that model

`pfcStandardReturn`	`pwlViewSet (string MdlNameExt, string NamedView)`
	Sets the view to a predefined view setting

`pfcStandardReturn`	`pwlWindowActivate (number WindowID)`
	Activates the specified window

`pfcWindowActiveGetReturn`	`pwlWindowActiveGet ()`
	Gets the active window in the Creo Parametric session

`pfcStandardReturn`	`pwlWindowClose (number WindowID)`
	Closes the specified window. Specify the value -1 to close the current window.

`pfcWindowMdlGetReturn`	`pwlWindowMdlGet (number WindowID)`
	Retrieves the model associated with the specified window

`pfcStandardReturn`	`pwlWindowRepaint (number WindowID)`
	Repaints the contents of the specified window. Specify the value -1 to repaint the current window

Method Detail

number eval (string EnumName)

Returns a constant integer given its string name.

Parameters:

EnumName: The name of the constant, e.g. "PWL_FEAT_FIRST_FEAT"

Returns:: The integer constant.

pfcPWLConstants GetPWLConstants ()

Returns an object that contains Web.Link defined constants.

See Also:: pfcScript.GetPWLConstants()

Returns:: The object that contains the constant integers used by other methods.

pfcPWLFeatureConstants GetPWLFeatureConstants ()

Returns an object that contains Web.Link defined feature constants.

See Also:: pfcScript.GetPWLConstants()

Returns:: The object that contains the feature-related constant integers used by other methods.

pfcAccessRequestReturn pwlAccessRequest (boolean WantProERead, boolean WantProEWrite, boolean WantDiskRead, boolean WantDiskWrite)

This method does nothing in the embedded browser Web.Link. It is provided solely for backwards compatiblity with old applications.

Parameters:

WantProERead
WantProEWrite
WantDiskRead
WantDiskWrite

Returns:

pfcStandardReturn pwlApplicationStart (string AppName)

This method does nothing in the embedded browser Web.Link. It is provided solely for backwards compatiblity with old applications.

Parameters:

AppName

Returns:

pfcStandardReturn pwlAssemblyComponentReplace (string AsmNameExt, string NewComponentNameExt, number NumComponentIDs, intseq ComponentIDs)

Replaces one assembly component for another

Parameters:

AsmNameExt: The name and extension of the assembly
NewComponentNameExt: The name and extension of the new component
NumComponentIDs: The number of components to be replaced
ComponentIDs: The feature identifiers of the replaced components

Returns:

pfcAssemblyComponentsGetReturn pwlAssemblyComponentsGet (string AsmNameExt)

Retrieves all the components in the specified assembly

Parameters:

AsmNameExt: The name and extension of the assembly

Returns:

pfcStandardReturn pwlAssemblyExplodeDefaultSet (string AsmNameExt)

Sets the assembly to use the default component locations when it is exploded

Parameters:

AsmNameExt: The name and extension of the assembly

Returns:

pfcStandardReturn pwlAssemblyExplodeStateSet (string AsmNameExt, string ExpldstateName)

Sets a predefined explode state to the specified assembly

Parameters:

AsmNameExt: The name and extension of the assembly
ExpldstateName: The name of a predefined explode state

Returns:

pfcAssemblyExplodeStatesGetReturn pwlAssemblyExplodeStatesGet (string AsmNameExt)

Gets the number and names of the explode states for the specified assembly

Parameters:

AsmNameExt: The name and extension of the assembly

Returns:

pfcAssemblyExplodeStatusGetReturn pwlAssemblyExplodeStatusGet (string AsmNameExt)

Gets the current, predefined explode state of the specified assembly

Parameters:

AsmNameExt: The name and extension of the assembly

Returns:

pfcStandardReturn pwlAssemblyExplodeStatusSet (string AsmNameExt, boolean ExplodeStatus)

Set the explode status for the specified assembly

Parameters:

AsmNameExt: The name and extension of the assembly
ExplodeStatus: The new explode status

Returns:

pfcDimensionInfoGetReturn pwlDimensionInfoGetByID (string MdlNameExt, number DimensionID, number DimensionType)

Gets the information about a dimension, given its identifier

Parameters:

MdlNameExt: The name and extension of the model
DimensionID: The integer identifier of the dimension
DimensionType: The dimension type (PWL_DIMENSION or PWL_REF_DIMENSION)

Returns:

pfcDimensionInfoGetReturn pwlDimensionInfoGetByName (string MdlNameExt, string DimensionName, number DimensionType)

Gets the information about a dimension, given its name

Parameters:

MdlNameExt: The name and extension of the model
DimensionName: The name of the dimension
DimensionType: The dimension type (PWL_DIMENSION or PWL_REF_DIMENSION)

Returns:

pfcStandardReturn pwlDimensionToleranceSetByID (string MdlNameExt, number DimensionID, number TolPlus, number TolMinus)

Sets the tolerance of the specified dimension

Parameters:

MdlNameExt: The name and extension of the model
DimensionID: The integer identifier of the dimension
TolPlus: The positive element of the tolerance
TolMinus: The negative element of the tolerance

Returns:

pfcStandardReturn pwlDimensionValueSetByID (string MdlNameExt, number DimensionID, number Value)

Sets the value of a dimension, given its identifier

Parameters:

MdlNameExt: The name and extension of the model
DimensionID: The integer identifier of the dimension
Value: The new value of the dimension

Returns:

pfcDirectoryCurrentGetReturn pwlDirectoryCurrentGet ()

Gets the current directory

Returns:

pfcStandardReturn pwlDirectoryCurrentSet (string DirectoryPath)

Sets the current directory to the one specified by the argument DirectoryPath

Parameters:

DirectoryPath: The path to the current directory

Returns:

pfcDirectoryFilesGetReturn pwlDirectoryFilesGet (string DirectoryPath, string Filter)

Lists the files and subdirectories in the specified directory. You can pass a filter to get only those files that have the specified extensions.

Parameters:

DirectoryPath: The directory that contains the files to be listed. If this is null , the function lists the files in the current Creo Parametric directory.
Filter: The filter string for file extensions. Each filter must be separated by a comma. For example, "*.prt, *.txt".

Returns:

pfcEnvVariableGetReturn pwlEnvVariableGet (string VarName)

Gets the value of the specified environment variable

Manual References:: The Basics of Web.Link: Environment Variables

Parameters:

VarName: The name of the environment variable

Returns:

pfcStandardReturn pwlFamtabInstanceAdd (string MdlNameExt, string Name)

Adds a "row" to a family table

Parameters:

MdlNameExt: The name and extension of the model
Name: The name of the instance

Returns:

pfcStandardReturn pwlFamtabInstanceLockAdd (string MdlNameExt, string Name)

Locks the specified instance

Parameters:

MdlNameExt: The name and extension of the model
Name: The name of the instance

Returns:

pfcFamtabInstanceLockGetReturn pwlFamtabInstanceLockGet (string MdlNameExt, string Name)

Gets the locked status of the specified instance

Parameters:

MdlNameExt: The name and extension of the model
Name: The name of the instance

Returns:

pfcStandardReturn pwlFamtabInstanceLockRemove (string MdlNameExt, string Name)

Unlocks the specified instance

Parameters:

MdlNameExt: The name and extension of the model
Name: The name of the instance

Returns:

pfcStandardReturn pwlFamtabInstanceRemove (string MdlNameExt, string Name)

Removes a "row" from the family table.

Parameters:

MdlNameExt: The name and extension of the model
Name: The name of the instance

Returns:

pfcFamtabInstancesGetReturn pwlFamtabInstancesGet (string MdlNameExt)

Gets the rows of a family table

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcFamtabInstanceValueGetReturn pwlFamtabInstanceValueGet (string MdlNameExt, string Name, number FamItemType, string ItemName)

Retrieves the value of a cell in a family table

Parameters:

MdlNameExt: The name and extension of the model
Name: The name of the instance
FamItemType: The type of the family table item
ItemName: The name of the item

Returns:

pfcStandardReturn pwlFamtabInstanceValueSet (string MdlNameExt, string Name, number FamItemType, string ItemName, number ValueType, number IntVal, number DoubleVal, string StringVal, boolean BooleanVal)

Sets the value of a cell in a family table

Parameters:

MdlNameExt: The name and extension of the model
Name: The name of the instance
FamItemType: The type of the family table item
ItemName: The name of the item
ValueType: The value type of the argument
IntVal: The integer value
DoubleVal: The double value
StringVal: The string value
BooleanVal: The boolean value

Returns:

pfcStandardReturn pwlFamtabItemAdd (string MdlNameExt, number FamItemType, string Name)

Adds a column to the family table

Parameters:

MdlNameExt: The name and extension of the model
FamItemType: The type of the family table item
Name: The name of the column to add

Returns:

pfcStandardReturn pwlFamtabItemRemove (string MdlNameExt, number FamItemType, string Name)

Removes a coulmn from the family table

Parameters:

MdlNameExt: The name and extension of the model
FamItemType: The type of the family table item
Name: The name of the column

Returns:

pfcFamtabItemsGetReturn pwlFamtabItemsGet (string MdlNameExt)

Gets the columns of the family table

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcFeatureChildrenGetReturn pwlFeatureChildrenGet (string MdlNameExt, number FeatureID)

Retrieves all the children of the specified feature

Parameters:

MdlNameExt: The name and extension of the model
FeatureID: The identifier of the parent feature

Returns:

pfcStandardReturn pwlFeatureDeleteByID (string MdlNameExt, number FeatureID)

Deletes a feature, given its identifier

Parameters:

MdlNameExt: The name and extension of the model
FeatureID: The identifier of the feature to delete

Returns:

pfcStandardReturn pwlFeatureDeleteByIDList (string MdlNameExt, number NumFeatures, intseq FeatureIDs)

Suppresses features using a list of identifiers

Parameters:

MdlNameExt: The name and extension of the model
NumFeatures: The number of identifiers in the list
FeatureIDs: The list of identifiers of features to suppress

Returns:

pfcStandardReturn pwlFeatureDeleteByLayer (string MdlNameExt, string LayerName)

Deletes all the features in the specified layer

Parameters:

MdlNameExt: The name and extension of the model
LayerName: The name of the layer to delete

Returns:

pfcStandardReturn pwlFeatureDeleteByName (string MdlNameExt, string FeatureName)

Deletes a feature, given its name

Parameters:

MdlNameExt: The name and extension of the model
FeatureName: The name of the feature

Returns:

pfcDimensionsGetReturn pwlFeatureDimensionsGet (string MdlNameExt, number FeatID)

Retrieves the feature dimensions of the specified model

Parameters:

MdlNameExt: The name and extension of the model
FeatID: The feature to which the dimensions belong

Returns:

pfcFeatureInfoGetReturn pwlFeatureInfoGetByID (string MdlNameExt, number FeatureID)

Retrieves the information about a feature, given its identifier

Exceptions thrown (but not limited to):

<reference 4 to unknown entity pfcExceptions::pfcXInAMethod>

Parameters:

MdlNameExt: The name and extension of the model
FeatureID: The feature identifier

Returns:

pfcFeatureInfoGetReturn pwlFeatureInfoGetByName (string MdlNameExt, string FeatureName)

Retrieves the information about a feature, given its name

Parameters:

MdlNameExt: The name and extension of the model
FeatureName: The name of the feature

Returns:

pfcFeatureNameGetByIDReturn pwlFeatureNameGetByID (string MdlNameExt, number FeatureID)

Retrieves the name of a feature, given its identifier

Parameters:

MdlNameExt: The name and extension of the model
FeatureID: The feature identifier

Returns:

pfcStandardReturn pwlFeatureNameSetByID (string MdlNameExt, number FeatureID, string FeatureName)

Sets the name of a feature, given its identifier

Parameters:

MdlNameExt: The name and extension of the model
FeatureID: The feature identifier
FeatureName: The new feature name

Returns:

pfcNotesGetReturn pwlFeatureNotesGet (string MdlNameExt, number FeatureID)

Lists the notes of the specified feature This function does not apply to drawings

Parameters:

MdlNameExt: The name and extension of the model
FeatureID: The feature whose notes are required

Returns:

pfcStandardReturn pwlFeatureParametersDisplay (string SelString, number ItemType)

Shows various parameter types in the graphics window, given a feature

The possible values for ItemType are as follows:

PWL_USER_PARAM
PWL_DIM_PARAM
PWL_PATTERN_PARAM
PWL_REFDIM_PARAM
PWL_ALL_PARAM
PWL_GTOL_PARAM
PWL_SURFFIN_PARAM

Parameters:

SelString: The selection string that identifies the feature
ItemType: The type of parameter to display

Returns:

pfcParametersGetReturn pwlFeatureParametersGet (string MdlNameExt, number FeatureID)

Lists the feature parameters

Parameters:

MdlNameExt: The name and extension of the model
FeatureID: The feature for which parameters should be found

Returns:

pfcFeatureParentsGetReturn pwlFeatureParentsGet (string MdlNameExt, number FeatureID)

Retrieves all the parents of the specified feature

Parameters:

MdlNameExt: The name and extension of the model
FeatureID: The identifier of the child feature

Returns:

pfcStandardReturn pwlFeatureResumeByID (string MdlNameExt, number FeatureID, boolean ResumeParents)

Resumes a feature, given its identifier

Parameters:

MdlNameExt: The name and extension of the model
FeatureID: The identifier of the feature to resume
ResumeParents: Specifies whether to resume the parents of the feature

Returns:

pfcStandardReturn pwlFeatureResumeByIDList (string MdlNameExt, number NumFeatures, intseq FeatureIDs, boolean ResumeParents)

Resumes features using a list of identifiers

Parameters:

MdlNameExt: The name and extension of the model
NumFeatures: The number of feature identifiers in the list
FeatureIDs: The list of identifiers of the features to be resumed
ResumeParents: Specifies whether to resume the parents of the features

Returns:

pfcStandardReturn pwlFeatureResumeByLayer (string MdlNameExt, string LayerName, boolean ResumeParents)

Resumes all the features in the specified layer

Parameters:

MdlNameExt: The name and extension of the model
LayerName: The name of the layer to resume
ResumeParents: Specifies whether to resume the parents of the feature

Returns:

pfcStandardReturn pwlFeatureResumeByName (string MdlNameExt, string FeatureName, boolean ResumeParents)

Resumes a feature, given its name

Parameters:

MdlNameExt: The name and extension of the model
FeatureName: The name of the feature to resume
ResumeParents: Specifies whether to resume the parents of the feature

Returns:

pfcFeatureStatusGetReturn pwlFeatureStatusGet (string MdlNameExt, number FeatureID)

Gets the feature status

Parameters:

MdlNameExt: The name and extension of the model
FeatureID: The feature identifier

Returns:

pfcStandardReturn pwlFeatureSuppressByID (string MdlNameExt, number FeatureID)

Suppresses a feature, given its identifier

Parameters:

MdlNameExt: The name and extension of the model
FeatureID: The feature identifier

Returns:

pfcStandardReturn pwlFeatureSuppressByIDList (string MdlNameExt, number NumFeatures, intseq FeatureIDs)

Suppresses features using a list of identifiers

Parameters:

MdlNameExt: The name and extension of the model
NumFeatures: The number of feature identifiers in the list
FeatureIDs: The list of identifiers of features to suppress

Returns:

pfcStandardReturn pwlFeatureSuppressByLayer (string MdlNameExt, string LayerName)

Suppresses all the features in the specified layer

Parameters:

MdlNameExt: The name and extension of the model
LayerName: The name of the layer to suppress

Returns:

pfcStandardReturn pwlFeatureSuppressByName (string MdlNameExt, string FeatureName)

Suppresses a feature, given its name

Parameters:

MdlNameExt: The name and extension of the model
FeatureName: The name of the feature

Returns:

pfcStandardReturn pwlGeomSimprepActivate (string MdlNameExt)

Activates the geometry simplified representation for the specified model

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcMdlOpenReturn pwlGeomSimprepOpen (string AsmNameExt, string Path, boolean DisplayInWindow)

Retrieves the geometry representation for the specified model

Parameters:

AsmNameExt: The full name of the assembly or part
Path: The full path to the model
DisplayInWindow: Specifies whether to display the model in a Creo Parametric window

Returns:

pfcStandardReturn pwlGraphicsSimprepActivate (string MdlNameExt)

Activates the graphics simplified representation for the specified model

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcMdlOpenReturn pwlGraphicsSimprepOpen (string AsmNameExt, string Path, boolean DisplayInWindow)

Retrieves the graphics representation for the specified model

Parameters:

AsmNameExt: The full name of the assembly or part
Path: The full path to the model
DisplayInWindow: Specifies whether to display the model in a Creo Parametric window

Returns:

pfcStandardReturn pwlInstanceErase (string MdlNameExt, string Name)

Removes an instance from memory

Parameters:

MdlNameExt: The name and extension of the model
Name: The name of the instance

Returns:

pfcMdlOpenReturn pwlInstanceOpen (string MdlNameExt, string InstanceName, boolean DisplayInWindow)

Opens an instance in a Creo Parametric session

Parameters:

MdlNameExt: The name and extension of the model
InstanceName: The name of the instance to open
DisplayInWindow: If true the instance is displayed in a Creo Parametric window

Returns:

pfcStandardReturn pwlItemHighlight (string SelString)

Highlights the specified item

Parameters:

SelString: The selection string that identifies the item

Returns:

pfcItemIDToNameReturn pwlItemIDToName (string MdlNameExt, number ItemID, number ItemType)

Retrieves the name of an item, given its identifier

Parameters:

MdlNameExt: The name and extension of the model
ItemID: The item identifier
ItemType: The item type

Returns:

pfcStandardReturn pwlItemNameSetByID (string MdlNameExt, number ItemID, number ItemType, string ItemName)

Sets the name of an item, given its identifier

Parameters:

MdlNameExt: The name and extension of the model
ItemID: The identifier of the model item
ItemType: The type of the model item
ItemName: The new name for the model item

Returns:

pfcItemNameToIDReturn pwlItemNameToID (string MdlNameExt, string ItemName, number ItemType)

Retrieves the identifier of an item, given its name

Parameters:

MdlNameExt: The name and extension of the model
ItemName: The name of the model item
ItemType: The type of the model item

Returns:

pfcStandardReturn pwlItemUnhighlight (string SelString)

Removes the highlighting from the specified item

Parameters:

SelString: The selection string that identifies the item

Returns:

pfcStandardReturn pwlLayerCreate (string MdlNameExt, string LayerName)

Creates a new layer

Parameters:

MdlNameExt: The name and extension of the model
LayerName: The name of the layer to create

Returns:

pfcStandardReturn pwlLayerDelete (string MdlNameExt, string LayerName)

Deletes a layer, given its name

Parameters:

MdlNameExt: The name and extension of the model
LayerName: The name of the layer to delete

Returns:

pfcLayerDisplayGetReturn pwlLayerDisplayGet (string MdlNameExt, string LayerName)

Gets the display type for the specified layer

Parameters:

MdlNameExt: The name and extension of the model
LayerName: The name of the layer to display

Returns:

pfcStandardReturn pwlLayerDisplaySet (string MdlNameExt, string LayerName, number DisplayType)

Sets the display type for the specified layer

The possible values for DisplayType are as follows:

PWL_DISPLAY_TYPE_NORMAL -- List the normal layers.
PWL_DISPLAY_TYPE_DISPLAY -- List the layers selected for display.
PWL_DISPLAY_TYPE_BLANK -- List the blanked layers.
PWL_DISPLAY_TYPE_HIDDEN -- List the hidden layers. This applies to Assembly mode only.

Parameters:

MdlNameExt: The name and extension of the model
LayerName: The name of the layer
DisplayType: The new display type

Returns:

pfcStandardReturn pwlLayerItemAdd (string MdlNameExt, string LayerName, number ItemType, number ItemID, string ItemOwner)

Adds an item to the specified layer

The possible values for ItemType are as follows:

PWL_PART
PWL_FEATURE
PWL_DIMENSION
PWL_REF_DIMENSION
PWL_GTOL
PWL_ASSEMBLY
PWL_QUILT
PWL_CURVE
PWL_POINT
PWL_NOTE
PWL_IPAR_NOTE
PWL_SYMBOL_INSTANCE
PWL_DRAFT_ENTITY
PWL_DIAGRAM_OBJECT

Parameters:

MdlNameExt: The name and extension of the model
LayerName: The name of the layer
ItemType: The type of layer item
ItemID: The identifier of the item
ItemOwner: If null or "", the item owner is the same as the layer owner. Otherwise, it is a selection string to the component that owns the item

Returns:

pfcStandardReturn pwlLayerItemRemove (string MdlNameExt, string LayerName, number ItemType, number ItemID, string ItemOwner)

Removes the specified item from the layer

The possible values for ItemType are as follows:

PWL_PART
PWL_FEATURE
PWL_DIMENSION
PWL_REF_DIMENSION
PWL_GTOL
PWL_ASSEMBLY
PWL_QUILT
PWL_CURVE
PWL_POINT
PWL_NOTE
PWL_IPAR_NOTE
PWL_SYMBOL_INSTANCE
PWL_DRAFT_ENTITY
PWL_DIAGRAM_OBJECT

Parameters:

MdlNameExt: The name and extension of the model
LayerName: The name of the layer to remove
ItemType: The type of layer item
ItemID: The identifier of the item
ItemOwner: If null or "", the item owner is the same as the layer owner. Otherwise, it is a selection string to the component that owns the item

Returns:

pfcLayerItemsGetReturn pwlLayerItemsGet (string MdlNameExt, string LayerName)

Retrieves the items on the specified layer

Parameters:

MdlNameExt: The name and extension of the model
LayerName: The name of the specified layer

Returns:

pfcMdlCurrentGetReturn pwlMdlCurrentGet ()

Retrieves the current model in session

Returns:

pfcMdlDependenciesGetReturn pwlMdlDependenciesGet (string MdlNameExt)

Retrieves all the top-level dependent models in the specified model

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcDimensionsGetReturn pwlMdlDimensionsGet (string MdlNameExt, number DimType)

Gets the dimension identifiers of the specified model

Parameters:

MdlNameExt: The name and extension of the model
DimType: The type of model dimensions (PWL_DIMENSION or PWL_REF_DIMENSION)

Returns:

pfcStandardReturn pwlMdlErase (string MdlNameExt)

Erases the specified model from memory

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcMdlFeaturesGetReturn pwlMdlFeaturesGet (string MdlNameExt, number FeatureType)

Retrieves all the features in the specified model

Parameters:

MdlNameExt: The name and extension of the model
FeatureType: The type of feature to retrieve

Returns:

pfcMdlInfoGetReturn pwlMdlInfoGet (string NameExt)

Retrieves information about the specified model

Exceptions thrown (but not limited to):

<reference 4 to unknown entity pfcExceptions::pfcXInAMethod>

Parameters:

NameExt: The name and extension of the model

Returns:

pfcMdlIntralinkInfoGetReturn pwlMdlIntralinkInfoGet (string NameExt)

Retrieves the Pro/INTRALINK information for the specified model.

NOTE: This method is deprecated. Pro/INTRALINK 3.4 is not supported.

Markups and sections are not supported.

Parameters:

NameExt: The name and extension of the model

Returns:

pfcMdlLayersGetReturn pwlMdlLayersGet (string MdlNameExt)

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcNotesGetReturn pwlMdlNotesGet (string MdlNameExt)

Lists the notes in the specified model

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcMdlOpenReturn pwlMdlOpen (string MdlNameExt, string Path, boolean DisplayInWindow)

Retrieves the specified model into the current Creo Parametric session

Parameters:

MdlNameExt: The name and extension of the model
Path: The full directory path to the model
DisplayInWindow: If true the model is displayed in the Creo Parametric model

Returns:

pfcParametersGetReturn pwlMdlParametersGet (string MdlNameExt)

Lists the model parameters

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcStandardReturn pwlMdlRegenerate (string MdlNameExt)

Regenerates the specified model

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcStandardReturn pwlMdlRename (string OrigNameExt, string NewNameExt)

Renames the specified model in the current Creo Parametric session

Parameters:

OrigNameExt: The name and extension of the model
NewNameExt: The new name and extension of the model

Returns:

pfcStandardReturn pwlMdlSaveAs (string OrigNameExt, /* optional */ string NewPath, /* optional */ string NewNameExt)

Saves the model under the specified path and name. To save under the original path and name pass null for NewPath and NewNameExt

Parameters:

OrigNameExt: The original name and extension of the model
NewPath: The new path to the model
NewNameExt: The new name and extension of the model

Returns:

pfcMdlSimprepsGetReturn pwlMdlSimprepsGet (string MdlNameExt)

Lists the simplified representations for the specified model

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcMdlViewsGetReturn pwlMdlViewsGet (string MdlNameExt)

Gets the number and names of all the views in the specified model

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcNoteNameGetReturn pwlNoteNameGet (string MdlNameExt, number NoteID)

Gets the name of the note, given its identifier This function does not apply to drawings

Parameters:

MdlNameExt: The name and extension of the model
NoteID: The note identifier

Returns:

pfcStandardReturn pwlNoteNameSet (string MdlNameExt, number NoteID, string NewName)

Sets the name of the specified note This function does not apply to drawings

Parameters:

MdlNameExt: The name and extension of the model
NoteID: The note identifier
NewName: The name of the note

Returns:

pfcNoteOwnerGetReturn pwlNoteOwnerGet (string MdlNameExt, number NoteID)

Gets the owner of the specified note

You cannot modify the owner of the note
The function pwlNoteOwnerGet does not apply to drawings

Parameters:

MdlNameExt: The name and extension of the model
NoteID: The note identifier

Returns:

pfcNoteTextGetReturn pwlNoteTextGet (string MdlNameExt, number NoteID)

Gets the text of the specified note. Symbols are replaced by a "*"

Returns the note parameter callouts as values. To get the parameter callouts as names, use pfcNote.GetText().

Parameters:

MdlNameExt: The name and extension of the model
NoteID: The note identifier

Returns:

pfcStandardReturn pwlNoteTextSet (string MdlNameExt, number NoteID, number NumTextLines, stringseq NoteText)

Sets the text of the specified note

Parameters:

MdlNameExt: The name and extension of the model
NoteID: The note identifier
NumTextLines: The number of text lines
NoteText: The text of the note

Returns:

pfcNoteURLGetReturn pwlNoteURLGet (string MdlNameExt, number NoteID)

Gets the Uniform Resource Locator (URL) of the specified note This function does not apply to drawings

Parameters:

MdlNameExt: The name and extension of the model
NoteID: The note identifier

Returns:

pfcStandardReturn pwlNoteURLSet (string MdlNameExt, number NoteID, string NoteURL)

Sets the Uniform Resource Locator (URL) of the specified note This function does not apply to drawings

Parameters:

MdlNameExt: The name and extension of the model
NoteID: The note identifier
NoteURL: The URL of the note to set

Returns:

pfcStandardReturn pwlObjMdlsCheckOut (boolean LinkOrCopy, string WorkspaceName, number NumObj, stringseq ObjNames, intseq ObjVersions, number RelCriteria)

Checks out Pro/INTRALINK objects from the Commonspace to a Workspace.

NOTE: This method is deprecated. Pro/INTRALINK 3.4 is not supported.

The RelCriteria argument identifies which dependents should be checked out along with the ObjNames[]. The possible values are as follows:

1 -- Include all the dependents
2 -- Include the required dependents only
3 -- Do not include any dependents

Parameters:

LinkOrCopy: If true check out the object as a link
WorkspaceName: The name of the Workspace to which the objects are checked out
NumObj: The number of objects to check out
ObjNames: An array of names (and extensions) of the objects to check out
ObjVersions: The object versions. If this is null, the default action is to use the latest versions
RelCriteria: The relationship criteria

Returns:

pfcStandardReturn pwlParameterCreate (string MdlNameExt, number ItemType, number ItemID, string ParamName, number ValueType, number IntVal, number DoubleVal, string StringVal, boolean BooleanVal)

Creates a new parameter

Parameters:

MdlNameExt: The name and extension of the model
ItemType: Specifies whether it is a model (PWL_MODEL) or feature parameter (PWL_FEATURE).
ItemID: The feature identifier. This is unused for model parameters
ParamName: The name of the parameter
ValueType: The data type of the value (PWL_VALUE_INTEGER, PWL_VALUE_DOUBLE, PWL_VALUE_STRING, PWL_VALUE_BOOLEAN).
IntVal: Used if the value is an integer
DoubleVal: Used if the value is an double
StringVal: Used if the value is an string
BooleanVal: Used if the value is an boolean

Returns:

pfcStandardReturn pwlParameterDelete (string MdlNameExt, number ItemType, number ItemId, string ParamName)

Deletes the specified parameter

Parameters:

MdlNameExt: The name and extension of the model
ItemType: Specifies whether it is a model (PWL_MODEL) or feature parameter (PWL_FEATURE)
ItemId: The feature identifier. This is unused for model parameters
ParamName: The name of the parameter

Returns:

pfcStandardReturn pwlParameterDesignationAdd (string MdlNameExt, string ParamName)

Designates the specified parameter for Windchill

Parameters:

MdlNameExt: The name and extension of the model
ParamName: The name of the parameter

Returns:

pfcStandardReturn pwlParameterDesignationRemove (string MdlNameExt, string ParamName)

Removes the designation from the specified parameter

Parameters:

MdlNameExt: The name and extension of the model
ParamName: The name of the parameter

Returns:

pfcParameterDesignationVerifyReturn pwlParameterDesignationVerify (string MdlNameExt, string ParamName)

Determines whether the specified parameter has been designated for Windchill

Parameters:

MdlNameExt: The name and extension of the model
ParamName: The name of the parameter

Returns:

pfcStandardReturn pwlParameterRename (string MdlNameExt, number ItemType, number ItemId, string ParamName, string NewName)

Renames the specified parameter

Parameters:

MdlNameExt: The name and extension of the model
ItemType: Specifies whether it is a model (PWL_MODEL) or feature parameter (PWL_FEATURE)
ItemId: The feature identifier. This is unused for model parameters
ParamName: The old parameter name
NewName: The new name of the parameter

Returns:

pfcStandardReturn pwlParameterReset (string MdlNameExt, number ItemType, number ItemId, string ParamName)

Resets the specified parameter value to its last regenerated value

Parameters:

MdlNameExt: The name and extension of the model
ItemType: Specifies whether it is a model (PWL_MODEL) or feature parameter (PWL_FEATURE)
ItemId: The feature identifier. This is unused for model parameters
ParamName: The name of the parameter

Returns:

pfcParameterValueGetReturn pwlParameterValueGet (string MdlNameExt, number ItemType, number ItemID, string ParamName)

Retrieves the value of the specified parameter

Parameters:

MdlNameExt: The name and extension of the model
ItemType: Specifies whether it is a model (PWL_MODEL) or feature parameter (PWL_FEATURE).
ItemID: The feature identifier. This is unused for model parameters
ParamName: The name of the parameter

Returns:

pfcStandardReturn pwlParameterValueSet (string MdlNameExt, number ItemType, number ItemID, string ParamName, number ValueType, number IntVal, number DoubleVal, string StringVal, boolean BooleanVal)

Sets the value of the specified parameter

Parameters:

MdlNameExt: The name and extension of the model
ItemType: Specifies whether it is a model (PWL_MODEL) or feature parameter (PWL_FEATURE)
ItemID: The feature identifier. This is unused for model parameters
ParamName: The name of the parameter
ValueType: The data type of the value (PWL_VALUE_INTEGER, PWL_VALUE_DOUBLE, PWL_VALUE_STRING, PWL_VALUE_BOOLEAN)
IntVal: Used if the value is an integer
DoubleVal: Used if the value is an double
StringVal: Used if the value is an string
BooleanVal: Used if the value is an boolean

Returns:

pfcPartMaterialCurrentGetReturn pwlPartMaterialCurrentGet (string MdlNameExt)

Gets the current material name of the specified part

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcStandardReturn pwlPartMaterialCurrentSet (string MdlNameExt, string MaterialName)

Sets the current material name for the specified part. The material must already be associated with the part.

Parameters:

MdlNameExt: The name and extension of the model
MaterialName: The name of the material

Returns:

pfcPartMaterialdataGetReturn pwlPartMaterialDataGet (string MdlNameExt, string MaterialName)

Get the properties of the specified material

This method is deprecated. Use pfcMaterial.GetPropertyValue() for the properties you wish to access instead.

Parameters:

MdlNameExt: The name and extension of the model
MaterialName: The name of the material

Returns:

pfcStandardReturn pwlPartMaterialDataSet (string MdlNameExt, string MaterialName, number YoungModulus, number PoissonRatio, number ShearModulus, number MassDensity, number ThermExpCoef, number ThermExpRefTemp, number StructDampCoef, number StressLimTension, number StressLimCompress, number StressLimShear, number ThermConductivity, number Emissivity, number SpecificHeat, number Hardness, string Condition, number InitBendYFactor, string BendTable)

Sets the properties of the specified material

This method is deprecated. Use pfcMaterial.SetPropertyValue() for the properties you wish to set instead. This sets the property values in the units of the model that owns this material. An attempt to assign material properties which are not supported by the material will be ignored.

Parameters:

MdlNameExt: The name and extension of the model
MaterialName: The name of the material
YoungModulus: The Young's Modulus
PoissonRatio: The Poisson Ratio
ShearModulus: The Sheer Modulus
MassDensity: The Mass density
ThermExpCoef: The thermal expansion coefficient
ThermExpRefTemp: The thermal expansion reference coefficient
StructDampCoef: The structural damping coefficient
StressLimTension: The stress limit for tension
StressLimCompress: The stress limit for compression
StressLimShear: The stress limit for shear
ThermConductivity: The thermal conductivity
Emissivity: The emissivity
SpecificHeat: The specific heat
Hardness: The hardness
Condition: The condition
InitBendYFactor: The initial bend Y factor
BendTable: The bend table

Returns:

pfcPartMaterialCurrentGetReturn pwlPartMaterialGet (string MdlNameExt)

Gets the material name of the specified part. This function is identical to pfcScript.pwlPartMaterialCurrentGet() and is maintained for backwards compatibility.

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcStandardReturn pwlPartMaterialSet (string MdlNameExt, string MaterialName)

Sets the material name for the specified part from a material file

Parameters:

MdlNameExt: The name and extension of the model
MaterialName: The name of the material

Returns:

pfcPartMaterialsGetReturn pwlPartMaterialsGet (string MdlNameExt)

Gets all the material names for the specified part

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcStandardReturn pwlProEngineerConnect ()

This method does nothing in the embedded browser Web.Link. It is provided solely for backwards compatiblity with old applications.

Returns:

pfcStandardReturn pwlProEngineerDisconnect ()

This method does nothing in the embedded browser Web.Link. It is provided solely for backwards compatiblity with old applications.

Returns:

pfcStandardReturn pwlProEngineerDisconnectAndStop ()

This method does nothing in the embedded browser Web.Link. It is provided solely for backwards compatiblity with old applications.

Returns:

pfcStandardReturn pwlProEngineerStartAndConnect ()

This method does nothing in the embedded browser Web.Link. It is provided solely for backwards compatiblity with old applications.

Returns:

pfcSelectReturn pwlSelect (string SelectableFilter, number MaxSelectable)

Selects an item in Creo Parametric.

The form for SelectableFilter is a comma-separated list of any or all of the following:

dimension
feature
part
prt_or_asm

Parameters:

SelectableFilter: A filter that describes which items can be selected
MaxSelectable: The maximum number of items that can be selected. If this is a negative number, there is an unlimited number of selections.

Returns:

pfcSelectionCreateReturn pwlSelectionCreate (string TopModel, number NumComponents, stringseq ComponentPath, intseq ComponentIDs, number ItemType, number ItemID)

Parameters:

TopModel
NumComponents
ComponentPath
ComponentIDs
ItemType
ItemID

Returns:

pfcSelectionParseReturn pwlSelectionParse (string SelString)

Parses the components from the specified selection string

Parameters:

SelString: The selection string to be parsed

Returns:

pfcSessionMdlsGetReturn pwlSessionMdlsGet (number MdlType)

Lists the models of the specified type in the current Creo Parametric session.

The possible values for MdlType are as follows:

PWL_ASSEMBLY
PWL_PART
PWL_DRAWING
PWL_2DSECTION
PWL_LAYOUT
PWL_DWGFORM
PWL_MFG
PWL_REPORT
PWL_MARKUP
PWL_DIAGRAM

Parameters:

MdlType: The model type

Returns:

pfcSessionWindowsGetReturn pwlSessionWindowsGet ()

Lists the identifiers of the windows currently in the Creo Parametric session

Manual References:: The Basics of Web.Link: Windows

Returns:

pfcStandardReturn pwlSimprepActivate (string MdlNameExt, string SimprepName)

Activates a simplified representation for the specified model

Parameters:

MdlNameExt: The name and extension of the model
SimprepName: The name of the simplified representation

Returns:

pfcSimprepGetReturn pwlSimprepCurrentGet (string AsmNameExt)

Returns the current active simplified representation for the specified assembly

Parameters:

AsmNameExt: The full name of the part or assembly

Returns:

pfcStandardReturn pwlSimprepMasterActivate (string MdlNameExt)

Activates the master simplified representation for the specified model

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcMdlOpenReturn pwlSimprepOpen (string AsmNameExt, string Path, string RepName, boolean DisplayInWindow)

Retrieves the specified simplified representation

Parameters:

AsmNameExt: The full name of the part or assembly
Path: The path to the model
RepName: The name of the simplified representation
DisplayInWindow: Specifies whether to display the model in a Creo Parametric window

Returns:

pfcSolidMassPropertiesGetReturn pwlSolidMassPropertiesGet (string MdlNameExt, string CoordinateSys)

Gets the mass properties for the specified solid

Parameters:

MdlNameExt: The name and extension of the model
CoordinateSys: The coordinate system used to get the mass properties

Returns:

pfcStandardReturn pwlSolidXSectionDisplay (string MdlNameExt, string CrossSectionName)

Displays the specified cross section

Parameters:

MdlNameExt: The name and extension of the model
CrossSectionName: The name of the cross section to display

Returns:

pfcSolidXSectionsGetReturn pwlSolidXSectionsGet (string MdlNameExt)

Retrieves the cross sections from the specified model

Parameters:

MdlNameExt: The name and extension of the model

Returns:

number pwlTypeFromModelItemType (pfcModelItemType Type)

Converts a pfcModelItemType to the corresponding PWL constant

Parameters:

Type

Returns:

number pwlTypeFromModelType (pfcModelType Type)

Converts a pfcModelType to the corresponding PWL constant

Parameters:

Type

Returns:

pfcModelItemType pwlTypeToModelItemType (number Type)

Converts a PWL constant to the corresponding pfcModelItemType

Parameters:

Type

Returns:

pfcModelType pwlTypeToModelType (number Type)

Converts a PWL constant to the corresponding pfcModelType

Parameters:

Type

Returns:

booleanseq pwluBooleanArrayAlloc (number ArraySize)

Allocates an array of boolean values

Parameters:

ArraySize: The size of the boolean array to allocate

Returns:

realseq pwluDoubleArrayAlloc (number ArraySize)

Allocates an array of doubles

Parameters:

ArraySize: size of the double array to allocate

Returns:

intseq pwluIntArrayAlloc (number ArraySize)

Allocates an array of integers

Parameters:

ArraySize: The size of the integer array to allocate

Returns:

stringseq pwluStringArrayAlloc (number ArraySize)

Allocates an array of strings

Parameters:

ArraySize: The size of the string array to allocate

Returns:

pfcStandardReturn pwlViewDefaultSet (string MdlNameExt)

Sets the specified model to the default view for that model

Parameters:

MdlNameExt: The name and extension of the model

Returns:

pfcStandardReturn pwlViewSet (string MdlNameExt, string NamedView)

Sets the view to a predefined view setting

Parameters:

MdlNameExt: The name and extension of the model
NamedView: The name of the view

Returns:

pfcStandardReturn pwlWindowActivate (number WindowID)

Activates the specified window

Parameters:

WindowID: The identifier of the window to activate

Returns:

pfcWindowActiveGetReturn pwlWindowActiveGet ()

Gets the active window in the Creo Parametric session

Manual References:: The Basics of Web.Link: Windows

Returns:

pfcStandardReturn pwlWindowClose (number WindowID)

Closes the specified window. Specify the value -1 to close the current window.

Parameters:

WindowID: The identifier of the window to close

Returns:

pfcWindowMdlGetReturn pwlWindowMdlGet (number WindowID)

Retrieves the model associated with the specified window

Parameters:

WindowID: The identifier of the window with which the model is associated

Returns:

pfcStandardReturn pwlWindowRepaint (number WindowID)

Repaints the contents of the specified window. Specify the value -1 to repaint the current window

Parameters:

WindowID: The identifier of the window to repaint

Returns: