OpenOffice.org BASIC Guide - OpenOffice.org wiki

More documents

Recommendations

Info

More Than Just Text this way can then be inserted in the document using the insertTextContent method of the Text object. In so doing, the name of the proper com.sun.star.text.TextFrame service should be specified. The text frame's insert position is determined by a Cursor object, which is also executed when inserted. Note – VBA : Text frames are OpenOffice.org's counterpart to the position frame used in Word. Whereas VBA uses the Document.Frames.Add method for this purpose, creation in OpenOffice.org Basic is performed using the previous procedure with the aid of a TextCursor as well as the createInstance method of the document object. Text frame objects provide a range of properties with which the position and behavior of the frame can be influenced. The majority of these properties are defined in the com.sun.star.text.BaseFrameProperties service, which is also supported by each TextFrame service. The central properties are: BackColor (Long) background color of the text frame. 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. Height (Long) height of text frame in 100ths of a millimeter. Width (Long) width of text frame in 100ths of a millimeter. HoriOrient (const) horizontal orientation of text frame (in accordance with com.sun.star.text.HoriOrientation). VertOrient (const) vertical orientation of text frame (in accordance with com.sun.star.text.VertOrientation). The following example creates a text frame using the properties described previously: Dim Doc As Object Dim TextTables As Object Dim Cursor As Object Dim Frame As Object Doc = ThisComponent Cursor = Doc.Text.createTextCursor() Cursor.gotoNextWord(False) Frame = Doc.createInstance("com.sun.star.text.TextFrame") Frame.Width = 3000 Frame.Height = 1000 Frame.AnchorType = com.sun.star.text.TextContentAnchorType.AS_CHARACTER Frame.TopMargin = 0 Frame.BottomMargin = 0 Frame.LeftMargin = 0 Frame.RightMargin = 0 Frame.BorderDistance = 0 Frame.HoriOrient = com.sun.star.text.HoriOrientation.NONE Frame.VertOrient = com.sun.star.text.VertOrientation.LINE_TOP Doc.Text.insertTextContent(Cursor, Frame, False) The example creates a TextCursor as the insertion mark for the text frame. This is positioned between the first and second word of the text. The text frame is created using Doc.createInstance. The properties of the text 86 OpenOffice.org 3.2 BASIC Guide · March 2010
frame objects are set to the starting values required. More Than Just Text The interaction between the AnchorType (from the TextContent Service) and VertOrient (from the BaseFrameProperties Service) properties should be noted here. AnchorType receives the AS_CHARACTER value. The text frame is therefore inserted directly in the text flow and behaves like a character. It can, for example, be moved into the next line if a line break occurs. The LINE_TOP value of the VertOrient property ensures that the upper edge of the text frame is at the same height as the upper edge of the character. Once initialization is complete, the text frame is finally inserted in the text document using a call from insertTextContent. To edit the content of a text frame, the user uses the TextCursor, which has already been mentioned numerous times and is also available for text frames. Dim Doc As Object Dim TextTables As Object Dim Cursor As Object Dim Frame As Object Dim FrameCursor As Object Doc = ThisComponent Cursor = Doc.Text.createTextCursor() Frame = Doc.createInstance("com.sun.star.text.TextFrame") Frame.Width = 3000 Frame.Height = 1000 Doc.Text.insertTextContent(Cursor, Frame, False) FrameCursor = Frame.createTextCursor() FrameCursor.charWeight = com.sun.star.awt.FontWeight.BOLD FrameCursor.paraAdjust = com.sun.star.style.ParagraphAdjust.CENTER FrameCursor.String = "This is a small Test!" The example creates a text frame, inserts this in the current document and opens a TextCursor for the text frame. This cursor is used to set the frame font to bold type and to set the paragraph orientation to centered. The text frame is finally assigned the “This is a small test!” string. Text Fields Text fields are TextContent objects because they provide additional logic extending beyond pure text. Text fields can be inserted in a text document using the same methods as those used for other TextContent objects: Dim Doc As Object Dim DateTimeField As Object Dim Cursor As Object Doc = ThisComponent Cursor = Doc.Text.createTextCursor() DateTimeField = Doc.createInstance("com.sun.star.text.textfield.DateTime") DateTimeField.IsFixed = False DateTimeField.IsDate = True Doc.Text.insertTextContent(Cursor, DateTimeField, False) The example inserts a text field with the current date at the start of the current text document. The True value of the IsDate property results in only the date and not time being displayed. The False value for IsFixed ensures that the date is automatically updated when the document is opened. Note – VBA : While the type of a field in VBA is specified by a parameter of the Document.Fields.Add method, the name of the service that is responsible for the field type in question defines it in OpenOffice.org Basic. Note – StarOffice 5 : In the past, text fields were accessed using a whole range of methods that OpenOffice.org made available in the old Selection object (for example InsertField, DeleteUserField, SetCurField). In OpenOffice.org, the fields are administered using an object-oriented concept. To create a text field, a text field Chapter 6 · Text Documents 87
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 and 80: Dim Replace As Object Dim BritishWo
Page 81 and 82: More Than Just Text Note - Text tab
Page 83: Doc.Text.insertTextContent(Cursor,
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?