OpenOffice.org BASIC Guide - OpenOffice.org wiki

The Structure of Text Documents
' loop over all paragraph portions
While Enum2.hasMoreElements
TextPortion = Enum2.nextElement
If TextPortion.CharWeight = com.sun.star.awt.FontWeight.BOLD THEN
CurLine = CurLine & "" & TextPortion.String & ""
Else
CurLine = CurLine & TextPortion.String
End If
Wend
' output the line
CurLine = CurLine & ""
Print #FileNo, CurLine
End If
Wend
' write HTML footer
Print #FileNo, ""
Close #FileNo
The basic structure of the example is oriented towards the examples for running though the paragraph portions of
a text already discussed previously. The functions for writing the HTML file, as well as a test code that checks the
font weight of the corresponding text portions and provides paragraph portions in bold type with a
corresponding HTML tag, have been added.
Default values for character and paragraph properties
Direct formatting always takes priority over indirect formatting. In other words, formatting using templates is
assigned a lower priority than direct formatting in a text.
Establishing whether a section of a document has been directly or indirectly formatted is not easy. The symbol
bars provided by OpenOffice.org show the common text properties such as font type, weight and size. However,
whether the corresponding settings are based on template or direct formatting in the text is still unclear.
OpenOffice.org Basic provides the getPropertyState method, with which programmers can check how a
certain property was formatted. As a parameter, this takes the name of the property and returns a constant that
provides information about the origin of the formatting. The following responses, which are defined in the
com.sun.star.beans.PropertyState enumeration, are possible:
com.sun.star.beans.PropertyState.DIRECT_VALUE
the property is defined directly in the text (direct formatting)
com.sun.star.beans.PropertyState.DEFAULT_VALUE
the property is defined by a template (indirect formatting)
com.sun.star.beans.PropertyState.AMBIGUOUS_VALUE
the property is unclear. This status arises, for example, when querying the bold type property of a
paragraph, which includes both words depicted in bold and words depicted in normal font.
The following example shows how format properties can be edited in OpenOffice.org. It searches through a text
for paragraph portions which have been depicted as bold type using direct formatting. If it encounters a
corresponding paragraph portion, it deletes the direct formatting using the setPropertyToDefault method and
assigns a MyBold character template to the corresponding paragraph portion.
Dim Doc As Object
Dim Enum1 As Object
Dim Enum2 As Object
Dim TextElement As Object
Dim TextPortion As Object
Doc = ThisComponent
Enum1 = Doc.Text.createEnumeration
' loop over all paragraphs
While Enum1.hasMoreElements
TextElement = Enum1.nextElement
74 OpenOffice.org 3.2 BASIC Guide · March 2010