Salesforce

ClientFileSaveDlg (Magic xpa 3.x)

Printable View
« Go Back

Information

 
Created ByKnowledge Migration User
Approval Process StatusPublished
Objective
Description

ClientFileSaveDlg (Magic xpa 3.x)

Opens a Windows Save File dialog box and returns the selected file.

Syntax:

ClientFileSaveDlg (title, initial path, filter, default extension, overwrite prompt)

Parameters:

title – The window title text.

initial path – The name of the initial path. This path will also accept the filename and show it in the dialog box. A blank value will use the last path chosen.

(Before version 1.9, this was: initial directory – The name and path of the initial directory. A blank value will use the last directory chosen.)

filter – A string containing a description of the filter, followed by the vertical bar (|) and the filter pattern. The strings for different filtering options are separated by the vertical bar. Several filter patterns can be joined to a filter by separating the file types with semicolons. The first pair will be the default in the dialog box.

For example: 'Image Files (*.BMP;*.JPG;*.GIF) | *.BMP;*.JPG;*.GIF|All files (*.*)|*.*'

default extension – This property will be used only if the user selected a filter which has no specific extension. If this parameter is not blank, this value will be automatically set as the file name extension if the user omits the extension.

overwrite prompt – Logical. Determines whether a warning message will be displayed if the user specifies a file name that already exists.

Returns:

An Alpha string that contains the full path of the selected file.

Examples:

ClientFileSaveDlg ('Save file', 'c:\temp\', 'All files (*.*)|*.*', '', 'FALSE'LOG)

Opens a File Save dialog box with default of C:\temp and the filter will show all files.

ClientFileSaveDlg ('Save file', 'c:\temp\', 'Image Files (*.BMP;*.JPG;*.GIF) | *.BMP;*.JPG;*.GIF|All files (*.*)|*.*', '', 'FALSE'LOG)

Opens a File Save dialog box with default of C:\temp and different filters.

ClientFileSaveDlg ('Save file', 'c:\temp\', 'All files (*.*)|*.*', 'txt', 'TRUE'LOG)

Opens a File Save dialog box with default of C:\temp and the filter will show all files. If no extension is written, 'TXT' will be returned as the extension. The file dialog box will prompt if the file already exists.

ClientFileSaveDlg ('Save file', 'c:\temp\abc.txt', 'All files (*.*)|*.*', '', 'FALSE'LOG)

Opens a File Save dialog box with default file name of abc.txt and default path of C:\temp, and the filter will show all files.

Note:

This is a client-side function that is only available for Rich Client tasks.

Platform specific:

This function is not currently supported for mobile devices.

See also:

The Rich Client Samples project (program REL16b)

Reference
Attachment 
Attachment