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

Table of Contents	< < Previous	Next >>

 

Chapter Eighteen — DataView Integration (continued)

DataViewOpenFile Function

Overview

The DataViewOpenFile function opens an MDI Data View workbook from a number of source file formats.

Syntax/Parameters

Syntax

handle = DataViewOpenFile ( string source, [dword type] );

Parameters

source

A string containing a qualified filename or a URL.

type

An optional dword specifying an override file type. If omitted, the script will attempt to identify the file type and uses that type.

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

If the application desktop is not running, the function will fail by returning NULL_HANDLE with a last error of ERROR_CONTEXT. If the host application does not support this feature, the last error will be ERROR_CANCEL.

This function differs from running a FILE_OPEN from the RunMenuFunction in that it provides direct access to the Data View manager.

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

The display flags are as follows:

[ to be added to SDK ]

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.

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

 

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.