Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: style ::

service Style
Description
This service specifies a single style sheet.
Developers Guide
Text - Overall Document Features - Styles

Included Services - Summary
::com::sun::star::xml::UserDefinedAttributesSupplier

contains user defined attributes. (details)

Exported Interfaces - Summary
XStyle
(referenced entity's summary:)
specifies a template for a style (aka style sheet).
::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
::com::sun::star::beans::XMultiPropertySet
::com::sun::star::beans::XMultiPropertyStates
Properties' Summary
[ readonly ] boolean
IsPhysical
[ OPTIONAL ]
determines if a style is physically created.  
string
FollowStyle
[ OPTIONAL ]
contains the name of the style that is applied to the next paragraph.  
[ readonly ] string
DisplayName
[ OPTIONAL ]
contains the name of the style as it is displayed in the user interface.  
string
IsAutoUpdate
[ OPTIONAL ]
determines if a style is automatically updated, if the properties of an object that the style is applied to are changed.  
sequence< ::com::sun::star::beans::NamedValue >
ParaStyleConditions
[ OPTIONAL ]
defines the context and styles for conditional paragraphs.  
Included Services - Details
::com::sun::star::xml::UserDefinedAttributesSupplier
Usage Restrictions
optional
Description
contains user defined attributes.
See also
::com::sun::star::xml::UserDefinedAttributesSupplier
Exported Interfaces - Details
XStyle
(referenced entity's summary:)
specifies a template for a style (aka style sheet).
::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
::com::sun::star::beans::XMultiPropertySet
Usage Restrictions
optional
::com::sun::star::beans::XMultiPropertyStates
Usage Restrictions
optional
Properties' Details
IsPhysical
[ readonly ] boolean IsPhysical;
Usage Restrictions
optional
Description
determines if a style is physically created.

Built in styles may not be created until they are needed. To prevent standard style properties from being exported, it may be useful to check if the style is created first.

FollowStyle
string FollowStyle;
Usage Restrictions
optional
Description
contains the name of the style that is applied to the next paragraph.

This property is usually available at paragraph styles only.

DisplayName
[ readonly ] string DisplayName;
Usage Restrictions
optional
Description
contains the name of the style as it is displayed in the user interface.

The names of the styles at the API are language independent. The user interface names are localised.

IsAutoUpdate
string IsAutoUpdate;
Usage Restrictions
optional
Description
determines if a style is automatically updated, if the properties of an object that the style is applied to are changed.

For example, if the style is applied to a paragraph and the properties of the paragraph are changed then the style will be updated accordingly.

ParaStyleConditions
sequence< ::com::sun::star::beans::NamedValue > ParaStyleConditions;
Usage Restrictions
optional
Description
defines the context and styles for conditional paragraphs.

This property is only available if the style is a conditional paragraph style.

The sequence consists of pairs where the name part of the pair defines the context where it should be applied and the value part is a string naming the style to be used in that context.

Assigning an empty string to the style name will disable the conditional style for that context.

The alowed strings (contexts) for the name part of an entry of the sequence are:

  • TableHeader
  • Table
  • Frame
  • Section
  • Footnote
  • Endnote
  • Header
  • Footer
  • OutlineLevel1
  • OutlineLevel2
  • OutlineLevel3
  • OutlineLevel4
  • OutlineLevel5
  • OutlineLevel6
  • OutlineLevel7
  • OutlineLevel8
  • OutlineLevel9
  • OutlineLevel10
  • NumberingLevel1
  • NumberingLevel2
  • NumberingLevel3
  • NumberingLevel4
  • NumberingLevel5
  • NumberingLevel6
  • NumberingLevel7
  • NumberingLevel8
  • NumberingLevel9
  • NumberingLevel10
Since
OOo 2.0.1

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.