<< Click to Display Table of Contents >> Options (object)

Access path: Application à Options

 1  Description

The Options object consolidates many global program settings, most of which can be found in the dialog box of the ribbon command File | Options in PlanMaker.

 2  Access to the object

There is exactly one instance of the Options object during the whole runtime of PlanMaker. It is accessed through Application.Options:

Set pm = CreateObject("PlanMaker.Application")

pm.Application.Options.EnableSound = True

 3  Properties, objects, collections and methods

Properties:

▪CheckSpellingAsYouType

▪CreateBackup

▪DefaultFilePath

▪DefaultTemplatePath

▪EnableSound

▪Overtype

▪SaveInterval

▪SavePropertiesPrompt

▪DefaultFileFormat

 

Objects:

▪Application → Application

▪Parent → Application (default object)

CheckSpellingAsYouType (property)

Data type: Boolean

Gets or sets the setting "Background spell-checking" (True or False).

CreateBackup (property)

Data type: Boolean

Gets or sets the setting "Create backup files" (True or False).

DefaultFilePath (property)

Data type: String

Gets or sets the file path used by default to save and open documents.

This is just a temporary setting: When you execute the ribbon commands File | Open or File | Save as the next time, the path chosen here will appear in the dialog box. If the user changes the path, this path will then be the new default file path.

DefaultTemplatePath (property)

Data type: String

Gets or sets the file path used by default to store document templates.

This setting is saved permanently. Each call to the ribbon command File | New lets you see the document templates in the path given here.

EnableSound (property)

Data type: Boolean

Gets or sets the setting "Beep on errors" (True or False).

Overtype (property)

Data type: Boolean

Gets or sets Overwrite/Insert mode (True=Overwrite, False=Insert).

SaveInterval (property)

Data type: Long

Gets or sets the setting "Autosave documents every n minutes" (0=off).

SavePropertiesPrompt (property)

Data type: Boolean

Gets or sets the setting "Prompt for summary information when saving" (True or False).

DefaultFileFormat (property)

Data type: Long (PmDefaultFileFormat)

Gets or sets the standard file format in which PlanMaker saves newly created documents. Possible values:

pmDefaultFileFormatPlanMaker      = 0 ' PlanMaker (.pmdx)

pmDefaultFileFormatExcelXP        = 1 ' Microsoft Excel XP/2003 (.xls)

pmDefaultFileFormatOpenXML        = 3 ' Microsoft Office Open XML (.xlsx)

pmDefaultFileFormatPlanMaker2012  = 4 ' PlanMaker 2012 (.pmd)

Application (pointer to object)

Data type: Object

Returns the Application object.

Parent (pointer to object)

Data type: Object

Returns the parent object, i.e. Application.