OpenOffice.org BASIC Guide - OpenOffice.org wiki

More documents

Recommendations

Info

1 C H A P T E R 1 1 OpenOffice.org BASIC Programming Guide This guide provides an introduction to programming with OpenOffice.org Basic. To get the most out of this book, you should be familiar with other programming languages. Extensive examples are provided to help you quickly develop your own OpenOffice.org Basic programs. This guide divides information about OpenOffice.org administration into several chapters. The first three chapters introduce you to OpenOffice.org Basic: The Language of OpenOffice.org Basic Runtime Library Introduction to the API These chapters provide an overview of OpenOffice.org Basic and should be read by anyone who intends to write OpenOffice.org Basic programs. The remaining chapters describe the individual components of the OpenOffice.org API in more detail and can be read selectively as required: Working with Documents Text Documents Spreadsheet Documents Drawings and Presentations Charts (Diagrams) Databases Dialogs Forms About OpenOffice.org Basic The OpenOffice.org Basic programming language has been developed especially for OpenOffice.org and is firmly integrated in the Office package. As the name suggests, OpenOffice.org Basic is a programming language from the Basic family. Anyone who has previously worked with other Basic languages — in particular with Visual Basic or Visual Basic for Applications (VBA) from Microsoft — will quickly become accustomed to OpenOffice.org Basic. Large sections of the basic constructs of OpenOffice.org Basic are compatible with Visual Basic. The OpenOffice.org Basic programming language can be divided into four components: The language of OpenOffice.org Basic: Defines the elementary linguistic constructs, for example, for variable declarations, loops, and functions. The runtime library: Provides standard functions which have no direct reference to OpenOffice.org, for example, functions for editing numbers, strings, date values, and files. The OpenOffice.org API (Application Programming Interface): Permits access to OpenOffice.org documents 7
About OpenOffice.org Basic and allows these to be created, saved, modified, and printed. The Dialog Editor: Creates personal dialog windows and provides scope for the adding of control elements and event handlers. Note – VBA : Compatibility between OpenOffice.org Basic and VBA relates to the OpenOffice.org Basic language as well as the runtime library. The OpenOffice.org API and the Dialog Editor are not compatible with VBA (standardizing these interfaces would have made many of the concepts provided in OpenOffice.org impossible). Intended Users of OpenOffice.org Basic The scope of application for OpenOffice.org Basic begins where the standard functions of OpenOffice.org end. Routine tasks can therefore be automated in OpenOffice.org Basic, links can be made to other programs — for example to a database server — and complex activities can be performed at the press of a button by using predefined scripts. OpenOffice.org Basic offers complete access to all OpenOffice.org functions, supports all functions, modifies document types, and provides options for creating personal dialog windows. Use of OpenOffice.org Basic OpenOffice.org Basic can be used by any OpenOffice.org user without any additional programs or aids. Even in the standard installation, OpenOffice.org Basic has all the components needed to create its own Basic macros, including: The integrated development environment (IDE) which provides an editor for creating and testing macros. The interpreter, which is needed to run OpenOffice.org Basic macros. The interfaces to various OpenOffice.org applications, which allow for direct access to Office documents. More Information The components of the OpenOffice.org API that are discussed in this guide were selected based on their practical benefits for the OpenOffice.org Basic programmer. In general, only parts of the interfaces are discussed. For a more detailed picture, see the API reference. The Developer's Guide describes the OpenOffice.org API in more detail than this guide, but is primarily intended for Java and C++ programmers. Anyone who is already familiar with OpenOffice.org Basic programming can find additional information in the Developer's Guide on OpenOffice.org Basic and OpenOffice.org programming. Programmers who want to work directly with Java or C++ rather than OpenOffice.org Basic should consult the OpenOffice.org Developer's Guide instead of this guide. OpenOffice.org programming with Java or C++ is a considerably more complex process than programming with OpenOffice.org Basic. 8 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: Preface This guide provides an intr
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 and 32: Error Handling The following code i
Page 33 and 34: Other Instructions End Sub & "Text:
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?