OpenOffice.org BASIC Guide - OpenOffice.org wiki

More documents

Recommendations

Info

The Structure of Text Documents Formatting There are various ways of formatting text. The easiest way is to assign the format properties directly to the text sequence. This is called direct formatting. Direct formatting is used in particular with short documents because the formats can be assigned by the user with the mouse. You can, for example, highlight a certain word within a text using bold type or center a line. In addition to direct formatting, you can also format text using templates. This is called indirect formatting. With indirect formatting, the user assigns a pre-defined template to the relevant text portion. If the layout of the text is changed at a later date, the user only needs to change the template. OpenOffice.org then changes the way in which all text portions which use this template are depicted. Note – VBA : In VBA, the formatting properties of an object are usually spread over a range of sub-objects (for example, Range.Font, Range.Borders, Range.Shading, Range.ParagraphFormat). The properties are accessed by means of cascading expressions (for example, Range.Font.AllCaps). In OpenOffice.org Basic, the formatting properties on the other hand are available directly, using the relevant objects (TextCursor, Paragraph, and so on). You will find an overview of the character and paragraph properties available in OpenOffice.org in the following two sections. Note – The formatting properties can be found in each object (Paragraph, TextCursor, and so on) and can be applied directly. Character Properties Those format properties that refer to individual characters are described as character properties. These include bold type and the font type. Objects that allow character properties to be set have to support the com.sun.star.style.CharacterProperties service. OpenOffice.org recognizes a whole range of services that support this service. These include the previously described com.sun.star.text.Paragraph services for paragraphs as well as the com.sun.star.text.TextPortion services for paragraph portions. The com.sun.star.style.CharacterProperties service does not provide any interfaces, but instead offers a range of properties through which character properties can be defined and called. A complete list of all character properties can be found in the OpenOffice.org API reference. The following list describes the most important properties: CharFontName (String) name of font type selected. CharColor (Long) text color. CharHeight (Float) character height in points (pt). CharUnderline (Constant group) type of underscore (constants in accordance with com.sun.star.awt.FontUnderline). CharWeight (Constant group) font weight (constants in accordance with com.sun.star.awt.FontWeight). CharBackColor (Long) background color. CharKeepTogether (Boolean) suppression of automatic line break. CharStyleName (String) name of character template. 72 OpenOffice.org 3.2 BASIC Guide · March 2010
Paragraph Properties The Structure of Text Documents Formatting information that does not refer to individual characters, but to the entire paragraph is considered to be a paragraph property. This includes the distance of the paragraph from the edge of the page as well as line spacing. The paragraph properties are available through the com.sun.star.style.ParagraphProperties service. Even the paragraph properties are available in various objects. All objects that support the com.sun.star.text.Paragraph service also provide support for the paragraph properties in com.sun.star.style.ParagraphProperties. A complete list of the paragraph properties can be found in the OpenOffice.org API reference. The most common paragraph properties are: ParaAdjust (enum) vertical text orientation (constants in accordance with com.sun.star.style.ParagraphAdjust). ParaLineSpacing (struct) line spacing (structure in accordance with com.sun.star.style.LineSpacing). ParaBackColor (Long) background color. ParaLeftMargin (Long) left margin in 100ths of a millimeter. ParaRightMargin (Long) right margin in 100ths of a millimeter. ParaTopMargin (Long) top margin in 100ths of a millimeter. ParaBottomMargin (Long) bottom margin in 100ths of a millimeter. ParaTabStops (Array of struct) type and position of tabs (array with structures of the type com.sun.star.style.TabStop). ParaStyleName (String) name of the paragraph template. Example: simple HTML export The following example demonstrates how to work with formatting information. It iterates through a text document and creates a simple HTML file. Each paragraph is recorded in its own HTML element for this purpose. Paragraph portions displayed in bold type are marked using a HTML element when exporting. Dim FileNo As Integer, Filename As String, CurLine As String Dim Doc As Object Dim Enum1 As Object, Enum2 As Object Dim TextElement As Object, TextPortion As Object Filename = "c:\text.html" FileNo = Freefile Open Filename For Output As #FileNo Print #FileNo, "" Doc = ThisComponent Enum1 = Doc.Text.createEnumeration ' loop over all paragraphs While Enum1.hasMoreElements TextElement = Enum1.nextElement If TextElement.supportsService("com.sun.star.text.Paragraph") Then Enum2 = TextElement.createEnumeration CurLine = "" Chapter 6 · Text Documents 73
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: described in Search and Replace. Th
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?