OPENFILEDIALOG$: Difference between revisions

From QB64 Phoenix Edition Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:_OPENFILEDIALOG$}}
{{DISPLAYTITLE:_OPENFILEDIALOG$}}
The '''_OPENFILEDIALOG$''' function displays a standard dialog box that prompts the user to open a file. The returned string is an empty string ('''""''') if the user cancelled. The returned string will contain file paths delimited using '''"|"''' if allowMultipleSelects& is passed as '''-1''' (true) and multiple files are selected by the user.
The '''_OPENFILEDIALOG$''' function displays a standard dialog box that prompts the user to open a file. The returned string is an empty string ('''""''') if the user cancelled. The returned string will contain file paths delimited using '''"|"''' if allowMultipleSelects& is passed as ''true(-1)'' and multiple files are selected by the user.




{{PageSyntax}}
{{PageSyntax}}
:{{Parameter|result$}} = [[_OPENFILEDIALOG$]]({{Parameter|title$}}, {{Parameter|defaultPathAndFile$}}, {{parameter|filterPatterns$}}, {{Parameter|singleFilterDescription$}}[, {{Parameter|allowMultipleSelects&}}])
:{{Parameter|result$}} = [[_OPENFILEDIALOG$]]([{{Parameter|title$}}][, {{Parameter|defaultPathAndFile$}}][, {{parameter|filterPatterns$}}][, {{Parameter|singleFilterDescription$}}][, {{Parameter|allowMultipleSelects&}}])




Line 12: Line 12:
* {{parameter|filterPatterns$}} are the file filters separated using '''"|"''' (e.g., "*.png|*.jpg|*.gif")
* {{parameter|filterPatterns$}} are the file filters separated using '''"|"''' (e.g., "*.png|*.jpg|*.gif")
* {{Parameter|singleFilterDescription$}} is the single filter description (e.g., "Image files")
* {{Parameter|singleFilterDescription$}} is the single filter description (e.g., "Image files")
* {{Parameter|allowMultipleSelects&}} can be '''0''' (false) or '''-1''' (true) if multiple file selection is to be allowed. If omitted, then this defaults to '''0''' (false)
* {{Parameter|allowMultipleSelects&}} can be ''false(0)'' or ''true(-1)'' if multiple file selection is to be allowed. If omitted, then this defaults to ''false(0)''





Latest revision as of 00:35, 18 November 2024

The _OPENFILEDIALOG$ function displays a standard dialog box that prompts the user to open a file. The returned string is an empty string ("") if the user cancelled. The returned string will contain file paths delimited using "|" if allowMultipleSelects& is passed as true(-1) and multiple files are selected by the user.


Syntax

result$ = _OPENFILEDIALOG$([title$][, defaultPathAndFile$][, filterPatterns$][, singleFilterDescription$][, allowMultipleSelects&])


Parameters

  • title$ is the dialog box title
  • defaultPathAndFile$ is the default path that will be used by the dialog box if not changed by the user
  • filterPatterns$ are the file filters separated using "|" (e.g., "*.png|*.jpg|*.gif")
  • singleFilterDescription$ is the single filter description (e.g., "Image files")
  • allowMultipleSelects& can be false(0) or true(-1) if multiple file selection is to be allowed. If omitted, then this defaults to false(0)


Description

  • All parameters accept an empty string ("") in which case system defaults are used
  • If singleFilterDescription$ is an empty string (""), then filterPatterns$ will be shown in it's place
  • The dialog box automatically becomes a modal window if the application window is visible


Availability

  • QB64-PE v3.4.0 and up


Examples

Example
Simple open file dialog example
audiofiles$ = _OPENFILEDIALOG$("Open File", "", "*.mp3|*.ogg|*.wav|*.flac", "Audio files", -1)
IF audiofiles$ <> "" THEN _MESSAGEBOX "Information", "You selected " + audiofiles$


See also



Navigation:
Main Page with Articles and Tutorials
Keyword Reference - Alphabetical
Keyword Reference - By usage
Report a broken link