NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.ListingWindow Class Reference

Represents a ListingWindow. More...

Inheritance diagram for NXOpen.ListingWindow:

Public Types

enum  DeviceType { Window, File, FileAndWindow, None }
 Describes the type of listing window More...
 

Public Member Functions

unsafe void Open ()
 Opens the listing window. More...
 
unsafe void Close ()
 Closes the stream to the listing window. More...
 
unsafe void CloseWindow ()
 Closes the listing window actually from the UI. More...
 
unsafe void WriteLine (string msg)
 Writes a line to the listing window. More...
 
unsafe void WriteFullline (string msg)
 Writes a full line to the listing window. More...
 
unsafe void SelectDevice (NXOpen.ListingWindow.DeviceType deviceType, string fileName)
 Changes where the listing window output is sent. More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 
unsafe
NXOpen.ListingWindow.DeviceType 
Device [get]
 Returns the device type for the window. More...
 
unsafe bool IsOpen [get]
 Returns a flag indicating whether the listing window is open. More...
 

Detailed Description

Represents a ListingWindow.

To obtain an instance of this class, refer to NXOpen.Session

Created in NX3.0.0

Member Enumeration Documentation

Describes the type of listing window

Enumerator
Window 

The UI's Information window

File 

Output is written to a file instead of the Information window

FileAndWindow 

Output is written to a file and to the Information window

None 

Output is not written anywhere; output gets discarded

Member Function Documentation

unsafe void NXOpen.ListingWindow.Close ( )

Closes the stream to the listing window.

The window itself is not closed. If the listing window is a file, this will flush the buffer and close the file.

Created in NX3.0.0

License requirements: None.

unsafe void NXOpen.ListingWindow.CloseWindow ( )

Closes the listing window actually from the UI.

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.ListingWindow.Open ( )

Opens the listing window.

The listing window must be open before lines can be written to it

Created in NX3.0.0

License requirements: None.

unsafe void NXOpen.ListingWindow.SelectDevice ( NXOpen.ListingWindow.DeviceType  deviceType,
string  fileName 
)

Changes where the listing window output is sent.

The listing window output can be sent to the Information window of the Unigraphics session, to a file, or to both.

Note: file output is buffered. If file output is used, the buffer will not be flushed until the output device is changed again. E.g.

ListingWindow.SelectDevice(File, "log.txt")
ListingWindow.Open()
ListingWindow.WriteLine("output")
ListingWindow.Close()
' buffer is not flushed yet
ListingWindow.SelectDevice(Window, "")
' now the buffer is flushed

Created in NX3.0.0

License requirements: None.

Parameters
deviceTypeThe type of device (file, Information window, or both)
fileNameName of the file. Used only if the device type is file.
unsafe void NXOpen.ListingWindow.WriteFullline ( string  msg)

Writes a full line to the listing window.

The listing window must be open before you can write to it. If the listing window is a file, the output is buffered, so the output may not appear in the file until the buffer gets flushed. The buffer is flushed when the listing window gets closed. And number of characters displayed in one line has no limit which is different from NXOpen.ListingWindow.WriteLine

If a null reference (Nothing in Visual Basic) is passed in this method will do nothing.

Created in NX8.5.0

License requirements: None.

Parameters
msgLine to write
unsafe void NXOpen.ListingWindow.WriteLine ( string  msg)

Writes a line to the listing window.

The listing window must be open before you can write to it. If the listing window is a file, the output is buffered, so the output may not appear in the file until the buffer gets flushed. The buffer is flushed when the listing window gets closed. And the maximum number of characters displayed in one line is 132.

If a null reference (Nothing in Visual Basic) is passed in this method will do nothing.

Created in NX3.0.0

License requirements: None.

Parameters
msgLine to write

Property Documentation

unsafe NXOpen.ListingWindow.DeviceType NXOpen.ListingWindow.Device
get

Returns the device type for the window.

The device type indicates whether the output for the listing window is sent to the Information window, to a file, or to both

Created in NX3.0.0

License requirements: None.

unsafe bool NXOpen.ListingWindow.IsOpen
get

Returns a flag indicating whether the listing window is open.

To open the window, use NXOpen.Arc .

Created in NX3.0.0

License requirements: None.

Tag NXOpen.ListingWindow.Tag
get

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.