Clarion Community Help

FILEDIALOG( [title] ,file [,extensions] [,flag] )

The FILEDIALOG procedure displays Windows standard file choice dialogs and returns the file chosen by the user in the file parameter. Any existing value in the file parameter sets the default file choice presented to the user in the file choice dialog.

FILEDIALOG displays either the standard Open… dialog or the standard Save… dialog. By default, on the Open… dialog, the user is warned if the file they choose does not exist and the file is not opened. On the Save… dialog, the user is warned if the file does exist and the file is not saved.

The extensions parameter string must contain a description followed by the file mask. All elements in the string must be delimited by the vertical bar (|) character. For example, the extensions string:

'All Files | *.* | Clarion Source | *.CLW;*.INC;*.EQU;*.INT | Clarion Templates|*.TPL;*.TPW'

defines three selections for the “List Files of Type” drop list. The first extension listed in the extensions string is the default. Multiple extensions are separated by a semicolon (;) character.

The flag parameter is a bitmap that indicates the type of file action to perform (see EQUATES.CLW for symbolic constants). For bit number:

The following is a comprehensive sample of these flags simplified to equates (see EQUATES.CLW for the complete list):

FILEDIALOG returns zero (0) if the user pressed the Cancel button, or one (1) if the user pressed the Ok button on the file choice dialog. If the user changes directories using the file dialog, your application's current directory also changes (unless you set FILE:KeepDir). This is a feature of the Windows operating system. If you do not want users to change your application's current directory but do want them to be able look in other directories, either save the current directory with the PATH() procedure before calling FILEDIALOG then restore it with the SETPATH() statement, or set FILE:KeepDir.

Example:

ViewTextFile PROCEDURE
ViewQue QUEUE                   !LIST control display queue
        STRING(255)
       END
 
FileName   STRING(64),STATIC    !Filename variable
 
ViewFile  FILE,DRIVER('ASCII'),NAME(FileName),PRE(Vew)
Record     RECORD
           STRING(255)
          END
         END
 
MDIChild1 WINDOW('View Text File'),AT(0,0,320,200),MDI,SYSTEM,HVSCROLL
          LIST,AT(0,0,320,200),USE(?L1),FROM(ViewQue),HVSCROLL
         END
 
CODE
IF NOT FILEDIALOG('Choose File to View',FileName,'Text|*.TXT|Source|*.CLW',FILE:LongName)
 RETURN                        !Return if no file chosen
END
OPEN(ViewFile)                 !Open the file
IF ERRORCODE() THEN RETURN END!aborting on any error
SET(ViewFile)                  !Start at top of file
LOOP
 NEXT(ViewFile)                !Reading each line of text
 IF ERRORCODE() THEN BREAK END !Break loop at end of file
 ViewQue = Vew:Record          !Assign text to queue
 ADD(ViewQue)                  !and add a queue entry
END
CLOSE(ViewFile)                !Close the file
OPEN(MDIChild1)                !and open the window
ACCEPT                         !Allow the user to read the text and
END                            !break out of ACCEPT loop only from
                               !system menu close option
FREE(ViewQue)                  !Free the queue memory
RETURN                         !and return to caller
 
!************************************************************
!This example shows using FILEDIALOG for multi-file selection:
 
SelectFiles   PROCEDURE(SelectFileQueue DFQ)
 
Found       CSTRING(10000),AUTO
Path        CSTRING(File:MaxFilePath),AUTO
Separator   STRING(1),AUTO
Pos         UNSIGNED,AUTO
NameStart   UNSIGNED,AUTO
 
 CODE
 Found=SELF.DefaultFile
 IF FILEDIALOG('Pick 1 or more files',Found, |
 'All Files | *.* | Clarion Source | *.CLW;*.INC;*.EQU;*.INT|Clarion Templates|*.TPL;*.TPW',|
  FILE:KeepDir+FILE:Multi+FILE:LongName)
   Separator='|'
   Pos=INSTRING(Separator,Found,1,1)
   IF Pos                                 !Multi-Selected files
     ASSERT(Pos > 1)
     Path = CHOOSE(Found[Pos-1] <> '\', Found[1 : Pos-1]&'\', Found[1 : Pos-1])
     LOOP
       NameStart = Pos+1
       Pos = INSTRING(Separator,Found,1,NameStart)
       IF ~Pos THEN Pos=LEN(Found)+1.
       DFQ.Name = Path&Found[NameStart : Pos-1]
       ADD(DFQ)
     WHILE Pos<=LEN(Found)
   ELSE
     DFQ.Name=Found                                !Single file only selected
     ADD(DFQ)
   END
 END
 
!************************************************************
!This example shows using FILEDIALOG for multi-file selection:
 
FILEDIALOG('Test', FileName, 'Text files|*.txt|All files|*.*', |
           FILE:LongName + FILE:NoError + FILE:AddExtension)
 
!If the user types AAA and pressed the Open button, the returned file
!name is '<current directory>\AAA.txt'; if the user typed "AAA",
!result is '<current directory>\AAA'

See Also:

FILEDIALOGA

SETPATH

SHORTPATH

LONGPATH

DIRECTORY

GETFONT

SETFONT

PROP:FontDialogHook