OpenOffice.org BASIC Guide - OpenOffice.org wiki

More documents

Recommendations

Info

Editing Text Documents Retrieving and Modifying Text Contents If a TextCursor contains a highlighted area, then this text is available by means of the String property of the TextCursor object. The following example uses the String property to display the first words of a sentence in a message box: Dim Doc As Object Dim Cursor As Object Dim Proceed As Boolean Doc = ThisComponent Cursor = Doc.Text.createTextCursor Do Cursor.gotoEndOfWord(True) MsgBox Cursor.String Proceed = Cursor.gotoNextSentence(False) Cursor.gotoNextWord(False) Loop While Proceed The first word of each sentence can be modified in the same way using the String property: Dim Doc As Object Dim Cursor As Object Dim Proceed As Boolean Doc = ThisComponent Cursor = Doc.Text.createTextCursor Do Cursor.gotoEndOfWord(True) Cursor.String = "Ups" Proceed = Cursor.gotoNextSentence(False) Cursor.gotoNextWord(False) Loop While Proceed If the TextCursor contains a highlighted area, an assignment to the String property replaces this with the new text. If there is no highlighted area, the text is inserted at the present TextCursor position. Inserting Control Codes In some situations, it is not the actual text of a document, but rather its structure that needs modifying. OpenOffice.org provides control codes for this purpose. These are inserted in the text and influence its structure. The control codes are defined in the com.sun.star.text.ControlCharacter group of constants. The following control codes are available in OpenOffice.org: PARAGRAPH_BREAK paragraph break. LINE_BREAK line break within a paragraph. SOFT_HYPHEN possible point for syllabification. HARD_HYPHEN obligatory point for syllabification. HARD_SPACE protected space that is not spread out or compressed in justified text. To insert the control codes, you need not only the cursor but also the associated text document objects. The following example inserts a paragraph after the 20th character of a text: Dim Doc As Object Dim Cursor As Object Dim Proceed As Boolean Doc = ThisComponent Cursor = Doc.Text.createTextCursor Cursor.goRight(20, False) 78 OpenOffice.org 3.2 BASIC Guide · March 2010
Doc.Text.insertControlCharacter(Cursor, _ com.sun.star.text.ControlCharacter.PARAGRAPH_BREAK, False) Editing Text Documents The False parameter in the call of the insertControlCharacter method ensures that the area currently highlighted by the TextCursor remains after the insert operation. If the True parameter is passed here, then insertControlCharacter replaces the current text. Searching for Text Portions In many instances, it is the case that a text is to be searched for a particular term and the corresponding point needs to be edited. All OpenOffice.org documents provide a special interface for this purpose, and this interface always functions in accordance with the same principle: Before a search process, what is commonly referred to as a SearchDescriptor must first be created. This defines what OpenOffice.org searches for in a document. A SearchDescriptor is an object which supports the com.sun.star.util. SearchDescriptor service and can be created by means of the createSearchDescriptor method of a document: Dim SearchDesc As Object SearchDesc = Doc.createSearchDescriptor Once the SearchDescriptor has been created, it receives the text to be searched for: SearchDesc.searchString="any text" In terms of its function, the SearchDescriptor is best compared with the search dialog from OpenOffice.org. In a similar way to the search window, the settings needed for a search can be set in the SearchDescriptor object. The properties are provided by the com.sun.star.util.SearchDescriptor service: SearchBackwards (Boolean) searches through the text backward rather than forward. SearchCaseSensitive (Boolean) takes uppercase and lowercase characters into consideration during the search. SearchRegularExpression (Boolean) treats the search expression like a regular expression. SearchStyles (Boolean) searches through the text for the specified paragraph template. SearchWords (Boolean) only searches for complete words. The OpenOffice.org SearchSimilarity (or “fuzzy match”) function is also available in OpenOffice.org Basic. With this function, OpenOffice.org searches for an expression that may be similar to but not exactly the same as the search expression. The number of additional, deleted and modified characters for these expressions can be defined individually. Here are the associated properties of the com.sun.star.util.SearchDescriptor service: SearchSimilarity (Boolean) performs a similarity search. SearchSimilarityAdd (Short) number of characters which may be added for a similarity search. SearchSimilarityExchange (Short) number of characters which may be replaced as part of a similarity search. SearchSimilarityRemove (Short) number of characters which may be removed as part of a similarity search. SearchSimilarityRelax (Boolean) takes all deviation rules into consideration at the same time for the search expression. Chapter 6 · Text Documents 79
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: isEndOfSentence () returns True if
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

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

Delete template?

Save as template?