MessageWindow

The application message window. Messages with various formatting can be written to the message window.

Example

app = cf.Application.getInstance()

    -- Get the 'MessageWindow' object

messageWindow = app.MessageWindow

    -- Log a message and a heading
    
messageWindow:LogHeading('MessageWindow example')
messageWindow:LogMessage('A message from the example')

    -- Show the message window
    
messageWindow:Show()

Inheritance

The MessageWindow object is derived from the Object object.

Usage locations

The MessageWindow object can be accessed from the following locations:

Property List

Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Method List

Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity. (Returns a Object object.)
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
LogError (message string)
Log an error message to the message window.
LogHeading (heading string)
Log a heading to the message window.
LogMessage (message string)
Log a message to the message window.
LogNote (message string)
Log a note to the message window.
LogWarning (message string)
Log a warning message to the message window.
SetProperties (properties Object)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Show ()
Show this message window.

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity.
Return
Object
The new (duplicated) entity.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A table defining the properties.
LogError (message string)
Log an error message to the message window.
Input Parameters
message(string)
The error message.
LogHeading (heading string)
Log a heading to the message window.
Input Parameters
heading(string)
The heading.
LogMessage (message string)
Log a message to the message window.
Input Parameters
message(string)
The message.
LogNote (message string)
Log a note to the message window.
Input Parameters
message(string)
The note message.
LogWarning (message string)
Log a warning message to the message window.
Input Parameters
message(string)
The warning message.
SetProperties (properties Object)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(Object)
A table of properties defining the new state of the object.
Show ()
Show this message window.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.