OpenOffice.org BASIC Guide - OpenOffice.org wiki

More documents

Recommendations

Info

Scope Other Instructions As shown in the example below, the Type definition may be written at the start of a module (before the first Sub or Function). The definition will then be available to all routines in the module. As of OpenOffice.org Version 3.0, unlike variables, there is no way to make the definition accessible outside of the module. An instance of the new type is a variable, and follows the usual rules for variable scope (see Scope and Life Span of Variables). An example of how to use the definition, and how to reference the fields within an instance, appears in the section on With...End With. With...End With Qualifiers In general, Basic does not look inside a container, such as an Object, to see what names might be defined there. If you want to use such a name, you must tell Basic where to look. You do that by using the name of the object as a qualifier. Write it before the inner name, and separate it by a period: MyObject.SomeName Since containers may hold other containers, you may need more than one qualifier. Write the qualifiers in order, from outer to inner: OuterObject.InnerObject.FarInsideObject.SomeName These names may also be described as, "concatenated with the dot-operator ('.')". The With Alternative The With...End With bracketing statements provide an alternative to writing out all the qualifiers, every time - and some of the qualifiers in the API can be quite long. You specify the qualifiers in the With statement. Until Basic encounters the End With statement, it looks for partly-qualified names: names that begin with a period (unary dot-operator). The compiler uses the qualifiers from the With as though they were written in front of the partly-qualified name. Example 1: A User-defined Struct This example shows how you may define and use a struct, and how to reference the items within it, both with and without With. Either way, the names of the data fields (from the Type definition) must be qualified by the name of the instance (from the Dim statement). Type aMenuItem aCommand as String aText as String End Type Sub Main 'Create an instance of the user-defined struct. ' Note the keyword, "New". Dim maItem as New aMenuItem With maItem .aCommand = ".uno:Copy" .aText = "~Copy" End With MsgBox "Command: " & maItem.aCommand & Chr(13) _ Chapter 2 · The Language of OpenOffice.org BASIC 33
Other Instructions End Sub & "Text: " & maItem.aText Example 2: Case statement In Cells and Ranges, the following example has the qualifiers in the Case statements written out completely, for clarity. You can write it more easily, this way: Dim Doc As Object Dim Sheet As Object Dim Cell As Object Doc = ThisComponent Sheet = Doc.Sheets(0) Cell = Sheet.getCellByPosition(1,1) 'Cell "B2" (0-based!) Cell.Value = 1000 With com.sun.star.table.CellContentType Select Case Cell.Type Case .EMPTY MsgBox "Content: Empty" Case .VALUE MsgBox "Content: Value" Case .TEXT MsgBox "Content: Text" Case .FORMULA MsgBox "Content: Formula" End Select End With Notice that the With construct must be entirely outside of the Select construct. 34 OpenOffice.org 3.2 BASIC Guide · March 2010
Page 1 and 2: OpenOffice.org 3.2 BASIC Guide
Page 3 and 4: 3 1 2 3 4 Contents Copyright.......
Page 5 and 6: Preface This guide provides an intr
Page 7 and 8: About OpenOffice.org Basic and allo
Page 9 and 10: Overview of a Basic Program In addi
Page 11 and 12: Working With Variables example, in
Page 13 and 14: Numbers with long integer variables
Page 15 and 16: Numbers return incorrect values. Th
Page 17 and 18: Arrays Dim MyInteger(3) creates 4 i
Page 19 and 20: Scope and Life Span of Variables Sc
Page 21 and 22: Constants Const A = 10 You can also
Page 23 and 24: Branching B = 0 End If In this exam
Page 25 and 26: Loops use an explicit counter like
Page 27 and 28: Procedures and Functions ' ... here
Page 29 and 30: Procedures and Functions The exampl
Page 31: Error Handling The following code i
Page 35 and 36: Conversion Functions calculates the
Page 37 and 38: Conversion Functions IsBoolean = Fa
Page 39 and 40: Strings Formatting Strings The Form
Page 41 and 42: Date and Time The Weekday function
Page 43 and 44: Files and Directories Note - VBA :
Page 45 and 46: Files and Directories The FreeFile
Page 47 and 48: Message and Input Boxes Display of
Page 49 and 50: Other Functions specifies the same
Page 51 and 52: Universal Network Objects (UNO) com
Page 53 and 54: Tools for Working with UNO The foll
Page 55 and 56: Overview of Central Interfaces basi
Page 57 and 58: 5 C H A P T E R 5 5 Working with
Page 59 and 60: XML File Format The StarDesktop Ope
Page 61 and 62: The StarDesktop The FileProperties
Page 63 and 64: The options of the print method The
Page 65 and 66: Doc = ThisComponent StyleFamilies =
Page 67 and 68: 6 C H A P T E R 6 6 Text Documen
Page 69 and 70: described in Search and Replace. Th
Page 71 and 72: Paragraph Properties The Structure
Page 73 and 74: If TextElement.supportsService("com
Page 75 and 76: isEndOfSentence () returns True if
Page 77 and 78: Doc.Text.insertControlCharacter(Cur
Page 79 and 80: Dim Replace As Object Dim BritishWo
Page 81 and 82: More Than Just Text Note - Text tab
Page 83 and 84:
Doc.Text.insertTextContent(Cursor,
Page 85 and 86:
frame objects are set to the starti
Page 87 and 88:
The following example shows how the
Page 89 and 90:
7 C H A P T E R 7 7 Spreadsheet
Page 91 and 92:
The same interface provides methods
Page 93 and 94:
Cell = Sheet.getCellByPosition(0, 0
Page 95 and 96:
StartColumn (long) first column in
Page 97 and 98:
You can apply all of the named prop
Page 99 and 100:
NumberFormatId = NumberFormats.addN
Page 101 and 102:
ShadowFormat (struct) The Structure
Page 103 and 104:
FooterBottomBorderDistance (long) d
Page 105 and 106:
Definition of Elements to be Printe
Page 107 and 108:
VARP variance based on the total po
Page 109 and 110:
8 C H A P T E R 8 8 Drawings and
Page 111 and 112:
Doc = ThisComponent Page = Doc.Draw
Page 113 and 114:
RectangleShape.Position = Point Rec
Page 115 and 116:
The lines are dark gray (Color) and
Page 117 and 118:
service. Dim Doc As Object Dim Page
Page 119 and 120:
An Overview of Various Drawing Obje
Page 121 and 122:
Page.add(LineShape) Polypolygon Sha
Page 123 and 124:
AdjustBlue (Short) blue value as a
Page 125 and 126:
Point.x = 1000 Point.y = 1000 Size.
Page 127 and 128:
Pause (long) the amount of time tha
Page 129 and 130:
Using Charts in Spreadsheets The pr
Page 131 and 132:
The Structure of Charts com.sun.sta
Page 133 and 134:
The Structure of Charts Min (Double
Page 135 and 136:
The Structure of Charts HasZAxisGri
Page 137 and 138:
The Structure of Charts The followi
Page 139 and 140:
10 C H A P T E R 1 0 10 Database
Page 141 and 142:
User (String) user name Password (S
Page 143 and 144:
Dim Statement As Object Dim ResultS
Page 145 and 146:
FORWARD_ONLY ResultSet only permits
Page 147 and 148:
11 C H A P T E R 1 1 11 Dialogs
Page 149 and 150:
Closing With the Close Button in th
Page 151 and 152:
Multi-Page Dialogs Properties A dia
Page 153 and 154:
Control element-specific events: Ev
Page 155 and 156:
Buttons (short) X (long) Y (long) b
Page 157 and 158:
Temporary (Boolean) the focus is te
Page 159 and 160:
Model.Label (String) label that is
Page 161 and 162:
Model.HScroll (Boolean) the text ha
Page 163 and 164:
12 C H A P T E R 1 2 12 Forms In
Page 165 and 166:
Accessing the View of Control Eleme
Page 167 and 168:
Tag (String) Control Element Forms
Page 169 and 170:
Enabled (Boolean) the control eleme
Page 171 and 172:
LineCount (Short) number of lines o
show all

OpenOffice.org BASIC Guide - OpenOffice.org wiki

Create successful ePaper yourself

Delete template?

Save as template?