IOutputToolbox

class IOutputToolbox

Bases: ImpactCOMWrapperBase

Description:

Allows manipulation of the output toolbox.

Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance

add(text)

Description:

Adds a line of text to the Output Toolbox.

Remarks:

Writing many hundreds of lines of text to the Output Toolbox may cause some performance degredation. If you are writing logging information to help with troubleshooting a script or plug-in, consider writing it to the Impact debug log instead, using Impact.log.Add.

Parameters:

text (str) – Specifies the text to add.

clear()

Description:

Clears all text from the output toolbox.

open()

Description:

Causes the Output Toolbox to appear, if not already visible.

Remarks:

If the Output Toolbox is already open, but is hidden behind another toolbox, it will pop to the front. Similarly, if it is docked with the auto-hide option, it will pop out. Introduced in Impact 8.0.0.33

save_to_file(file_name)

Description:

Saves the contents of the output toolbox to a file.

Parameters:

file_name (str) – The full path of the file to save to, if the file does not exist it is created.