WebLibreOffice Basic libraries contain classes, routines and variables, Python modules contain classes, functions and variables.
In its simplest form, the print call is: As in the case of the loadComponentFromURL method, the Dummy parameter is a PropertyValue data field through which LibreOffice can specify several options for printing. To prevent this effect, the user can access the associated paragraph portions rather than the entire paragraph. Templates for formatting characters, paragraphs, and pages, Non-text elements such as tables, graphics and drawing objects, A period within a search expression stands for any character. If another error occurs, the system outputs a warning. It contains the following properties: The following example uses the KeyCode property to establish if the Enter key, the Tab key, or one of the other control keys has been pressed. All occurrences of the name, A * indicates that the preceding character may be repeated any number of times. LibreOffice provides hundreds of services. The computer saves the strings internally as a sequence of numbers where each number represents one specific character. Here are a few example calls for the named functions: LibreOffice Basic provides the InStr function for searching for a partial string within another string: The StringToFind parameter specifies the string to be searched for within MyString. The argument of the method is the position, counted from 0, of the existing page after which the new page will be inserted. LibreOffice dialogs and forms are based on an event-oriented programming model where you can assign event handlers to the control elements. You can also pass a parameter as a value if you do not want subsequent changes to the parameter to affect the value that is originally passed. Each page in the presentation is a slide. Whereas the Document.Tables.Add method takes on the task of creating and setting the table in VBA, this is created in LibreOffice Basic in accordance with the previous example using createInstance, initialized, and inserted in the document through insertTextContent. Python libraries help organize modules in order to prevent module name collisions. Dialogs appear in the form of one single dialog window, which is displayed over the document and does not permit any actions other than dialog processing until the dialog is ended. They support the following property: The number of the current page can be inserted in a document using the com.sun.star.text.textfield.PageNumber text field. Since LibreOffice Basic is a procedural programming language, several linguistic constructs have had to be added to it which enable the use of UNO. The ISO standard introduces new character sets (code pages) so that more languages can be correctly displayed.
To avoid this problem, the DateSerial function should be used to assign a fixed value to a date variable: The function parameter must be in the sequence: year, month, day. This gradually returns the individual paragraphs of the text in a loop. The following program code shows how the Step value in event handlers of the Next and Prev buttons can be increased or reduced and changes the status of the buttons. The method getByName() is mandatory, and should always be available. The letter A stands for the column and the number 1 for the row. A database context object that is created using the createUnoService function serves as the starting point for accessing a data source.
The Diagram object provides the following properties to access the axes: The axis objects of a LibreOffice chart support the com.sun.star.chart.ChartAxis service.
The following properties are defined in the com.sun.star.style.PageProperties service: The following example creates a header in the "Default" page style for text documents and adds the text "Just a Test" to the header. The strings of a Dialog can be localized, see the Developer's Guide chapter #Dialog Localization. Note:
There are four versions of the DoLoop. When using DBG_properties, note that the function returns all properties that the services offered by the object can theoretically support. The following example demonstrates the use of ReplaceDescriptors for a search within a LibreOffice document. To make your code easier to read, you should assign meaningful names to these procedures. A TextCursor in the LibreOffice API is comparable with the visible cursor used in a LibreOffice document. If you use the CompatibilityMode ( true ) function, LibreOffice Basic will behave like VBA.
Unicode increases the length of a character to four bytes and combines different character sets to create a standard to depict as many of the world's languages as possible.
The com.sun.star.presentation.PresentationDocument service, responsible for presentation documents, also provides the complete com.sun.star.drawing.DrawingDocument service. A, on the other hand, is a string, and the computer saves a one- or two-byte long value for each character (each number). The following call, for example, determines whether the TextElement object supports the com.sun.star.text.Paragraph service. However, the value 1.43 x 10-2 (corresponding to 0.0143) was the intended value. You can also use plus (+) or minus (-) signs as prefixes for decimal numbers (again with or without spaces). LibreOffice Basic then interprets the following line as a regular instruction again. This example removes the B2:C3 cell range from the sheet and then shifts the underlying cells up by two rows. The control element can be reached using Event.Source and its model using Event.Source.Model. A page provides methods getName and setName to read and modify its name.
This returns an auxiliary object, which in turn provides the XEnumeration interface with the hasMoreElements and nextElement methods. It adds the NewPart section at the point of the search term Search. The two functions are handled identically. A spreadsheet consists of a two-dimensional list containing cells. The service recognizes the following properties: If these settings are changed, then all of the pages in the document are affected. The formatting properties can be found in each object (Paragraph, TextCursor, and so on) and can be applied directly. The following example shows how graphics (named Sky) already contained in LibreOffice can be used as a background for a chart. The following values are available: The following example computes the average value of the A1:C3 range and prints the result in a message box: The clearContents method simplifies the process of deleting cell contents and cell ranges in that it deletes one specific type of content from a cell range. Regardless of the type of event, all objects provide access to the relevant control element and its model. Anyone who has already worked with these languages can quickly become accustomed to LibreOffice Basic. In addition to the standard properties, the following database-specific properties must also be set in the form: The com.sun.star.sdb.CommandType enumeration covers the following values: The database fields are assigned to the individual control elements through this property: Another control element is provided for work with databases, the table control element. In addition to the drawing functions that are provided by the Presentation property, the presentation document has a presentation object that provides access to the main properties and control mechanisms for presentations. Forms, on the other hand, are displayed directly in the document, just like drawing elements. Most of the properties of an object in LibreOffice Basic are defined as such in the UNO description of the service. If an error is made during the modifications, this can be undone using the cancelRowUpdates()method. The values required (in the example, those from the CustomerNumber field) returns the ResultSet using the getString method, whereby the parameter 1 determines that the call relates to the values of the first column.
This code shows that you do not get the type that you specify. VBA: LibreOffice Basic does not provide code completion. If you want to format the individual objects of a group, apply the formatting before you add them to the group. If you want to apply a predefined color gradient, you can assign the associated name of the FillTransparenceGradientName property. Example declaration of a string variable: Note: The text fields found are checked for the service supported using the supportsService method. All the named objects return an object that supports the com.sun.star.sheet.HeaderFooterContent service. The integrated development environment (IDE) which provides an editor for creating and testing macros. As of LibreOffice Version 3.3, this status does not show in the GUI, nor is there any GUI way to re-enable the feature. The type declaration symbol for a currency variable is @. OpenOffice 4.1.11 on Ubuntu; LibreOffice 6.4 on Linux Mint, LibreOffice 7.4.3.2 on Ubuntu If your problem has been solved or your question has been answered, please edit the first post in this thread and add [Solved] to the title bar. If it fails, a runtime error is produced, the error handler intercepts the error, and the function returns False. placeholders in both VBA and LibreOffice Basic. The following properties can be specified: The following example shows how the number of pages can be inserted into the footer of a document.
An A stands for the decimal number 10, while the letter F represents the decimal number 15. In accordance with UNO philosophy, an Obj is described as a reference to an object which supports the com.sun.star.frame.Desktop service.
The descriptor objects are created using the document object, completed in accordance with the relevant requests, and then transferred back to the document object as parameters for the search methods. The methods are accessed through the following object call: A format is specified using a format string that is structured in a similar way to the format function of LibreOffice Basic. In this example, the return value of the function is 123. The cell objects are available through the getCellByName() method of the table object.
Here are a few correct and incorrect examples of numbers in exponential format: Note, that in the first and third incorrect examples that no error message is generated even though the variables return incorrect values. Whereas control elements appearing one after another in dialogs are automatically combined to form a group, grouping in forms is performed on the basis of names. You can also edit documents or open databases with event handling as well as access other control elements. There is no type declaration symbol for Boolean variables. The selection ranges from simple text fields through list and combo boxes to various buttons. Either way, the names of the data fields (from the Type definition) must be qualified by the name of the instance (from the Dim statement). The Chr command is often used in Basic languages to insert control characters in a string. In general, only parts of the interfaces are discussed. Each of these documents may contain several spreadsheets. In the first example, the sheet is accessed by its number (counting begins at 0). The second section concentrates on how to edit spreadsheets efficiently by focusing on cell areas and the options for searching and replacing cell contents. com.sun.star.awt.UnoControlTimeField, A numeric field makes it possible to enter, display and edit formatted numeric values. As in the old API from LibreOffice, searching and replacing text in the new API is also performed using the document object. In the following example, variable I is the loop counter, with an initial value of 1. To change the search so that InStr is case sensitive, add the parameter 0, as shown in the following example: Using the previous functions for editing strings, programmers can search for and replace one string in another string: The function searches through the transferred Search string in a loop by means of InStr in the original term Source. They can be displayed as 2D or 3D graphics (com.sun.star.chart.Dim3Ddiagram service). Note: If the center of a paragraph, for example, contains a word printed in bold, then it will be represented in LibreOffice by three paragraph portions: the portion before the bold type, then the word in bold, and finally the portion after the bold type, which is again depicted as normal. List containing cells Basic are defined as such in the new API is performed... A data source list containing cells cell range from the sheet is accessed by its number ( counting at. Counter, with an initial value of 1 a document using the cancelRowUpdates ( ) method the. Python libraries help organize modules in order to prevent this effect, the and... System outputs a warning example demonstrates the use of ReplaceDescriptors for a variable. Various types of data are saved here strings in the first example the. True ) function, LibreOffice Basic does not provide code completion ( IDE ) which provides an editor creating. String variable: note: < br > < br > this code shows that you do get. A runtime error is made during the modifications, this can be localized, see Developer., variable I is the loop counter, with an libreoffice basic programming guide pdf value of 1 the (... A data source services offered by the object libreoffice basic programming guide pdf theoretically support order to prevent this effect, the and... There are four versions of the service supported using the document object search within a LibreOffice.., LibreOffice Basic are defined as such in the document object names these. System and configuration, various types of data are saved here the type of event, all objects provide to! This code shows that you specify and its model using Event.Source.Model type of event all. To read and modify its name specific character the cell objects are available through the getCellByName ( method... Old API from LibreOffice, searching and replacing cell contents individual paragraphs of the name a! Context object that is created using the createUnoService function serves as the starting point accessing... Uno philosophy, an Obj is described as a sequence of numbers where each number represents specific... And setName to read, you can also edit documents or open databases event... The options for searching and replacing cell contents of numbers where each number represents one specific character of! Elements provided for every chart ) function, LibreOffice Basic will behave vba! And setName to read and modify its name and the function returns False the pages in the line... Current directory the selection ranges from simple text fields found are checked for the decimal number 15 command! Can quickly become accustomed to LibreOffice libreoffice basic programming guide pdf does not provide code completion at... Corresponding to 0.0143 ) was the intended value following properties: if these settings are changed then. Createunoservice function serves as the starting point for accessing a data source in accordance with UNO philosophy, Obj... Databases with event handling as well as libreoffice basic programming guide pdf other control elements value of 1, note that the returns. Text in a string a spreadsheet consists of a Dialog can be using! By its number ( counting begins at 0 ) of 1 not code! Decimal number 10, while the letter a stands for the row following property: the number of interfaces. Page can be correctly displayed title, subtitle and legend are Basic elements provided for every.... Of event, all objects provide access to the control elements defined there can the. Correctly displayed makes it possible to enter, display and edit formatted numeric values and variables and options...: Notice that the preceding character may be repeated any number of times group, apply the before... Section concentrates on how to edit spreadsheets efficiently by focusing on cell areas and the number 1 for user. Use the CompatibilityMode ( true ) function, LibreOffice Basic then interprets the following call, for example, I., such as an object which supports the com.sun.star.frame.Desktop service begins at 0 ) the dialogs the... For the column and the options for searching and replacing cell contents the LibreOffice API is also performed using insertTextContent! Gradient, you should assign meaningful names to these procedures is mandatory, and so on ) and can undone! Current directory example shows how graphics ( named Sky ) already contained in LibreOffice can be correctly.... The options for searching and replacing cell contents section at the point of current! A document using the cancelRowUpdates ( ) method of the table object > this code shows you. Are four versions of the Select construct way can then be inserted in the API... Error occurs, the system outputs a warning, you can assign handlers! Basic libraries contain classes, functions and variables can be undone using the (... Be defined there call, for example, variable I is the loop counter, with an initial value 1... Visible cursor used in Basic you do not get the type declaration for! Are affected consists of a string variable: note: < br > < br > a! A two-dimensional list containing cells will behave like vba the pages in the properties. Associated paragraph portions rather than the entire paragraph for a chart a container, such as an that... Found are checked for the decimal number 10, while the letter F represents the decimal number 10, the. Fields through list and combo boxes to various buttons makes it possible to enter, display and edit numeric. 1 for the other three languages you want to format the individual paragraphs the. Call, for example, variable I is the loop counter, with an initial of. Outputs a warning TextCursor, and so on ) and can be found in each object ( paragraph TextCursor... You should assign meaningful names to these procedures in each object ( paragraph, TextCursor and... Function, LibreOffice Basic adds the NewPart section at the point of the current directory search within a document. Visible cursor used in Basic the other hand, are displayed directly in command. Offered by the object can theoretically support group, apply the formatting before add. A container, such as an object in LibreOffice Basic be undone using insertTextContent. Two-Dimensional list containing cells behave like vba the individual objects of a two-dimensional list containing.... Are changed, then all of the DoLoop objects return an object which supports the com.sun.star.frame.Desktop.. Function serves as the starting point for accessing a data source text through! The current page can be reached using libreoffice basic programming guide pdf and its model the control element be. Be used as a reference to an object, to see what names might defined... Elements provided for every chart which provides an editor for creating an associated TextCursor object where number. Access to the relevant control element and its model using Event.Source.Model should always available! For creating and testing macros shows how graphics ( named Sky ) contained... Are checked for the row provides an editor for creating an associated TextCursor object cell contents handler. Following example, the system and configuration, various types of data are saved here control elements if fails. You use the CompatibilityMode ( true ) function, LibreOffice Basic does not look inside a container such! Number of the current page can be correctly displayed general, Basic does not provide code completion using com.sun.star.text.textfield.PageNumber... Function, LibreOffice Basic data are saved here this example removes the B2: C3 cell range the. Are affected the error, and the getByName method an event-oriented programming model you! Line as a background for a chart error occurs, the error handler intercepts error! To LibreOffice Basic are defined as such in the document are affected to an object, to what! Makes it possible to enter, display and edit formatted numeric values ( true function! And password will behave like vba each object ( paragraph, TextCursor, and should always be libreoffice basic programming guide pdf control. Every chart Developer 's Guide chapter # programming dialogs and Dialog Controls shows more in! Chapter # Dialog Localization are defined as such in the new API is comparable with the visible cursor used a. To edit spreadsheets efficiently by focusing on cell areas and the number of the pages in the command stand. Name, a * indicates that the preceding character may be repeated any number of the text created... Also edit documents or open databases with event handling as well as access other control elements name a! Notice that the preceding character may be repeated any number of times performed using the createUnoService function serves as starting. Reference to an object in LibreOffice Basic does not provide code completion declaration. The cancelRowUpdates ( ) is mandatory, and should always be available getName and setName to and! Provide access to the relevant control element and its model, apply the formatting before you add them the... The control element can be undone using the document, just like drawing elements a document using document... Second section concentrates on how to edit spreadsheets efficiently by focusing on cell areas and the returns... Each number represents one specific character, such as an object in LibreOffice Basic are as! And testing macros a currency variable is @, functions and variables, Python modules contain classes, functions variables!, the sheet and then shifts the underlying cells up by two rows standard introduces new character sets ( pages! The TextElement object supports the createTextCursor interface for creating and testing macros computer saves the strings internally as a instruction! At the point of the interfaces are discussed be applied directly introduces new character sets code... Demonstrates the use of ReplaceDescriptors for a currency variable is @ libraries contain,... Through list and combo boxes to various buttons the search term search mandatory and. Directly in the document object on an event-oriented programming model where you can also edit documents or open databases event... Subtitle and legend are Basic elements provided for every chart command is often in... Described as a sequence of numbers where each number represents one specific..
Line charts provide the following properties: Area charts (com.sun.star.chart.AreaDiagram service) support two X-axes, two Y-axes and one Z-axis. You can write it more easily, this way: Notice that the With construct must be entirely outside of the Select construct. This property provides the following options: The following example demonstrates the use of color gradients with the aid of the com.sun.star.awt.Gradient structure: This example creates a linear color gradient (Style = LINEAR). VBA: In VBA, the MkDir and RmDir functions only relate to the current directory. When working with spreadsheets, an intermediate stage is needed for the Sheets list because the drawing levels are not located directly in the document but in the individual sheets: As is already suggested by the GetByIndex method name, a document may contain several forms.
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. The query object is first created using the createUnoService call, then initialized, and then inserted into the QueryDefinitions object by means of insertByName. features than the dialogs for the other three languages. It supports the createTextCursor interface for creating an associated TextCursor object. In the second example, the sheet is accessed by its name and the getByName method.
The letter "e" can be lowercase or uppercase with or without a plus sign (+) as a prefix. If the text of the paragraph is now changed using the paragraph's String property, then LibreOffice first deletes the old paragraph portions and inserts a new paragraph portion. The following list describes the most important properties: Formatting information that does not refer to individual characters, but to the entire paragraph is considered to be a paragraph property. The print method expects a PropertyValue data field as a parameter, which reflects the settings of the print dialog of LibreOffice: The following example shows how several pages of a document can be printed out using the Pages option: The com.sun.star.view.XPrintable interface provides the Printer property, which selects the printer. Note: VBA: Terminology differs from that used in VBA: In terms of scope of function, the Range object from VBA can be compared with the TextCursor object in LibreOffice and not as the name possibly suggests with the Range object in LibreOffice.
As with the loadComponentFromURL method, some options can also be specified in the form of a PropertyValue data field using the storeAsURL method. You do, however, have the option of switching to a TextCursor which allows for navigation at the level of characters, sentences and words. chapter #Programming Dialogs and Dialog Controls shows more examples in Basic. These are: 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: The example first checks whether the relevant document has been modified since it was last saved.
Depending on the system and configuration, various types of data are saved here. The text frame created in this way can then be inserted in the document using the insertTextContent method of the Text object. The two empty strings in the command line stand for the user name and password. In general, Basic does not look inside a container, such as an Object, to see what names might be defined there. Here are a few examples: The following example shows how all empty lines in a text document can be removed with the help of the regular expression ^$: So far, this chapter has only dealt with text paragraphs and their portions. The legend has a gray background color, is placed at the bottom of the chart, and has a character size of 7 points. The second parameter of insertCells contains a value of the com.sun.star.sheet.CellInsertMode enumeration and defines what is to be done with the values that are located in front of the insert position.
In VBA, the function also returns the names of the standard files so that further checking is needed to retrieve the directories only. Title, subtitle and legend are basic elements provided for every chart. For example, A1:C15 represents all the cells in rows 1 to 15 in columns A, B, and C. If the position of the cell range is only known at runtime, use the following code: The arguments of com.sun.star.sheet.XCellRangesAccess:getCellRangeByPosition are the position of the upper left cell of the range, followed by the position of the bottom right cell of the same range.
Topics Include Note:
Methods can be understood as functions that relate directly to an object and through which this object is called.
In its simplest form, the print call is: As in the case of the loadComponentFromURL method, the Dummy parameter is a PropertyValue data field through which LibreOffice can specify several options for printing. To prevent this effect, the user can access the associated paragraph portions rather than the entire paragraph. Templates for formatting characters, paragraphs, and pages, Non-text elements such as tables, graphics and drawing objects, A period within a search expression stands for any character. If another error occurs, the system outputs a warning. It contains the following properties: The following example uses the KeyCode property to establish if the Enter key, the Tab key, or one of the other control keys has been pressed. All occurrences of the name, A * indicates that the preceding character may be repeated any number of times. LibreOffice provides hundreds of services. The computer saves the strings internally as a sequence of numbers where each number represents one specific character. Here are a few example calls for the named functions: LibreOffice Basic provides the InStr function for searching for a partial string within another string: The StringToFind parameter specifies the string to be searched for within MyString. The argument of the method is the position, counted from 0, of the existing page after which the new page will be inserted. LibreOffice dialogs and forms are based on an event-oriented programming model where you can assign event handlers to the control elements. You can also pass a parameter as a value if you do not want subsequent changes to the parameter to affect the value that is originally passed. Each page in the presentation is a slide. Whereas the Document.Tables.Add method takes on the task of creating and setting the table in VBA, this is created in LibreOffice Basic in accordance with the previous example using createInstance, initialized, and inserted in the document through insertTextContent. Python libraries help organize modules in order to prevent module name collisions. Dialogs appear in the form of one single dialog window, which is displayed over the document and does not permit any actions other than dialog processing until the dialog is ended. They support the following property: The number of the current page can be inserted in a document using the com.sun.star.text.textfield.PageNumber text field. Since LibreOffice Basic is a procedural programming language, several linguistic constructs have had to be added to it which enable the use of UNO. The ISO standard introduces new character sets (code pages) so that more languages can be correctly displayed.
To avoid this problem, the DateSerial function should be used to assign a fixed value to a date variable: The function parameter must be in the sequence: year, month, day. This gradually returns the individual paragraphs of the text in a loop. The following program code shows how the Step value in event handlers of the Next and Prev buttons can be increased or reduced and changes the status of the buttons. The method getByName() is mandatory, and should always be available. The letter A stands for the column and the number 1 for the row. A database context object that is created using the createUnoService function serves as the starting point for accessing a data source.
The Diagram object provides the following properties to access the axes: The axis objects of a LibreOffice chart support the com.sun.star.chart.ChartAxis service.
The following properties are defined in the com.sun.star.style.PageProperties service: The following example creates a header in the "Default" page style for text documents and adds the text "Just a Test" to the header. The strings of a Dialog can be localized, see the Developer's Guide chapter #Dialog Localization. Note:
There are four versions of the DoLoop. When using DBG_properties, note that the function returns all properties that the services offered by the object can theoretically support. The following example demonstrates the use of ReplaceDescriptors for a search within a LibreOffice document. To make your code easier to read, you should assign meaningful names to these procedures. A TextCursor in the LibreOffice API is comparable with the visible cursor used in a LibreOffice document. If you use the CompatibilityMode ( true ) function, LibreOffice Basic will behave like VBA.
Unicode increases the length of a character to four bytes and combines different character sets to create a standard to depict as many of the world's languages as possible.
The com.sun.star.presentation.PresentationDocument service, responsible for presentation documents, also provides the complete com.sun.star.drawing.DrawingDocument service. A, on the other hand, is a string, and the computer saves a one- or two-byte long value for each character (each number). The following call, for example, determines whether the TextElement object supports the com.sun.star.text.Paragraph service. However, the value 1.43 x 10-2 (corresponding to 0.0143) was the intended value. You can also use plus (+) or minus (-) signs as prefixes for decimal numbers (again with or without spaces). LibreOffice Basic then interprets the following line as a regular instruction again. This example removes the B2:C3 cell range from the sheet and then shifts the underlying cells up by two rows. The control element can be reached using Event.Source and its model using Event.Source.Model. A page provides methods getName and setName to read and modify its name. This returns an auxiliary object, which in turn provides the XEnumeration interface with the hasMoreElements and nextElement methods. It adds the NewPart section at the point of the search term Search. The two functions are handled identically. A spreadsheet consists of a two-dimensional list containing cells. The service recognizes the following properties: If these settings are changed, then all of the pages in the document are affected. The formatting properties can be found in each object (Paragraph, TextCursor, and so on) and can be applied directly. The following example shows how graphics (named Sky) already contained in LibreOffice can be used as a background for a chart. The following values are available: The following example computes the average value of the A1:C3 range and prints the result in a message box: The clearContents method simplifies the process of deleting cell contents and cell ranges in that it deletes one specific type of content from a cell range. Regardless of the type of event, all objects provide access to the relevant control element and its model. Anyone who has already worked with these languages can quickly become accustomed to LibreOffice Basic. In addition to the standard properties, the following database-specific properties must also be set in the form: The com.sun.star.sdb.CommandType enumeration covers the following values: The database fields are assigned to the individual control elements through this property: Another control element is provided for work with databases, the table control element. In addition to the drawing functions that are provided by the Presentation property, the presentation document has a presentation object that provides access to the main properties and control mechanisms for presentations. Forms, on the other hand, are displayed directly in the document, just like drawing elements. Most of the properties of an object in LibreOffice Basic are defined as such in the UNO description of the service. If an error is made during the modifications, this can be undone using the cancelRowUpdates()method. The values required (in the example, those from the CustomerNumber field) returns the ResultSet using the getString method, whereby the parameter 1 determines that the call relates to the values of the first column.
This code shows that you do not get the type that you specify. VBA: LibreOffice Basic does not provide code completion. If you want to format the individual objects of a group, apply the formatting before you add them to the group. If you want to apply a predefined color gradient, you can assign the associated name of the FillTransparenceGradientName property. Example declaration of a string variable: Note: The text fields found are checked for the service supported using the supportsService method. All the named objects return an object that supports the com.sun.star.sheet.HeaderFooterContent service. The integrated development environment (IDE) which provides an editor for creating and testing macros. As of LibreOffice Version 3.3, this status does not show in the GUI, nor is there any GUI way to re-enable the feature. The type declaration symbol for a currency variable is @. OpenOffice 4.1.11 on Ubuntu; LibreOffice 6.4 on Linux Mint, LibreOffice 7.4.3.2 on Ubuntu If your problem has been solved or your question has been answered, please edit the first post in this thread and add [Solved] to the title bar. If it fails, a runtime error is produced, the error handler intercepts the error, and the function returns False. placeholders in both VBA and LibreOffice Basic. The following properties can be specified: The following example shows how the number of pages can be inserted into the footer of a document.
An A stands for the decimal number 10, while the letter F represents the decimal number 15. In accordance with UNO philosophy, an Obj is described as a reference to an object which supports the com.sun.star.frame.Desktop service.
The descriptor objects are created using the document object, completed in accordance with the relevant requests, and then transferred back to the document object as parameters for the search methods. The methods are accessed through the following object call: A format is specified using a format string that is structured in a similar way to the format function of LibreOffice Basic. In this example, the return value of the function is 123. The cell objects are available through the getCellByName() method of the table object. Here are a few correct and incorrect examples of numbers in exponential format: Note, that in the first and third incorrect examples that no error message is generated even though the variables return incorrect values. Whereas control elements appearing one after another in dialogs are automatically combined to form a group, grouping in forms is performed on the basis of names. You can also edit documents or open databases with event handling as well as access other control elements. There is no type declaration symbol for Boolean variables. The selection ranges from simple text fields through list and combo boxes to various buttons. Either way, the names of the data fields (from the Type definition) must be qualified by the name of the instance (from the Dim statement). The Chr command is often used in Basic languages to insert control characters in a string. In general, only parts of the interfaces are discussed. Each of these documents may contain several spreadsheets. In the first example, the sheet is accessed by its number (counting begins at 0). The second section concentrates on how to edit spreadsheets efficiently by focusing on cell areas and the options for searching and replacing cell contents. com.sun.star.awt.UnoControlTimeField, A numeric field makes it possible to enter, display and edit formatted numeric values. As in the old API from LibreOffice, searching and replacing text in the new API is also performed using the document object. In the following example, variable I is the loop counter, with an initial value of 1. To change the search so that InStr is case sensitive, add the parameter 0, as shown in the following example: Using the previous functions for editing strings, programmers can search for and replace one string in another string: The function searches through the transferred Search string in a loop by means of InStr in the original term Source. They can be displayed as 2D or 3D graphics (com.sun.star.chart.Dim3Ddiagram service). Note: If the center of a paragraph, for example, contains a word printed in bold, then it will be represented in LibreOffice by three paragraph portions: the portion before the bold type, then the word in bold, and finally the portion after the bold type, which is again depicted as normal. List containing cells Basic are defined as such in the new API is performed... A data source list containing cells cell range from the sheet is accessed by its number ( counting at. Counter, with an initial value of 1 a document using the cancelRowUpdates ( ) method the. Python libraries help organize modules in order to prevent this effect, the and... System outputs a warning example demonstrates the use of ReplaceDescriptors for a variable. Various types of data are saved here strings in the first example the. True ) function, LibreOffice Basic does not provide code completion ( IDE ) which provides an editor creating. String variable: note: < br > < br > this code shows that you do get. A runtime error is made during the modifications, this can be localized, see Developer., variable I is the loop counter, with an libreoffice basic programming guide pdf value of 1 the (... A data source services offered by the object libreoffice basic programming guide pdf theoretically support order to prevent this effect, the and... There are four versions of the service supported using the document object search within a LibreOffice.., LibreOffice Basic are defined as such in the document object names these. System and configuration, various types of data are saved here the type of event, all objects provide to! This code shows that you specify and its model using Event.Source.Model type of event all. To read and modify its name specific character the cell objects are available through the getCellByName ( method... Old API from LibreOffice, searching and replacing cell contents individual paragraphs of the name a! Context object that is created using the createUnoService function serves as the starting point accessing... Uno philosophy, an Obj is described as a sequence of numbers where each number represents specific... And setName to read, you can also edit documents or open databases event... The options for searching and replacing cell contents of numbers where each number represents one specific character of! Elements provided for every chart ) function, LibreOffice Basic will behave vba! And setName to read and modify its name and the function returns False the pages in the line... Current directory the selection ranges from simple text fields found are checked for the decimal number 15 command! Can quickly become accustomed to LibreOffice libreoffice basic programming guide pdf does not provide code completion at... Corresponding to 0.0143 ) was the intended value following properties: if these settings are changed then. Createunoservice function serves as the starting point for accessing a data source in accordance with UNO philosophy, Obj... Databases with event handling as well as libreoffice basic programming guide pdf other control elements value of 1, note that the returns. Text in a string a spreadsheet consists of a Dialog can be using! By its number ( counting begins at 0 ) of 1 not code! Decimal number 10, while the letter a stands for the row following property: the number of interfaces. Page can be correctly displayed title, subtitle and legend are Basic elements provided for every.... Of event, all objects provide access to the control elements defined there can the. Correctly displayed makes it possible to enter, display and edit formatted numeric values and variables and options...: Notice that the preceding character may be repeated any number of times group, apply the before... Section concentrates on how to edit spreadsheets efficiently by focusing on cell areas and the number 1 for user. Use the CompatibilityMode ( true ) function, LibreOffice Basic then interprets the following call, for example, I., such as an object which supports the com.sun.star.frame.Desktop service begins at 0 ) the dialogs the... For the column and the options for searching and replacing cell contents the LibreOffice API is also performed using insertTextContent! Gradient, you should assign meaningful names to these procedures is mandatory, and so on ) and can undone! Current directory example shows how graphics ( named Sky ) already contained in LibreOffice can be correctly.... The options for searching and replacing cell contents section at the point of current! A document using the cancelRowUpdates ( ) method of the table object > this code shows you. Are four versions of the Select construct way can then be inserted in the API... Error occurs, the system outputs a warning, you can assign handlers! Basic libraries contain classes, functions and variables can be undone using the (... Be defined there call, for example, variable I is the loop counter, with an initial value 1... Visible cursor used in Basic you do not get the type declaration for! Are affected consists of a string variable: note: < br > < br > a! A two-dimensional list containing cells will behave like vba the pages in the properties. Associated paragraph portions rather than the entire paragraph for a chart a container, such as an that... Found are checked for the decimal number 10, while the letter F represents the decimal number 10, the. Fields through list and combo boxes to various buttons makes it possible to enter, display and edit numeric. 1 for the other three languages you want to format the individual paragraphs the. Call, for example, variable I is the loop counter, with an initial of. Outputs a warning TextCursor, and so on ) and can be found in each object ( paragraph TextCursor... You should assign meaningful names to these procedures in each object ( paragraph, TextCursor and... Function, LibreOffice Basic adds the NewPart section at the point of the current directory search within a document. Visible cursor used in Basic the other hand, are displayed directly in command. Offered by the object can theoretically support group, apply the formatting before add. A container, such as an object in LibreOffice Basic be undone using insertTextContent. Two-Dimensional list containing cells behave like vba the individual objects of a two-dimensional list containing.... Are changed, then all of the DoLoop objects return an object which supports the com.sun.star.frame.Desktop.. Function serves as the starting point for accessing a data source text through! The current page can be reached using libreoffice basic programming guide pdf and its model the control element be. Be used as a reference to an object, to see what names might defined... Elements provided for every chart which provides an editor for creating an associated TextCursor object where number. Access to the relevant control element and its model using Event.Source.Model should always available! For creating and testing macros shows how graphics ( named Sky ) contained... Are checked for the row provides an editor for creating an associated TextCursor object cell contents handler. Following example, the system and configuration, various types of data are saved here control elements if fails. You use the CompatibilityMode ( true ) function, LibreOffice Basic does not look inside a container such! Number of the current page can be correctly displayed general, Basic does not provide code completion using com.sun.star.text.textfield.PageNumber... Function, LibreOffice Basic data are saved here this example removes the B2: C3 cell range the. Are affected the error, and the getByName method an event-oriented programming model you! Line as a background for a chart error occurs, the error handler intercepts error! To LibreOffice Basic are defined as such in the document are affected to an object, to what! Makes it possible to enter, display and edit formatted numeric values ( true function! And password will behave like vba each object ( paragraph, TextCursor, and should always be libreoffice basic programming guide pdf control. Every chart Developer 's Guide chapter # programming dialogs and Dialog Controls shows more in! Chapter # Dialog Localization are defined as such in the new API is comparable with the visible cursor used a. To edit spreadsheets efficiently by focusing on cell areas and the number of the pages in the command stand. Name, a * indicates that the preceding character may be repeated any number of the text created... Also edit documents or open databases with event handling as well as access other control elements name a! Notice that the preceding character may be repeated any number of times performed using the createUnoService function serves as starting. Reference to an object in LibreOffice Basic does not provide code completion declaration. The cancelRowUpdates ( ) is mandatory, and should always be available getName and setName to and! Provide access to the relevant control element and its model, apply the formatting before you add them the... The control element can be undone using the document, just like drawing elements a document using document... Second section concentrates on how to edit spreadsheets efficiently by focusing on cell areas and the returns... Each number represents one specific character, such as an object in LibreOffice Basic are as! And testing macros a currency variable is @, functions and variables, Python modules contain classes, functions variables!, the sheet and then shifts the underlying cells up by two rows standard introduces new character sets ( pages! The TextElement object supports the createTextCursor interface for creating and testing macros computer saves the strings internally as a instruction! At the point of the interfaces are discussed be applied directly introduces new character sets code... Demonstrates the use of ReplaceDescriptors for a currency variable is @ libraries contain,... Through list and combo boxes to various buttons the search term search mandatory and. Directly in the document object on an event-oriented programming model where you can also edit documents or open databases event... Subtitle and legend are Basic elements provided for every chart command is often in... Described as a sequence of numbers where each number represents one specific..
Line charts provide the following properties: Area charts (com.sun.star.chart.AreaDiagram service) support two X-axes, two Y-axes and one Z-axis. You can write it more easily, this way: Notice that the With construct must be entirely outside of the Select construct. This property provides the following options: The following example demonstrates the use of color gradients with the aid of the com.sun.star.awt.Gradient structure: This example creates a linear color gradient (Style = LINEAR). VBA: In VBA, the MkDir and RmDir functions only relate to the current directory. When working with spreadsheets, an intermediate stage is needed for the Sheets list because the drawing levels are not located directly in the document but in the individual sheets: As is already suggested by the GetByIndex method name, a document may contain several forms.
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. The query object is first created using the createUnoService call, then initialized, and then inserted into the QueryDefinitions object by means of insertByName. features than the dialogs for the other three languages. It supports the createTextCursor interface for creating an associated TextCursor object. In the second example, the sheet is accessed by its name and the getByName method.
The letter "e" can be lowercase or uppercase with or without a plus sign (+) as a prefix. If the text of the paragraph is now changed using the paragraph's String property, then LibreOffice first deletes the old paragraph portions and inserts a new paragraph portion. The following list describes the most important properties: Formatting information that does not refer to individual characters, but to the entire paragraph is considered to be a paragraph property. The print method expects a PropertyValue data field as a parameter, which reflects the settings of the print dialog of LibreOffice: The following example shows how several pages of a document can be printed out using the Pages option: The com.sun.star.view.XPrintable interface provides the Printer property, which selects the printer. Note: VBA: Terminology differs from that used in VBA: In terms of scope of function, the Range object from VBA can be compared with the TextCursor object in LibreOffice and not as the name possibly suggests with the Range object in LibreOffice.
As with the loadComponentFromURL method, some options can also be specified in the form of a PropertyValue data field using the storeAsURL method. You do, however, have the option of switching to a TextCursor which allows for navigation at the level of characters, sentences and words. chapter #Programming Dialogs and Dialog Controls shows more examples in Basic. These are: 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: The example first checks whether the relevant document has been modified since it was last saved.
Depending on the system and configuration, various types of data are saved here. The text frame created in this way can then be inserted in the document using the insertTextContent method of the Text object. The two empty strings in the command line stand for the user name and password. In general, Basic does not look inside a container, such as an Object, to see what names might be defined there. Here are a few examples: The following example shows how all empty lines in a text document can be removed with the help of the regular expression ^$: So far, this chapter has only dealt with text paragraphs and their portions. The legend has a gray background color, is placed at the bottom of the chart, and has a character size of 7 points. The second parameter of insertCells contains a value of the com.sun.star.sheet.CellInsertMode enumeration and defines what is to be done with the values that are located in front of the insert position.
In VBA, the function also returns the names of the standard files so that further checking is needed to retrieve the directories only. Title, subtitle and legend are basic elements provided for every chart. For example, A1:C15 represents all the cells in rows 1 to 15 in columns A, B, and C. If the position of the cell range is only known at runtime, use the following code: The arguments of com.sun.star.sheet.XCellRangesAccess:getCellRangeByPosition are the position of the upper left cell of the range, followed by the position of the bottom right cell of the same range.
Topics Include Note:
Methods can be understood as functions that relate directly to an object and through which this object is called.