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

Table of Contents	< < Previous	Next >>

 

Chapter Eighteen — DataView Integration (continued)

FormsViewOpenFile Function

Overview

The FormsViewOpenFile function opens an MDI Data View workbook using a template and source file.

Syntax/Parameters

Syntax

handle = FormsViewOpenFile ( string source, [string template],
                                        [dword f_code | string f_string] );

Parameters

source

A string containing a qualified filename or a URL. This becomes the view’s source file.

template

An optional string specifying the template file to use to open the data.

f_code

An optional dword specifying a file type override as a file code. Or,

f_string

An optional string specifying a file type override as a file string.

Return Value

A window handle or NULL_HANDLE (0) if there is an error. Use the GetLastError function to retrieve a formatted error code. The value is the handle to the MDI container window for all views displayed and can be used to access other window functions. This handle is not a script object and does not need to be closed.

If the view is opened, the Edit Manager entry index can be retrieved by using the GetLastError function.

Remarks

This function differs from running a FILE_OPEN from the RunMenuFunction in that it provides direct access to the Forms View manager and allows a template to be directly specified.

If the file format is not supported, ERROR_FUNCTION_NOT_SUPPORTED will be placed in the last error buffer.

An optional file type can be specified as either a file code or file string. This type is attached to the view and the associated Edit and Mapped Text Object. If the string is not an known type, the function will return en error. See file type for more information on codes and strings.

Related Functions

DataViewGetObject — Returns a Data View handle (for an associated sheet) for the specified view by window handle. Also locks for paint.

DataViewGetDataSheet — Returns the handle for a specific data sheet.

FormsViewNewView — Creates a new form based on a data template in Forms View.

GetEditObject — Gets an Edit Object and associates it with an edit window.

GetMappedTextObject — Gets the associated Mapped Text Object for an edit window.

RunMenuFunction — Runs the specified menu function as if it is being run from the ribbon or menu. Dialog and message boxes may appear and suspend the script.

Platform Support

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

Page revised 2024-12-13

 

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.