Accessing the Options settings via scripting

Return to Introduction  Previous page  Next page

 

FinalBuilder allows you to modify FinalBuilder options at runtime using scripting. This makes it possible to specify the path to a third party tool at runtime so that a FinalBuilder project can for example use a different version of a third party tool. Note that these modified settings are not saved and will be lost when you close FinalBuilder, unless you choose Tools -> Options and click OK before closing.

 

The options objects are accessible using the GetOptionsObject script function. This function takes the name of the options object as a parameter. The name is the same as appears in the Options dialog.  For example to access the Delphi options you would use this code (VBScript example) :

 

dim delphiOptions

set delphiOptions = GetOptionsObject("Borland Delphi")

delphiOptions.D6LibraryPath =delphiOptions.D6LibraryPath & ";$(DELPHI)\Components\Lib"

 

Listed below are the available properties on the IDE options objects.

 

FinalBuilder General Options

 

Name : General Options

 

  property PromptOnClose : boolean

  property PromptOnNew : boolean

  property DisplayPropDialog : boolean

  property SaveBeforeRun : Boolean

  property ShowTree : Boolean

  property AutoLoadLastProject : Boolean

  property PromptOnDeleteAction: boolean

  property AutoSizeListColumns : boolean

  property DisplayScriptErrors : Boolean

 

FinalBuilder Script Editor

 

Name : Script Editor

 

  property LineNumbers: boolean

  property DefaultScriptLanguage : String

  property AutoSaveScripts : boolean

 

FinalBuilder Logging Options

 

Name : Logging

 

  property LogHistoryCount : integer

  property IncludeActionOutput : boolean

  property OnlyIncludeErrorAction : boolean

  property ConfirmDeleteRunLog : boolean

  property ConfirmDeleteLogFile : boolean

 

 

Properties of Option objects for other option objects are available through the script editor automatic code completion (like Intellisense).