File Examples

The File object is a good way to store and retrieve text and image files to device storage.

Use the image below to refer to the form controls in the expressions for Examples 1-4.

Example 1: Opening a text file and displaying it on an edit control.

// Check if user entered a file name.

IF efTextFileName <> ""

{

    //Check if file exists.

    VarFileExist = File.FileExists(efTextFileName)

    IF VarFileExist == true

    {

        //Load file.

        efTextFile = File.LoadText(efTextFileName)

        efTextFileName = ""

        VarOpenedFile = efTextFile

    }

    ELSE

    {

        //Display error message if file does not exists.

        Variable1 = "File does not exist " & efTextFileName

        Form.MessageBox("Error", Variable1, MB_OK)

        efTextFileName = ""

    }

}

ELSE

{

    //If no file name entered, prompt user to select file.

    Variable1 = Form.ShowFileOpenDialog()

    efTextFile = File.LoadText(Variable1)

}

VarOpenFileName = Variable1

Form.Title = Variable1

btClose.Enable()

Note:

Example 2: Saving the value of the edit control to a file.

IF VarOpenFileName <> "New File"

{

    File.SaveText(VarOpenFileName, efTextFile)

}

ELSE

{

    IF efTextFileName <> ""

    {

        File.SaveText(efTextFileName, efTextFile)

        VarOpenFileName = efTextFileName

    }

    ELSE

    {

        IF efTextFile == ""

        {

            EXIT

        }

        ELSE

        {

            Variable1 = Form.ShowFileSaveDialog()

            File.SaveText(Variable1, efTextFile)

            VarOpenFileName = Variable1

        }

    }

    efTextFileName = ""

}

Form.Title = VarOpenFileName

Note:

Example 3: Renaming an opened file.

// If its a new file, renaming not possible.

IF VarOpenFileName == "New File"

{

    EXIT

}

// Prompt users for the new file name.

Variable1 = Form.ShowFileSaveDialog()

// Rename open file with the new file name.

VarBlnResult = File.RenameFile(VarOpenFileName, Variable1)

// Check if operation was successfull. Change the Form title accordingly.

IF VarBlnResult

{

    VarOpenFileName = Variable1

    Form.Title = VarOpenFileName

}

ELSE

{

    Form.Title = VarOpenFileName

}

Note:

Example 4: Saving the form before closing the file.

IF VarOpenFileName <> "New File"

{

    // Load text file in a temporary variable for comparison.

    VarOpenedFile = File.LoadText(VarOpenFileName)

}

ELSE

{

    // Reset temporary variable to empty string if its a new file.

    VarOpenedFile = ""

}

// Check difference between opened text file and edit control-to allow for save.

IF efTextFile <> VarOpenedFile

{

    // Prompt users to save file.

    VarMBResult = Form.MessageBox("Save", "Do you want to save file?", MB_YESNO)

    IF IDYES == VarMBResult

    {

        IF VarOpenFileName == "New File"

        {

            // Prompt users for file name if its a new file.

            VarOpenFileName = Form.ShowFileSaveDialog()

            // Check if a file name was returned.

            IF VarOpenFileName == ""

            {

                VarOpenFileName = "New File"

                EXIT

            }

            ELSE

            {

                // Save is file name was entered by the user.

                File.SaveText(VarOpenFileName, efTextFile)

            }

        }

        ELSE

        {

            // Save if file already exists.

            File.SaveText(VarOpenFileName, efTextFile)

        }

    }

}

// intialise all controls

efTextFile = ""

efTextFileName = ""

VarOpenFileName = "New File"

Form.Title = VarOpenFileName

btClose.Disable()

Note:

Example 5. Loading a binary file to a image control.

// Prompt user for bitmap file.

Variable1 = Form.ShowFileOpenDialog()

// Load binary file to bitmap control.

image1 = File.LoadBinary(Variable1)

// Display file name in form title.

Form.Title = Variable1

Note:

Example 6. Saving a binary object to a file.

// Prompt user for destination file.

Variable1 = Form.ShowFileSaveDialog()

// Save contents of the image control to the file specified.

File.SaveBinary(Variable1, image1)

// reset bitmap control.

image1 = ""

Note:

Example 7. Copying a source file to a destination file.

// Prompt user for source file.

Variable1 = Form.ShowFileOpenDialog()

IF Variable1 == ""

{

    // If file name is empty, do nothing.

    EXIT

}

// Prompt user for destination file name.

Variable2 = Form.ShowFileSaveDialog()

IF Variable2 == ""

{

    // If file name is empty, do nothing.

    EXIT

}

// CopyFile(Source, Destination)

VarBlnResult = File.CopyFile(Variable1, Variable2)

// Check is file copy was successful.

IF VarBlnResult

{

    Form.MessageBox("Information", "File was copied successfully.", MB_OK)

}

Note:

Example 8. Deleting files.

// Check if user entered a file to delete.

IF efFileName <> ""

{

    // Check if file exists.

    VarFileExist = File.FileExists(efFileName)

    IF VarFileExist == true

    {

        // Delete file.

        File.DeleteFile(efFileName)

    }

    ELSE

    {

        // Display error message if file does not exists.

        Form.MessageBox("Error", "Nothing to delete: File does not exist.", MB_OK)

        efFileName = ""

    }

}

ELSE

{

    // Prompt user for file to delete.

    Variable1 = Form.ShowFileOpenDialog()

    // Delete file.

    File.DeleteFile(Variable1)

}

Note:

Example 9. Renaming of files.

Variable1 = Form.ShowFileOpenDialog()

Variable2 = Form.ShowFileSaveDialog()

File.RenameFile(Variable1, Variable2)

Note: