Core Function FileOpenDialog - 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:27Z

Return Value

← Older revision		Revision as of 01:09, 10 October 2013
Line 40:		Line 40:
	Success: Returns all the chosen files as an array.		Success: Returns all the chosen files as an array.

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

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

UberFoX at 18:27, 8 December 2011

2011-12-08T18:27:33Z

← 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: /* Example */

2011-12-08T18:25:53Z

Example

← Older revision		Revision as of 18:25, 8 December 2011
Line 61:		Line 61:
	Else		Else
	{		{
		+	foreach($var as $i)
		+	{
		+	println("Item '$i'");
		+	}
	$var = Join($var, @CRLF);		$var = Join($var, @CRLF);
	MsgBox("You chose $var");		MsgBox("You chose $var");

UberFoX at 18:24, 8 December 2011

2011-12-08T18:24:12Z

← Older revision		Revision as of 18:24, 8 December 2011
Line 26:		Line 26:
	<pre>		<pre>
	[optional] Dialog Options: To use more than one option, use a + sign to separate them (eg: 1 + 4).		[optional] Dialog Options: To use more than one option, use a + sign to separate them (eg: 1 + 4).
−	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 = Allow MultiSelect -- Default FALSE
−	8 = Automatically adds an extension to a file name if the user omits the extension	+	8 = Automatically adds an extension to a file name if the user omits the extension -- Default FALSE
	</pre>		</pre>

Line 38:		Line 38:
	=== Return Value ===		=== Return Value ===

−	Success: Returns the ~~full path of the file(s)~~ chosen. ~~Results for multiple selections are "Directory\|file1\|file2\|..."~~	+	Success: Returns all the chosen files as an array.

	Failure: Returns empty string.		Failure: Returns empty string.
Line 45:		Line 45:

	Separate the file filters with a semicolon as shown in the example.		Separate the file filters with a semicolon as shown in the example.
−
−	~~Note: At this time, multiple groups of filters are not supported.~~

	If default name is given, options must also be given. If none of the options are wanted, use 0 for options.		If default name is given, options must also be given. If none of the options are wanted, use 0 for options.
Line 55:		Line 53:

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
−	~~$message = "Hold down Ctrl or Shift to choose multiple files.";~~	+	$var = FileOpenDialog($message, @WinDir, "Image Files\|.bmp;.png", 4 + 1 );
−		+
−	$var = FileOpenDialog($message, @WinDir, "~~Images (~~.~~jpg~~;.~~bmp)~~", 1 ~~+ 4~~ );	+
−		+
	If (!$var)		If (!$var)
	{		{
Line 65:		Line 61:
	Else		Else
	{		{
−	$var = ~~Replace~~($var~~, "\|"~~, @CRLF);	+	$var = Join($var, @CRLF);
	MsgBox("You chose $var");		MsgBox("You chose $var");
	}		}

UberFoX: /* options */

2011-12-08T18:21:09Z

options

← Older revision		Revision as of 18:21, 8 December 2011
Line 29:		Line 29:
	2 = Path Must Exist (if user types a path)		2 = Path Must Exist (if user types a path)
	4 = Allow MultiSelect		4 = Allow MultiSelect
−	8 = ~~Prompt~~ to ~~Create New File (~~if ~~does not exist)~~	+	8 = Automatically adds an extension to a file name if the user omits the extension
−	~~16 = Prompt to OverWrite File (see FileSaveDialog)~~	+
	</pre>		</pre>

Alexpja: /* options */

2011-11-28T12:44:48Z

options

← Older revision		Revision as of 12:44, 28 November 2011
Line 25:		Line 25:
	Optional;		Optional;
	<pre>		<pre>
−	[optional] Dialog Options: To use more than one option, ~~add the required values together~~.	+	[optional] Dialog Options: To use more than one option, use a + sign to separate them (eg: 1 + 4).
	1 = File Must Exist (if user types a filename)		1 = File Must Exist (if user types a filename)
	2 = Path Must Exist (if user types a path)		2 = Path Must Exist (if user types a path)

UberFoX: Created page with "

 FileOpenDialog ( , <dir>, <filter>, <options>, <default name> ) </pre>  === Description ===  Initiates a Load File Dialog.  === Parameters ===  ==== title ====  Titl..."</h1>
<p>2011-11-28T06:12:05Z</p>
<p>Created page with "<pre> FileOpenDialog ( <title>, <dir>, <filter>, <options>, <default name> ) </pre>  === Description ===  Initiates a Load File Dialog.  === Parameters ===  ==== title ====  Titl..."</p>
<p><b>New page</b></p><div><pre><br />
FileOpenDialog ( <title>, <dir>, <filter>, <options>, <default name> )<br />
</pre><br />
<br />
=== Description ===<br />
<br />
Initiates a Load 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 />
[optional] Dialog Options: To use more than one option, add the required values together.<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 (see FileSaveDialog)<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(s) chosen. Results for multiple selections are "Directory|file1|file2|..."<br />
<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 />
$message = "Hold down Ctrl or Shift to choose multiple files.";<br />
<br />
$var = FileOpenDialog($message, @WinDir, "Images (*.jpg;*.bmp)", 1 + 4 );<br />
<br />
If (!$var)<br />
{<br />
    MsgBox("No File(s) chosen");<br />
}<br />
Else<br />
{<br />
    $var = Replace($var, "|", @CRLF);<br />
    MsgBox("You chose $var");<br />
}<br />
</syntaxhighlight><br />
<br />
[[Category:Core Function]]</div>
</article>
</main></body></html>