OpenOffice.org BASIC Guide - OpenOffice.org wiki

More documents

Recommendations

Info

The StarDesktop End If End If The example first checks whether the relevant document has been modified since it was last saved. It only continues with the saving process if this is the case. If the document has already been assigned a URL and is not a read-only document, it is saved under the existing URL. If it does not have a URL or was opened in its read-only status, it is saved under a new URL. storeAsURL Method Options As with the loadComponentFromURL method, some options can also be specified in the form of a PropertyValue data field using the storeAsURL method. These determine the procedure OpenOffice.org uses when saving a document. storeAsURL provides the following options: 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). Overwrite (Boolean) allows a file which already exists to be overwritten without a query. Password (String) transfers the password for a protected file. Unpacked (Boolean) saves the document (not compressed) in sub-directories. The possibility to store documents in unpacked way is not currently supported, the "Unpacked" property is just ignored, see Issue 64364 . The following example shows how the Overwrite option can be used in conjunction with storeAsURL: Dim Doc As Object Dim FileProperties(0) As New com.sun.star.beans.PropertyValue Dim Url As String ' ... Initialize Doc Url = "file:///c:/test3.odt" FileProperties(0).Name = "Overwrite" FileProperties(0).Value = True Doc.storeAsURL(Url, FileProperties()) The example then saves Doc under the specified file name if a file already exists under the name. Printing Documents Similar to saving, documents are printed out directly by means of the document object. The Print method of the com.sun.star.view.Xprintable interface is provided for this purpose. In its simplest form, the print call is: Dim Dummy() Doc.print(Dummy()) As in the case of the loadComponentFromURL method, the Dummy parameter is a PropertyValue data field through which OpenOffice.org can specify several options for printing. 64 OpenOffice.org 3.2 BASIC Guide · March 2010
The options of the print method The StarDesktop The print method expects a PropertyValue data field as a parameter, which reflects the settings of the print dialog of OpenOffice.org: CopyCount (Integer) specifies the number of copies to be printed. FileName (String) prints the document in the specified file. Collate (Boolean) advises the printer to collate the pages of the copies. Sort (Boolean) sorts the pages when printing out several copies (CopyCount > 1). Pages (String) contains the list of the pages to be printed (syntax as specified in print dialog). Wait (Boolean) if set to True the print method will return after the job is stored on the waiting list for the printer. Use this option if you want to close the document after print. The following example shows how several pages of a document can be printed out using the Pages option: Dim Doc As Object Dim PrintProperties(1) As New com.sun.star.beans.PropertyValue PrintProperties(0).Name="Pages" PrintProperties(0).Value="1-3; 7; 9" PrintProperties(1).Name="Wait" PrintProperties(1).Value=True Doc.print(PrintProperties()) Printer selection and settings The com.sun.star.view.XPrintable interface provides the Printer property, which selects the printer. This property receives a PropertyValue data field with the following settings: Name (String) specifies the name of printer. PaperOrientation (Enum) specifies the paper orientation (com.sun.star.view.PaperOrientation.PORTRAIT value for portrait format, com.sun.star.view.PaperOrientation.LANDSCAPE for landscape format). PaperFormat (Enum) specifies the paper format (for example, com.sun.star.view.PaperFormat.A4 for DIN A4 or com.sun.star.view.PaperFormat.Letter for US letters). PaperSize (Size) specifies the paper size in hundredths of a millimeter. The following example shows how a printer can be changed and the paper size set with the help of the Printer property. Dim Doc As Object Dim PrinterProperties(1) As New com.sun.star.beans.PropertyValue Dim PaperSize As New com.sun.star.awt.Size PaperSize.Width = 20000 ' corresponds to 20 cm PaperSize.Height = 20000 ' corresponds to 20 cm PrinterProperties (0).Name="Name" PrinterProperties (0).Value="My HP Laserjet" PrinterProperties (1).Name="PaperSize" PrinterProperties (1).Value=PaperSize Chapter 5 · Working with Documents 65
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: The StarDesktop The FileProperties
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

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

Delete template?

Save as template?