CIP JavaScript documentation for class " pfcWindow"

Class pfcWindow

Description

This class describes the attributes of a window.

The window position refers to the upper, left corner of the window from the upper, left corner of the screen.

See Also:: pfcSession, pfcBaseSession.ListWindows(), pfcBaseSession.GetWindow()

Direct Parent Classes:: pfcChild

Property Summary


`/* readonly */ number`	`GraphicsAreaHeight`
	The height of the Creo Parametric graphics window without the border.

`/* readonly */ number`	`GraphicsAreaWidth`
	The width of the Creo Parametric graphics window without the border

`/* readonly */ number`	`Height`
	The window height. The size is normalized to values from 0 to 1.

`/* readonly / / optional */ pfcModel`	`Model`
	The Creo Parametric model that owns the window. This attribute can be `null`, if there no model that currently owns the window.

`pfcScreenTransform`	`ScreenTransform`
	The pan and zoom matrix of the window. When you set a window's ScreenTransform, the window updates immediately. Currently, the Get() method only retreives the ScreenTransform object for the current Creo Parametric window.

`/* readonly */ number`	`Width`
	The width of the window. The size is normalized to values from 0 to 1.

`/* readonly */ number`	`XPos`
	The X position of the window. The position is normalized to values from0 to 1.

`/* readonly */ number`	`YPos`
	The Y position of the window. The position is normalized to values from0 to 1.

Method Summary


`void`	`Activate ()`
	Activates the window.

`void`	`Clear ()`
	Clears the Creo Parametric window.

`void`	`Close ()`
	Closes the window.

`void`	`ExportRasterImage (string ImageFileName, pfcRasterImageExportInstructions Instructions)`
	Outputs a standard Creo Parametric raster output file.

`number`	`GetBrowserSize ()`
	Returns the percentage of the graphics window covered by the embedded web browser.

`number`	`GetId ()`
	Retrieves the current window identifier.

`string`	`GetURL ()`
	Returns the URL displayed in the embedded web browser.

`void`	`Refresh ()`
	Refreshes the screen. The function does not clear highlights. This is the most efficient function to use if you want to clear "temporary" graphics only.

`void`	`Repaint ()`
	Repaints the window. This function enables you to perform several operations and update the view when necessary.

`void`	`SetBrowserSize (number BrowserSize)`
	Sets the percentage of the graphics window covered by the embedded web browser.

`void`	`SetURL (string URL)`
	Sets the URL displayed in the embedded web browser.

Property Detail

/* readonly */ number GraphicsAreaHeight

The height of the Creo Parametric graphics window without the border.

The height is normalized to a value from 0 to 1.

/* readonly */ number GraphicsAreaWidth

The width of the Creo Parametric graphics window without the border

The width is normalized to a value from 0 to 1.

/* readonly */ number Height

The window height. The size is normalized to values from 0 to 1.

/* readonly */ /* optional */ pfcModel Model

The Creo Parametric model that owns the window. This attribute can be null, if there no model that currently owns the window.

pfcScreenTransform ScreenTransform

The pan and zoom matrix of the window. When you set a window's ScreenTransform, the window updates immediately.

Currently, the Get() method only retreives the ScreenTransform object for the current Creo Parametric window.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - There is no current window.

/* readonly */ number Width

The width of the window. The size is normalized to values from 0 to 1.

/* readonly */ number XPos

The X position of the window. The position is normalized to values from0 to 1.

/* readonly */ number YPos

The Y position of the window. The position is normalized to values from0 to 1.

Method Detail

void Activate ()

Activates the window.

This method only works in the asynchronous graphics mode. It will throw a pfcXToolkitBadContext exception, if called in the non-graphic mode.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The function was called in RPC input (non-graphic) mode

void Clear ()

Clears the Creo Parametric window.

void Close ()

Closes the window.

If the current window is the original window created when Creo Parametric started, the function clears the window. Otherwise, the function removes the window from the screen.
Any work done since the last save will be lost.
This function does not take effect until control returns to Creo Parametric.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The window you are trying to delete is the current window.

pfcXToolkitDeadLock - The Creo Parametric user interface is not prepared to handle this request (because it is blocked by another process such as an OLE container activation).

void ExportRasterImage (string ImageFileName, pfcRasterImageExportInstructions Instructions)

Outputs a standard Creo Parametric raster output file.

Exceptions thrown (but not limited to):

pfcXToolkitNoPermission - The function does not have permission to operate on this model.

pfcXToolkitBadContext - The function is not available in Design Test Mode.

Parameters:

ImageFileName: An output filename, including the extension
Instructions: An Raster-Export-Instructions object that controls the Raster-Image export operation. All of these objects inherit from pfcRasterImageExportInstructions .

number GetBrowserSize ()

Returns the percentage of the graphics window covered by the embedded web browser.

Not applicable if browser is open in separate window.

See Also:: pfcWindow.SetBrowserSize(), pfcWindow.GetURL(), pfcWindow.SetURL()

Returns:: The percentage of the window covered, from 0.0 (the browser is minimized) to 100.0 (the browser covers the entire window).

number GetId ()

Retrieves the current window identifier.

Returns:: The current window identifier. If the current window is the message area, the method returns -1.

string GetURL ()

Returns the URL displayed in the embedded web browser.

See Also:: pfcWindow.GetBrowserSize(), pfcWindow.SetBrowserSize(), pfcWindow.SetURL()

Returns:: The URL.

void Refresh ()

Refreshes the screen. The function does not clear highlights. This is the most efficient function to use if you want to clear "temporary" graphics only.

void Repaint ()

Repaints the window. This function enables you to perform several operations and update the view when necessary.

void SetBrowserSize (number BrowserSize)

Sets the percentage of the graphics window covered by the embedded web browser.

Not applicable if browser is open in separate window.

See Also:: pfcWindow.GetBrowserSize(), pfcWindow.GetURL(), pfcWindow.SetURL()

Parameters:

BrowserSize: The percentage of the window to cover, from 0.0 (the browser is minimized) to 100.0 (the browser covers the entire window).

void SetURL (string URL)

Sets the URL displayed in the embedded web browser.

See Also:: pfcWindow.GetBrowserSize(), pfcWindow.SetBrowserSize(), pfcWindow.GetURL()

Parameters:

URL: The URL to display in the browser.