Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter EighteenDataView Integration (continued)

FormsViewSetSaveOptions Function

Overview

The FormsViewSetSaveOptions function sets default parameters for the File Save As query dialog.

Syntax/Parameters

Syntax

int = FormsViewSetSaveOptions ( handle object, [string title], [string filters],
                           [string extension] );

Parameters

object

A handle either to a Forms View Object or to a window that employs Forms View.

title

A string that becomes the dialog’s caption. Note that for browse dialogs, the dialog caption is used to store sticky path information in the application’s settings file. Depending on the application settings, the path may be remembered based on the title.

filters

A string that specifies an optional filter list. If a filter list is not provided, the default of “All Files (*.*)” will be added to the filter list. See Filters at the start of Section 9.2 Common Dialogs for filter string formatting information.

extension

An optional string specifying a default file extension to use if the user fails to add an extension. If provided, the value should be 1 to 3 characters without the leading period. When using a default extension, the filter *.* should be supplied. See Remarks.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure. Use the GetLastError function to retrieve error information.

Remarks

The function should be called during the script setup and prior to any possible file save actions by the user. The function allows the save information to be set to help limit the users options on saving.

For example:

 FormsViewSetSaveOptions(hView, "Save Form 12b-25",
                            "All Files *.*|*.*&HTML File *.htm|*.htm", "htm");

Related Functions

Platform Support

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