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

Table of Contents	< < Previous	Next >>

 

Chapter Seventeen — Application Integration Functions (continued)

GetEditWindowFilename Function

Overview

The GetEditWindowFilename function returns the associated filename for a requested window.

Syntax/Parameters

Syntax

string = GetEditWindowFilename ( handle hwTarget | int index );

Parameters

hwTarget

A handle. If hwTarget is specified, then index cannot be specified.

index

An int containing an Edit Manager window index. If hwTarget is not specified, then index must be provided. The value can be -1 indicating that the active window is requested.

Return Value

Returns a string containing the filename for the window information or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The GetEditWindowFilename function returns the filename either by a window index for the Edit Manager or by a specific window handle. Using a handle is useful to retrieve the type for a specific view. Each window will have an associated mapped text or edit object. Not all windows use the objects in the same manner and, in many cases, the mapped text object is used only for file control, such as in the case of an Image View or data sheet base window.

Note that an untitled window will return an empty string so the GetLastError or IsError function must be used to determine if an error occurred.

If the window is specified as a handle, the request is sent directly to the window.

Related Functions

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.

GetEditWindowCount — Returns the number of open edit windows from the Edit Manager.

GetEditWindowHandle — Gets the handle for a specific window client or view. If a view index is supplied, the edit manager index must be supplied.

GetEditWindowLimit — Gets the number of edit window slots from the Edit Manager.

GetEditWindowType — Returns the window type code for windows managed by the Edit Manager.

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.