OpenOffice.org BASIC Guide - OpenOffice.org wiki

More documents

Recommendations

Info

The StarDesktop MsgBox "Press OK to display the second document." Url = "file:///C:/test2.odt" Doc = StarDesktop.loadComponentFromURL(Url, "MyFrame", _ SearchFlags, Dummy) The example first opens the test.odt file in a new window with the frame name of MyFrame. Once the message box has been confirmed, it replaces the content of the window with the test2.odt file. loadComponentFromURL Method Options The fourth parameter of the loadComponentFromURL function is a PropertyValue data field. which provides OpenOffice.org with various options for opening and creating documents. The data field must provide a PropertyValue structure for each option in which the name of the option is saved as a string as well as the associated value. loadComponentFromURL supports the following options: AsTemplate (Boolean) if true, loads a new, untitled document from the given URL. If is false, template files are loaded for editing. CharacterSet (String) defines which set of characters a document is based on. FilterName (String) specifies a special filter for the loadComponentFromURL function. The filter names available are defined in the \share\config\registry\instance\org\openoffice\office\TypeDetection.xml file. FilterData (String) defines additional options for filters. FilterOptions (String) defines additional options (used by old filters). Hidden (Boolean) value true loads the document in invisible mode. JumpMark (String) once a document has been opened, jumps to the position defined in JumpMark. MacroExecutionMode (Integer) indicates if document macros may be executed. Values : see com.sun.star.document.MacroExecMode Password (String) transfers a password for a protected file. ReadOnly (Boolean) value true loads a document in read-only mode. UpdateDocMode (Integer) indicates how/if links will be updated. Values : see com.sun.star.document.UpdateDocMode The following example shows how a text file separated by a comma in OpenOffice.org Calc can be opened using the FilterName option. Dim Doc As Object Dim FileProperties(1) As New com.sun.star.beans.PropertyValue Dim Url As String Url = "file:///C:/doc.csv" FileProperties(0).Name = "FilterName" FileProperties(0).Value ="Text - txt - csv (StarCalc)" FileProperties(1).Name = "FilterOptions" FileProperties(1).value = "44,34,0,1" Doc = StarDesktop.loadComponentFromURL(Url, "_blank", 0, FileProperties()) 62 OpenOffice.org 3.2 BASIC Guide · March 2010
The StarDesktop The FileProperties array has two elements, one for each option used. The Filtername property defines whether OpenOffice.org uses a OpenOffice.org Calc text filter to open files. The FilterOptions property contains the description of the syntax of the csv file. Creating New Documents OpenOffice.org automatically creates a new document if the document specified in the URL is a template. Alternatively, if only an empty document without any adaptation is needed, a private:factory URL can be specified: Dim Dummy() Dim Url As String Dim Doc As Object Url = "private:factory/swriter" Doc = StarDesktop.loadComponentFromURL(Url, "_blank", 0, Dummy()) The call creates an empty OpenOffice.org writer document. Document Objects The loadComponentFromURL function introduced in the previous section returns a document object. This supports the com.sun.star.document.OfficeDocument service, which in turn provides two central interfaces: The com.sun.star.frame.XStorable interface, which is responsible for saving documents. The com.sun.star.view.XPrintable interface, which contains the methods for printing documents. Saving and Exporting Documents OpenOffice.org documents are saved directly through the document object. The store method of the com.sun.star.frame.XStorable interface is available for this purpose: Doc.store() This call functions provided that the document has already been assigned a memory space. This is not the case for new documents. In this instance, the storeAsURL method is used. This method is also defined in com.sun.star.frame.XStorable and can be used to define the location of the document: Dim URL As String Dim Dummy() Url = "file:///C:/test3.odt" Doc.storeAsURL(URL, Dummy()) In addition to the preceding methods, com.sun.star.frame.XStorable also provides some help methods which are useful when saving documents. These are: hasLocation() specifies whether the document has already been assigned a URL. isReadonly() specifies whether a document has read-only protection. isModified() specifies whether a document has been modified since it was last saved. The code for saving a document can be extended by these options so that the document is only saved if the object has actually been modified and the file name is only queried if it is actually needed: If (Doc.isModified) Then If (Doc.hasLocation And (Not Doc.isReadOnly)) Then Doc.store() Else Doc.storeAsURL(URL, Dummy()) Chapter 5 · Working with Documents 63
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: XML File Format The StarDesktop Ope
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?