OpenOffice.org BASIC Guide - OpenOffice.org wiki

More documents

Recommendations

Info

More Than Just Text AnchorType (Enum) determines the anchor type of a TextContent object (default values in accordance with com.sun.star.text.TextContentAnchorType enumeration). AnchorTypes (sequence of Enum) enumeration of all AnchorTypes which support a special TextContent object. TextWrap (Enum) determines the text wrap type around a TextContent object (default values in accordance with com.sun.star.text.WrapTextMode enumeration). The TextContent objects also share some methods – in particular, those for creating, inserting and deleting objects. A new TextContent object is created using the createInstance method of the document object. An object is inserted using the insertTextContent method of the text object. TextContent objects are deleted using the removeTextContent method. You will find a range of examples which use these methods in the following sections. Tables The following example creates a table with the help of the createInstance method described previously. Dim Doc As Object Dim Table As Object Dim Cursor As Object Doc = ThisComponent Cursor = Doc.Text.createTextCursor() Table = Doc.createInstance("com.sun.star.text.TextTable") Table.initialize(5, 4) Doc.Text.insertTextContent(Cursor, Table, False) Once created, the table is set to the number of rows and columns requested using an initialize call and then inserted in the text document using insertTextContent. As can be seen in the example, the insertTextContent method expects not only the Content object to be inserted, but two other parameters: a Cursor object which determines the insert position a Boolean variable which specifies whether the Content object is to replace the current selection of the cursor (True value) or is to be inserted before the current selection in the text (False) Note – VBA : When creating and inserting tables in a text document, objects similar to those available in VBA are used in OpenOffice.org Basic: The document object and a TextCursor object in OpenOffice.org Basic, or the Range object as the VBA counterpart. Whereas the Document.Tables.Add method takes on the task of creating and setting the table in VBA, this is created in OpenOffice.org Basic in accordance with the previous example using createInstance, initialized, and inserted in the document through insertTextContent. The tables inserted in a text document can be determined using a simple loop. The method getTextTables() of the text document object is used for this purpose: Dim Doc As Object Dim TextTables As Object Dim Table As Object Dim I As Integer Doc = ThisComponent TextTables = Doc.getTextTables() For I = 0 to TextTables.count - 1 Table = TextTables(I) ' Editing table Next I 82 OpenOffice.org 3.2 BASIC Guide · March 2010
More Than Just Text Note – Text tables are available in OpenOffice.org through the TextTables list of the document object. The previous example shows how a text table can be created. The options for accessing text tables are described in the following section. Editing Tables A table consists of individual rows. These in turn contain the various cells. Strictly speaking, there are no table columns in OpenOffice.org. These are produced implicitly by arranging the rows (one under another) next to one another. To simplify access to the tables, OpenOffice.org, however, provides some methods which operate using columns. These are useful if no cells have been merged in the table. Let us first take the properties of the table itself. These are defined in the com.sun.star.text.TextTable service. Here is an list of the most important properties of the table object: BackColor (Long) background color of table. BottomMargin (Long) bottom margin in 100ths of a millimeter. LeftMargin (Long) left margin in 100ths of a millimeter. RightMargin (Long) right margin in 100ths of a millimeter. TopMargin (Long) top margin in 100ths of a millimeter. RepeatHeadline (Boolean) table header is repeated on every page. Width (Long) Rows absolute width of the table in 100ths of a millimeter. A table consists of a list containing rows. The following example shows how the rows of a table can be retrieved and formatted. Dim Doc As Object Dim Table As Object Dim Cursor As Object Dim Rows As Object Dim Row As Object Dim I As Integer Doc = ThisComponent Cursor = Doc.Text.createTextCursor() Table = Doc.createInstance("com.sun.star.text.TextTable") Table.initialize(5, 4) Doc.Text.insertTextContent(Cursor, Table, False) Rows = Table.getRows For I = 0 To Rows.getCount() - 1 Row = Rows.getByIndex(I) Row.BackColor = &HFF00FF Next The example first creates a list containing all rows using a Table.getRows call. The getCount and getByIndex methods allow the list to be further processed and belongs to the com.sun.star.table.XtableRows interface. The getByIndex method returns a row object, which supports the com.sun.star.text.TextTableRow service. Chapter 6 · Text Documents 83
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 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: Dim Replace As Object Dim BritishWo
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

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?