Documentation/DevGuide/Basic/Variable Scopes

OpenOffice Developer's Guide

OpenOffice Basic

< Previous Section

Next Section >

• First Steps with OpenOffice Basic

• Creating a Module in a Standard Library
• Writing and Debugging a Basic UNO program
• Calling a Sub from the User Interface
• Creating Dialogs
• Adding Event Handlers
• AutoPilot Dialogs

• OpenOffice Basic IDE

• Managing Basic and Dialog Libraries

• OpenOffice Basic Macros Dialog

• Displayed Information
• Buttons

• OpenOffice Basic Macro Organizer Dialog

• Modules
• Dialogs
• Libraries

• Basic IDE Window

• Basic Source Editor and Debugger
• Dialog Editor

• Assigning Macros to GUI Events
• Dialog Localization

• Technical Background

• Features of OpenOffice Basic

• Functional Range Overview

• Screen I/O Functions
• File I/O
• Date and Time Functions
• Numeric Functions
• String Functions
• Specific UNO Functions

• Accessing the UNO API
• Special Behavior of OpenOffice Basic

• Advanced Library Organization

• General Structure
• Accessing Libraries from Basic
• Variable Scopes

• Programming Dialogs and Dialog Controls

• Dialog Handling

• Showing a Dialog
• Getting the Dialog Model
• Dialog as Control Container
• Dialog Properties
• Common Properties
• Multi-Page Dialogs

• Dialog Controls

• Command Button
• Image Control
• Check Box
• Option Button
• Label Field
• Text Field
• List Box
• Combo Box
• Horizontal/Vertical Scroll Bar
• Group Box
• Progress Bar
• Horizontal/Vertical Line
• Date Field
• Time Field
• Numeric Field
• Currency Field
• Formatted Field
• Pattern Field
• File Control

• Creating Dialogs at Runtime
• Library File Structure

• Application Library Container
• Document Library Container

• Library Deployment

< Previous Page

Next Page >

Some aspects of scoping in Basic depend on the library structure. This section describes which variables declared in a Basic source code module are seen from what libraries or modules. Generally, only variables declared outside Subs are affected by this issue. Variables declared inside Subs are local to the Sub and not accessible from outside of the Sub. For example:

  Option Explicit      ' Forces declaration of variables
  
  Sub Main
      Dim a%
      a% = 42          ' Ok
      NotMain()
  End Sub
  
  Sub NotMain
      a% = 42          ' Runtime Error "Variable not defined"
  End Sub

Variables can also be declared outside of Subs. Then their scope includes at least the module they are declared in. To declare variables outside the Subs, the commands Private, Public/Dim and Global are used.

The Private command is used to declare variables that can only be used locally in a module. If the same variable is declared as Private in two different modules, they are used independently in each module. For example:

Library Standard, Module1:

  Private x As Double
   
  Sub Main
      x = 47.11        ' Initialize x of Module1
      Module2_InitX    ' Initialize x of Module2
      
      MsgBox x         ' Displays the x of Module1
      Module2_ShowX    ' Displays the x of Module2
  End Sub

Library Standard, Module2:

  Private x As Double
  
  Sub Module2_InitX
      x = 47.12        ' Initialize x of Module2
  End Sub
  
  Sub Module2_ShowX
      MsgBox x         ' Displays the x of Module2
  End Sub

When Main in Module1 is executed, 47.11 is displayed (x of Module1) and then 47.12 (x of Module2).

The Public and Dim commands declare variables that can also be accessed from outside the module. They are identical in this context. Variables declared with Public and Dim can be accessed from all modules that belong to the same library container. For example, based on the library structure shown in Illustration 12.39: Sample module structure, any variable declared with Public and Dim in the Application Basic Modules Standard/Module1, Standard/Module2, Library1/Module1, Library1/Module2 can also be accessed from all of these modules, therefore the library container represents the logical root scope.

The names of the Basic modules (by default Module1, Module2, etc) are known by Basic on a public scope. You must avoid to have a variable or routine of public scope with the same name as one of the modules of the library. Example : Suppose that in your Basic library you have a module named PrintDoc. You must not declare, in any module of your library, a Public variable or a Public constant, or a Sub, or a Function, named PrintDoc. If you do have such collision, Basic may produce strange runtime error messages, or your Sub may not work.

Content on this page is licensed under the Public Documentation License (PDL).