Dialog - Save file

Declaration

<AMSHOWDIALOG ACTIVITY="save" WINDOWTITLE="text" RESULTVARIABLE="text" FILTER="text" DEFAULTFOLDER="text" ONCANCEL="text (options)" />

Related Topics   

Description

Displays a standard Windows 'Save As' dialog box allowing the user to save a specific file. The file name and location specified is stored in a variable for use in subsequent steps. Execution is paused while the user makes a selection.

Practical Usage

Commonly used to allow a user to manually save a file during task execution.

Parameters

General

Property

Type

Required

Default

Markup

Description

Title of the message box

Text

No

(Empty)

TITLE="Save location"

The title that the dialog box should display (i.e. "Please browse for the target location").

Populate variable with result

Text

Yes

(Empty)

RESULTVARIABLE="varname"

The name of an already created variable that should be populated with the file or folder selected by the user.

Advanced

Property

Type

Required

Default

Markup

Description

Filter

Text (options)

No

All files (*.*)|*.*

FILTER="All files (*.*)|*.*"

The file filters for the 'Save File' dialog box. Filters represent the masks that are listed in the File Type drop-down. For example, to include only text files, enter Text files (*.txt)|*.txt.

Initial Folder

Text

No

(Empty)

DEFAULTFOLDER="c:\foldername\"

The starting folder for the 'Open File' or 'Save As' dialog (this is not supported in the 'Browse for Folder' dialog).

On Cancel

Text

Yes

(Empty)

ONCANCEL="fail"

Specifies how this action will react if the user presses the Cancel button. The available options are:

  • Continue - The task will continue to the next step.

  • Stop (default) - The task will stop. No error is generated.

  • Fail - The task fail with an error.  

 

Description

Error Causes

On Error

Example

NOTE:
  • The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
  • Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.

Description:

Open "Save File As" dialog.  Populate the variable "theVar" with the selected file name.

Copy 
<AMSHOWDIALOG ACTIVITY="save" WINDOWTITLE="Please select file to save" RESULTVARIABLE="theVar" DEFAULTFOLDER="C:\Temp" />