  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Nineteen — TextView Integration (continued)
Overview
The TextViewOpenFile function opens an MDI split view filing for viewing and editing as text, scripts, XML and HTML code.
Syntax/Parameters
Syntax
handle = TextViewOpenFile ( string source, [int type], [int display], [string alias] );
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 use that type. If 0, the window is opened with plain ASCII/ANSI settings. Other specified file types (or auto type) will change the color coding and behavior of the resulting text window depending on the settings for that file type. Overriding the file type will change the editor characteristics such as the color coding scheme and tab processing.
display
An optional dword as display flags. Presently ignored, reserved for future releases. See remarks.
alias
A string that when specified becomes the alias name of the window. This is useful when opening a temp file version of another file. The alias can be the name displayed on the tab while contents of the source file is being displayed and edited.
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 contain 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.
The default style for a text view is split edit windows in a single MDI view. This function differs from running a FILE_OPEN from the RunMenuFunction in that is provides direct access to the Text View manager.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE
| Table of Contents | < < Previous | Next >> |
© 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.