GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Seventeen — Application Integration Functions (continued)

EnumerateEditWindows Function

Overview

The EnumerateEditWindows function returns a table of edit windows and their properties.

Syntax/Parameters

Syntax

string [][] = EnumerateEditWindows ( );

Parameters

(none)

 

Return Value

Returns a string table of window properties or an empty table on failure. Use the GetLastError and IsError functions to retrieve error information or test for an error. The key names for the array will contain a string version of the window handle.

Remarks

Each row of the table will have the key name as the handle in hex matching the MDI client window handle. The columns have the following column names:

	Key Name		Description
	ClientHandle		Window handle for the MDI client (parent to all views) in hexadecimal string form.
	ViewHandles		One or more view handles listed in order in hexadecimal string form separated by spaces.
	Filename		Filename with path (or URL) for the source file. This value will be blank for untitled windows.
	OpenTime		The time and date the file (window) was opened (or created) in ISO-8601 format in UTC.
	LastEditTime		The time and date the document was last edited in ISO-8601 format in UTC.
	LastViewTime		The time and date the document was manipulated or viewed in ISO-8601 format. This does not count opening the filing. This value changes when keyboard or mouse navigation is used to change what is viewed on the screen in UTC.
	EditActions		The total number of edit actions as a decimal string. Note that certain actions may count as more than one action such as auto quotes.
	UnsavedActions		The total number of unsaved edit actions as a decimal string. Note that certain actions may count as more than one action such as auto quotes. This can be used to see if unsaved changes are outstanding.
	FileTypeCode		File type code in hexadecimal string form.
	FileTypeToken		File type code as a token string form (such as FT_HTML).

 

Related Functions

EnumerateEditFiles — Enumerates a list of all or only modified titled edit windows and filenames.

FindEditWindow — Returns an edit window index by locating a handle or filename.

FindEditWindowByAlias — Returns an edit window index by matching an alias name.

FindEditWindowView — Finds a view handle by name, index or handle.

GetActiveEditWindow — Returns the handle to the active edit window.

MakeHandle — Converts an integer or formatted string to a handle value. The string can be hex, octal or decimal.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.