Core Function FileSaveDialog - Revision history

UberFoX: 1 revision

2015-06-14T12:38:32Z

1 revision

← Older revision

Revision as of 12:38, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:40:35Z

1 revision

← Older revision

Revision as of 21:40, 11 August 2014

UberFoX: /* Return Value */

2013-10-10T01:09:14Z

Return Value

← Older revision		Revision as of 01:09, 10 October 2013
Line 39:		Line 39:
	Success: Returns the file name.		Success: Returns the file name.

−	Failure: Returns ~~empty string~~.	+	Failure: Returns null if user cancelled.

	=== Remarks ===		=== Remarks ===

UberFoX at 18:33, 8 December 2011

2011-12-08T18:33:14Z

← Older revision		Revision as of 18:33, 8 December 2011
Line 37:		Line 37:
	=== Return Value ===		=== Return Value ===

−	Success: Returns ~~the full path of~~ the file ~~chosen~~. ~~Results for multiple selections are "Directory\|file1\|file2\|..."~~	+	Success: Returns the file name.

	Failure: Returns empty string.		Failure: Returns empty string.
Line 54:		Line 54:

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
−	$var = FileSaveDialog( "Choose a name.", @CurDir, "Scripts (*.spk)", 3);	+	$var = FileSaveDialog( "Choose a name.", @CurDir, "Scripts\|.spk;.s", 8 + 4);
	// option 3 = dialog remains until valid path/file selected		// option 3 = dialog remains until valid path/file selected

UberFoX: /* options */

2011-12-08T18:30:49Z

options

← Older revision		Revision as of 18:30, 8 December 2011
Line 25:		Line 25:
	Optional;		Optional;
	<pre>		<pre>
−	1 = File Must Exist (if user types a filename)	+	1 = File Must Exist (if user types a filename) -- Default FALSE
−	2 = Path Must Exist (if user types a path)	+	2 = Path Must Exist (if user types a path) -- Default FALSE
−	4 = ~~Allow MultiSelect~~	+	4 = Automatically adds an extension to a file name if the user omits the extension -- Default FALSE
−	8 = Prompt to ~~Create New File (if does not exist)~~	+	8 = Prompt to overwrite -- Default FALSE
−	~~16 = Prompt to OverWrite File~~	+
	</pre>		</pre>

UberFoX at 18:27, 8 December 2011

2011-12-08T18:27:46Z

← Older revision		Revision as of 18:27, 8 December 2011
Line 19:		Line 19:
	==== filter ====		==== filter ====

−	File type filter such as "All (.)" or "Text files (*.txt)"	+	File type filter such as "All\|." or "Text files\|*.txt"

	==== options ====		==== options ====

UberFoX: /* Return Value */

2011-11-28T06:09:24Z

Return Value

← Older revision		Revision as of 06:09, 28 November 2011
Line 39:		Line 39:

	Success: Returns the full path of the file chosen. Results for multiple selections are "Directory\|file1\|file2\|..."		Success: Returns the full path of the file chosen. Results for multiple selections are "Directory\|file1\|file2\|..."
−	Failure: Returns empty string.	+
		+	Failure: Returns empty string.

	=== Remarks ===		=== Remarks ===

UberFoX: Created page with "

 FileSaveDialog ( , <dir>, <filter>, <options>, <default name> ) </pre>  === Description ===  Initiates a Save File Dialog.  === Parameters ===  ==== title ====  Titl..."</h1>
<p>2011-11-28T06:08:17Z</p>
<p>Created page with "<pre> FileSaveDialog ( <title>, <dir>, <filter>, <options>, <default name> ) </pre>  === Description ===  Initiates a Save File Dialog.  === Parameters ===  ==== title ====  Titl..."</p>
<p><b>New page</b></p><div><pre><br />
FileSaveDialog ( <title>, <dir>, <filter>, <options>, <default name> )<br />
</pre><br />
<br />
=== Description ===<br />
<br />
Initiates a Save File Dialog.<br />
<br />
=== Parameters ===<br />
<br />
==== title ====<br />
<br />
Title text of the Dialog GUI.<br />
<br />
==== dir ====<br />
<br />
Initial directory selected in the GUI file tree.<br />
<br />
==== filter ====<br />
<br />
File type filter such as "All (*.*)" or "Text files (*.txt)"<br />
<br />
==== options ====<br />
<br />
Optional;<br />
<pre><br />
  1 = File Must Exist (if user types a filename)<br />
  2 = Path Must Exist (if user types a path)<br />
  4 = Allow MultiSelect<br />
  8 = Prompt to Create New File (if does not exist)<br />
 16 = Prompt to OverWrite File<br />
</pre><br />
<br />
==== default name ====<br />
<br />
Optional; File name to suggest to the user to save the file with.<br />
<br />
=== Return Value ===<br />
<br />
Success: Returns the full path of the file chosen. Results for multiple selections are "Directory|file1|file2|..." <br />
Failure: Returns empty string. <br />
<br />
=== Remarks ===<br />
<br />
Separate the file filters with a semicolon as shown in the example.<br />
<br />
Note: At this time, multiple groups of filters are not supported.<br />
<br />
If default name is given, options must also be given. If none of the options are wanted, use 0 for options.<br />
<br />
Special Windows folders (such as "My Documents") can be sometimes be set as the init dir.<br />
<br />
=== Example ===<br />
<br />
<syntaxhighlight lang="sputnik"><br />
$var = FileSaveDialog( "Choose a name.", @CurDir, "Scripts (*.spk)", 3);<br />
// option 3 = dialog remains until valid path/file selected<br />
<br />
If (!$var)<br />
{<br />
    MsgBox("Save cancelled.");<br />
}<br />
Else<br />
{<br />
    MsgBox("You chose " . $var);<br />
}<br />
</syntaxhighlight><br />
<br />
[[Category:Core Function]]</div>
</article>
</main></body></html>