Showing a Dialog

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 >

After a dialog has been designed using the dialog editor, a developer wants to show the dialog from within the program code. The necessary steps are shown in the following example:

  Sub ShowDialog()
      Dim oLibContainer As Object, oLib As Object
      Dim oInputStreamProvider As Object
      Dim oDialog As Object
      Const sLibName = "Library1"
      Const sDialogName = "Dialog1"
      REM library container
      oLibContainer = DialogLibraries
      REM load the library
      oLibContainer.loadLibrary( sLibName )
      REM get library
      oLib = oLibContainer.getByName( sLibName )
      REM get input stream provider
      oInputStreamProvider = oLib.getByName( sDialogName )
      REM create dialog control
      oDialog = CreateUnoDialog( oInputStreamProvider )
      REM show the dialog
      oDialog.execute()
  End Sub

The dialog control is created by calling the runtime function CreateUnoDialog() which takes an object as parameter that supports the com.sun.star.io.XInputStreamProvider interface. This object provides an input stream that represents an XML description of the dialog. The section Advanced Library Organization explains the accessing to the object inside the library hierarchy. The dialog control is shown by calling the execute() method of the com.sun.star.awt.XDialog interface. It can be closed by calling endExecute(), or by offering a  Cancel  or  OK  button on the dialog. For additional information, see Programming Dialogs and Dialog Controls.

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