API Documentation > Classes > Interface IpfcWindow
Interface IpfcWindow
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:
Direct Parent Classes:
User Guide References:
Property Summary
Property
as Double
The height of the Creo Parametric graphics window without the border.
Property
as Double
The width of the Creo Parametric graphics window without the border
Property
as Double
The window height. The size is normalized to values from 0 to 1.
Property
as IpfcModel [readonly, optional]
The Creo Parametric model that owns the window. This attribute can be null, if there no model that currently owns the window.
Property
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.
Property
as Double
The width of the window. The size is normalized to values from 0 to 1.
Property
as Double
The X position of the window. The position is normalized to values from0 to 1.
Property
as Double
The Y position of the window. The position is normalized to values from0 to 1.
Method Summary
Sub
Activates the window.
Sub
Clears the Creo Parametric window.
Sub
Closes the window.
Sub
ExportRasterImage (ImageFileName as String, Instructions as IpfcRasterImageExportInstructions)
Outputs a standard Creo Parametric raster output file.
Function
GetBrowserSize () as Double
Returns the percentage of the graphics window covered by the embedded web browser.
Function
GetId () as Long
Retrieves the current window identifier.
Function
GetURL () as String
Returns the URL displayed in the embedded web browser.
Sub
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.
Sub
Repaints the window. This function enables you to perform several operations and update the view when necessary.
Sub
SetBrowserSize (BrowserSize as Double)
Sets the percentage of the graphics window covered by the embedded web browser.
Sub
SetURL (URL as String)
Sets the URL displayed in the embedded web browser.
Property Detail
Property
GraphicsAreaHeight
as Double
The height of the Creo Parametric graphics window without the border.
The height is normalized to a value from 0 to 1.
Property
GraphicsAreaWidth
as Double
The width of the Creo Parametric graphics window without the border
The width is normalized to a value from 0 to 1.
Property
Height
as Double
The window height. The size is normalized to values from 0 to 1.
Property
Model
as IpfcModel [readonly, optional]
The Creo Parametric model that owns the window. This attribute can be null, if there no model that currently owns the window.
Property
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):
IpfcXToolkitBadContext - There is no current window.
Property
Width
as Double
The width of the window. The size is normalized to values from 0 to 1.
Property
XPos
as Double
The X position of the window. The position is normalized to values from0 to 1.
Property
YPos
as Double
The Y position of the window. The position is normalized to values from0 to 1.
Method Detail
Sub
Activate
()
Activates the window.
This method only works in the asynchronous graphics mode. It will throw a IpfcXToolkitBadContext exception, if called in the non-graphic mode.
Exceptions thrown (but not limited to):
IpfcXToolkitBadContext - The function was called in RPC input (non-graphic) mode
Sub
Clear
()
Clears the Creo Parametric window.
Sub
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):
IpfcXToolkitBadContext - The window you are trying to delete is the current window.
IpfcXToolkitDeadLock - 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).
Sub
ExportRasterImage
(ImageFileName as String, Instructions as IpfcRasterImageExportInstructions)
Outputs a standard Creo Parametric raster output file.
Exceptions thrown (but not limited to):
IpfcXToolkitNoPermission - The function does not have permission to operate on this model.
IpfcXToolkitBadContext - 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 IpfcRasterImageExportInstructions .
User Guide References:
Function
GetBrowserSize
() as Double
Returns the percentage of the graphics window covered by the embedded web browser.
Not applicable if browser is open in separate window.
See Also:
Returns:
The percentage of the window covered, from 0.0 (the browser is minimized) to 100.0 (the browser covers the entire window).
User Guide References:
Function
GetId
() as Long
Retrieves the current window identifier.
User Guide References:
Returns:
The current window identifier. If the current window is the message area, the method returns -1.
Function
GetURL
() as String
Returns the URL displayed in the embedded web browser.
See Also:
Returns:
The URL.
User Guide References:
Sub
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.
Sub
Repaint
()
Repaints the window. This function enables you to perform several operations and update the view when necessary.
Sub
SetBrowserSize
(BrowserSize as Double)
Sets the percentage of the graphics window covered by the embedded web browser.
Not applicable if browser is open in separate window.
See Also:
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).
User Guide References:
Sub
SetURL
(URL as String)
Sets the URL displayed in the embedded web browser.
See Also:
Parameters:
URL
The URL to display in the browser.
User Guide References:
Was this helpful?