Methods Introduced:

The method pfcGetProEArguments() returns an array containing the command-line arguments passed to Creo Parametric, if these arguments follow one of two formats:

The first argument passed in the array is the full path to the Creo Parametric executable.

The method pfcGetProEVersion() returns a string that represents the Creo Parametric version, for example “Wildfire”.

The method pfcGetProEBuildCode() returns a string that represents the build code of the Creo Parametric session.

Methods Introduced:

The method pfcBaseSession.ListFiles() returns a list of files in a directory, given the directory path. You can filter the list to include only files of a particular type, as specified by the file extension.

The method pfcBaseSession.ListFiles() can also list instance objects when accessing Windchill workspaces or folders. A PDM location for workspace or commonspace, must be passed as the directory path. The following options are added in the pfcFileListOpt enumerated type:

The method pfcBaseSession.ListSubdirectories() returns the subdirectories in a given directory location.

Methods Introduced:

You can access configuration options programmatically using the methods described in this section.

Use the method pfcBaseSession.GetConfigOptionValues() to retrieve the value of a specified configuration file option. Pass the Name of the configuration file option as the input to this method. The method returns an array of values that the configuration file option is set to. It returns a single value if the configuration file option is not a multivalued option. The method returns a null if the specified configuration file option does not exist.

The method pfcBaseSession.SetConfigOption() is used to set the value of a specified configuration file option. If the option is a multi-value option, it adds a new value to the array of values that already exist.

The method pfcBaseSession.LoadConfigFile() loads an entire configuration file into Creo Parametric.

Method Introduced:

The method pfcBaseSession.RunMacro() runs a macro string. A Creo.JS macro string is equivalent to a Creo Parametric mapkey minus the key sequence and the mapkey name. To generate a macro string, create a mapkey in Creo Parametric. Refer to the Creo Parametric online help for more information about creating a mapkey.

Copy the Value of the generated mapkey Option from the Tools ▶ Options dialog box. An example Value is as follows:

$F2 @MAPKEY_LABELtest;
~ Activate `main_dlg_cur` `ProCmdModelNew.file`;
~ Activate `new` `OK`;

The key sequence is $F2. The mapkey name is @MAPKEY_LABELtest. The remainder of the string following the first semicolon is the macro string that should be passed to the method pfcBaseSession.RunMacro().

In this case, it is as follows:

~ Activate `main_dlg_cur` `ProCmdModelNew.file`;
~ Activate `new` `OK`;

Macros are executed from synchronous mode only when control returns to Creo Parametric from the Creo.JS program. Macros are stored in reverse order, last in, first out.

Methods Introduced:

These methods control the general display of a Creo Parametric session.

Use the method pfcBaseSession.SetStdColorFromRGB() to customize any of the Creo Parametric standard colors.

To change the color of any text in the window, use the method pfcBaseSession.SetTextColor().

To change the appearance of nonsolid lines such as datums, use the method pfcBaseSession.SetLineStyle().

A text message file is where you define strings that appear in the Creo Parametric user interface. This includes the strings on the command buttons that you add to the Creo Parametric number, the help string that appears when a cursor is positioned over such a command button, and text strings that appear in the Message Window. You have the option of including a translation for each string in the text message file.

Method and Properties Introduced:

The method pfcSession.UIShowMessageDialog() displays the UI message dialog. The input arguments to the method are:

The following sections describe how to access the message window using Creo.JS. The topics are as follows:

Messages displayed in Creo.JS include a symbol that identifies the message type. Every message type is identified by a classification that begins with the characters %C. A message classification requires that the message key line, line one in the message file must be preceded by the classification code.

Creo.JS applications can display any or all of the following message symbols:

Method Introduced:

The method pfcSession.UIDisplayFeatureParams() forces Creo Parametric to show dimensions or other parameters stored on a specific feature. The displayed dimensions may then be interactively selected by the user.

Methods and Properties Introduced:

The method pfcSession.UIOpenFile() opens the relevant dialog box for browsing directories and opening files. The method lets you specify several options through the input arguments pfcFileOpenOptions and pfcFileUIOptions.

The method pfcSession.UIOpenFile() returns the file selected by you. The application must use other properties or techniques to perform the desired action on the file.

Use the method pfcFileOpenOptions.Create() to create a new instance of the pfcFileOpenOptions object. A list of options for this object with a description about what each option specifies, follows:

The pfcFileUIOptions object contains the following options:

Use the property pfcFileOpenShortcut.ShortcutName to set the string for the shortcut name.

Use the property pfcFileOpenShortcut.ShortcutPath to set the string for the shortcut path.

Use the property pfcFileUIOptions.Shortcuts to set the array of file shortcuts.

The method pfcSession.UISaveFile() opens the dialog box for saving a file. The method accepts options similar to pfcSession.UIOpenFile() through the pfcFileSaveOptions and pfcFileUIOptions objects. Use the method pfcFileSaveOptions.Create() to create a new instance of the pfcFileSaveOptions object. When using the Save dialog box, you can set the name to a nonexistent file. The method pfcSession.UISaveFile() returns the name of the file selected by you; the application must use other methods or techniques to perform the desired action on the file.

The method pfcSession.UISelectDirectory() prompts the user to select a directory using the Creo Parametric dialog box for browsing directories. The method accepts options through the pfcDirectorySelectionOptions object which is similar to the pfcFileUIOptions object (described for the method pfcSession.UIOpenFile()). Specify the default directory path, the title of the dialog box, and a set of shortcuts to other directories to start browsing. If the default path is specified as NULL, the current directory is used. Use the method pfcDirectorySelectionOptions.Create() to create a new instance of the pfcDirectorySelectionOptions object. The method pfcSession.UISelectDirectory() returns the selected directory path; the application must use other methods or techniques to perform other tasks with this selected path.

The Creo Parametric navigation area includes the Model and Layer Tree pane, Folder browser pane, and Favorites pane. The methods described in this section enable Creo.JS applications to add custom panes that contain Web pages to the Creo Parametric navigation area.