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

service CharacterProperties
Description
This is a set of properties to describe the style of characters.
See also
ParagraphProperties
Developers Guide
8.3.12 Text Documents - Working with Text Documents - Ruby
8.3.2 Text Documents - Working with Text Documents - Formatting

Properties' Summary
string
CharFontName
This property specifies the name of the font style.  
string
CharFontStyleName
This property contains the name of the font style.  
short
CharFontFamily
This property contains font family as specified in com.sun.star.awt.FontFamily .  
short
CharFontCharSet
This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet.  
short
CharFontPitch
This property contains the font pitch as specified in com.sun.star.awt.FontPitch.  
::com::sun::star::util::Color
CharColor
This property contains the value of the text color.  
short
CharEscapement
[ OPTIONAL ]
specifies the percentage of raisement/lowerment of superscript/subscript characters.  
float
CharHeight
This value contains the height of the characters in point.  
short
CharUnderline
This property contains the value for the character underline.  
float
CharWeight
This property contains the value of the font weight.  
::com::sun::star::awt::FontSlant
CharPosture
This property contains the value of the posture of the document.  
boolean
CharAutoKerning
[ OPTIONAL ]
optional property to determine whether the kerning tables from the current font are used.  
::com::sun::star::util::Color
CharBackColor
[ OPTIONAL ]
optional property which contains the text background color.  
boolean
CharBackTransparent
[ OPTIONAL ]
determines if the text background color is set to transparent.  
short
CharCaseMap
[ OPTIONAL ]
optional property which contains the value of the case-mapping of the text for formatting and displaying.  
boolean
CharCrossedOut
[ OPTIONAL ]
This property is true if the character(s) is(are) crossed out.  
boolean
CharFlash
[ OPTIONAL ]
If this optional property is true , then the characters are flashing.  
short
CharStrikeout
[ OPTIONAL ]
determins the type of the strike out of the character.  
boolean
CharWordMode
[ OPTIONAL ]
If this property is true , the underline and strike-through properties are not applied to white spaces.  
short
CharKerning
[ OPTIONAL ]
optional property which contains the value of the kerning of the characters.  
::com::sun::star::lang::Locale
CharLocale
contains the value of the locale.  
boolean
CharKeepTogether
[ OPTIONAL ]
optional property which marks a range of characters to prevent it from being broken into two lines.  
boolean
CharNoLineBreak
[ OPTIONAL ]
optional property which marks a range of characters to ignore a line break in this area.  
boolean
CharShadowed
[ OPTIONAL ]
specifies if the characters are formatted and displayed with a shadow effect.  
short
CharFontType
[ OPTIONAL ]
optional property which specifies the fundamental technology of the font.  
string
CharStyleName
[ OPTIONAL ]
specifies the name of the style of the font.  
boolean
CharContoured
[ OPTIONAL ]
specifies if the characters are formatted and displayed with a contour effect.  
boolean
CharCombineIsOn
[ OPTIONAL ]
determins whether text is formatted in two lines.  
string
CharCombinePrefix
[ OPTIONAL ]
contains the prefix (usually parenthesis) before text that is formatted in two lines.  
string
CharCombineSuffix
[ OPTIONAL ]
contains the suffix (usually parenthesis) after text that is formatted in two lines.  
short
CharEmphasis
[ OPTIONAL ]
contains the font emphasis value as ::com::sun::star::text::FontEmphasis .  
short
CharRelief
[ OPTIONAL ]
contains the relief value as ::com::sun::star::text::FontRelief .  
string
RubyText
[ OPTIONAL ]
contains the text that is set as ruby.  
short
RubyAdjust
[ OPTIONAL ]
determins the adjustment of the ruby text as ::com::sun::star::text::RubyAdjust .  
string
RubyCharStyleName
[ OPTIONAL ]
contains the name of the character style that is applied to RubyText.  
boolean
RubyIsAbove
[ OPTIONAL ]
determins whether the ruby text is printed above/left or below/right of the text.  
short
CharRotation
[ OPTIONAL ]
determins the rotation of a character in tenths of a degree.  
boolean
CharRotationIsFitToLine
[ OPTIONAL ]
determins whether the text formatting tries to fit rotated text into the surrounded line height.  
short
CharScaleWidth
[ OPTIONAL ]
determins the percentage value for scaling the width of characters.  
string
HyperLinkURL
[ OPTIONAL ]
contains the URL of a hyperlink (if set).  
string
HyperLinkTarget
[ OPTIONAL ]
contains the name of the target for a hyperlink (if set).  
string
HyperLinkName
[ OPTIONAL ]
contains the name of the hyperlink (if set).  
string
VisitedCharStyleName
[ OPTIONAL ]
contains the character style name for visited hyperlinks.  
string
UnvisitedCharStyleName
[ OPTIONAL ]
contains the character style name for unvisited hyperlinks.  
byte
CharEscapementHeight
[ OPTIONAL ]
This is the additional height used for subscript or superscript characters in units of percent. For subscript characters the value is negative and for superscript characters positive.  
boolean
CharNoHyphenation
[ OPTIONAL ]
determines if the word can be hyphenated at the character.  
::com::sun::star::util::Color
CharUnderlineColor
gives the color of the underline for that character.  
boolean
CharUnderlineHasColor
specifies if the CharUnderlineColor is used for an underline.  
sequence< string >
CharStyleNames
[ OPTIONAL ]
specifies the names of the all styles applied to the font.  
boolean
CharHidden
[ OPTIONAL ]
If this optional property is true , then the characters are invisible.  
::com::sun::star::container::XNameContainer
TextUserDefinedAttributes
[ OPTIONAL ]
this property stores xml attributes. They will be saved to and restored from automatic styles inside xml files.  
Properties' Details
CharFontName
string CharFontName;
Description
This property specifies the name of the font style.

It may contain more than one name separated by comma.

CharFontStyleName
string CharFontStyleName;
Description
This property contains the name of the font style.

This property may be empty.

CharFontFamily
short CharFontFamily;
Description
This property contains font family as specified in com.sun.star.awt.FontFamily .
CharFontCharSet
short CharFontCharSet;
Description
This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet.
CharFontPitch
short CharFontPitch;
Description
This property contains the font pitch as specified in com.sun.star.awt.FontPitch.
CharColor
::com::sun::star::util::Color CharColor;
Description
This property contains the value of the text color.
CharEscapement
short CharEscapement;
Usage Restrictions
optional
Description
specifies the percentage of raisement/lowerment of superscript/subscript characters.

Negative values denote subscripts and positive values superscripts.

CharHeight
float CharHeight;
Description
This value contains the height of the characters in point.
CharUnderline
short CharUnderline;
Description
This property contains the value for the character underline.
See also
::com::sun::star::awt::FontUnderline
CharWeight
float CharWeight;
Description
This property contains the value of the font weight.
See also
::com::sun::star::awt::FontWeight
CharPosture
::com::sun::star::awt::FontSlant CharPosture;
Description
This property contains the value of the posture of the document.
See also
::com::sun::star::awt::FontSlant
CharAutoKerning
boolean CharAutoKerning;
Usage Restrictions
optional
Description
optional property to determine whether the kerning tables from the current font are used.

Automatic kerning applies a spacing in between certain pairs of characters to make the text look better.

CharBackColor
::com::sun::star::util::Color CharBackColor;
Usage Restrictions
optional
Description
optional property which contains the text background color.
CharBackTransparent
boolean CharBackTransparent;
Usage Restrictions
optional
Description
determines if the text background color is set to transparent.
CharCaseMap
short CharCaseMap;
Usage Restrictions
optional
Description
optional property which contains the value of the case-mapping of the text for formatting and displaying.
See also
CaseMap
CharCrossedOut
boolean CharCrossedOut;
Usage Restrictions
optional
Description
This property is true if the character(s) is(are) crossed out.
CharFlash
boolean CharFlash;
Usage Restrictions
optional
Description
If this optional property is true , then the characters are flashing.
CharStrikeout
short CharStrikeout;
Usage Restrictions
optional
Description
determins the type of the strike out of the character.
See also
com.sun.star.awt.FontStrikeout
CharWordMode
boolean CharWordMode;
Usage Restrictions
optional
Description
If this property is true , the underline and strike-through properties are not applied to white spaces.
CharKerning
short CharKerning;
Usage Restrictions
optional
Description
optional property which contains the value of the kerning of the characters.
CharLocale
::com::sun::star::lang::Locale CharLocale;
Description
contains the value of the locale.
CharKeepTogether
boolean CharKeepTogether;
Usage Restrictions
optional
Description
optional property which marks a range of characters to prevent it from being broken into two lines.

A line break is applied before the range of characters if the layout makes a break necessary within the range.

CharNoLineBreak
boolean CharNoLineBreak;
Usage Restrictions
optional
Description
optional property which marks a range of characters to ignore a line break in this area.

A line break is applied behind the range of characters if the layout makes a break necessary within the range. That means that the text may go through the border.

CharShadowed
boolean CharShadowed;
Usage Restrictions
optional
Description
specifies if the characters are formatted and displayed with a shadow effect.
CharFontType
short CharFontType;
Usage Restrictions
optional
Description
optional property which specifies the fundamental technology of the font.
See also
::com::sun::star::awt::FontType
CharStyleName
string CharStyleName;
Usage Restrictions
optional
Description
specifies the name of the style of the font.
CharContoured
boolean CharContoured;
Usage Restrictions
optional
Description
specifies if the characters are formatted and displayed with a contour effect.
CharCombineIsOn
boolean CharCombineIsOn;
Usage Restrictions
optional
Description
determins whether text is formatted in two lines.

It is linked to the properties CharCombinePrefix and CharCombineSuffix.

CharCombinePrefix
string CharCombinePrefix;
Usage Restrictions
optional
Description
contains the prefix (usually parenthesis) before text that is formatted in two lines.

It is linked to the properties CharCombineIsOn and CharCombineSuffix.

CharCombineSuffix
string CharCombineSuffix;
Usage Restrictions
optional
Description
contains the suffix (usually parenthesis) after text that is formatted in two lines.

It is linked to the properties CharCombineIsOn and CharCombinePrefix.

CharEmphasis
short CharEmphasis;
Usage Restrictions
optional
Description
contains the font emphasis value as ::com::sun::star::text::FontEmphasis .
CharRelief
short CharRelief;
Usage Restrictions
optional
Description
contains the relief value as ::com::sun::star::text::FontRelief .
RubyText
string RubyText;
Usage Restrictions
optional
Description
contains the text that is set as ruby.
RubyAdjust
short RubyAdjust;
Usage Restrictions
optional
Description
determins the adjustment of the ruby text as ::com::sun::star::text::RubyAdjust .
RubyCharStyleName
string RubyCharStyleName;
Usage Restrictions
optional
Description
contains the name of the character style that is applied to RubyText.
RubyIsAbove
boolean RubyIsAbove;
Usage Restrictions
optional
Description
determins whether the ruby text is printed above/left or below/right of the text.
CharRotation
short CharRotation;
Usage Restrictions
optional
Description
determins the rotation of a character in tenths of a degree.

Depending on the implementation only certain values may be allowed.

CharRotationIsFitToLine
boolean CharRotationIsFitToLine;
Usage Restrictions
optional
Description
determins whether the text formatting tries to fit rotated text into the surrounded line height.
CharScaleWidth
short CharScaleWidth;
Usage Restrictions
optional
Description
determins the percentage value for scaling the width of characters.

The value refers to the original width which is denoted by 100, and it has to be greater than 0.

HyperLinkURL
string HyperLinkURL;
Usage Restrictions
optional
Description
contains the URL of a hyperlink (if set).
HyperLinkTarget
string HyperLinkTarget;
Usage Restrictions
optional
Description
contains the name of the target for a hyperlink (if set).
HyperLinkName
string HyperLinkName;
Usage Restrictions
optional
Description
contains the name of the hyperlink (if set).
VisitedCharStyleName
string VisitedCharStyleName;
Usage Restrictions
optional
Description
contains the character style name for visited hyperlinks.
UnvisitedCharStyleName
string UnvisitedCharStyleName;
Usage Restrictions
optional
Description
contains the character style name for unvisited hyperlinks.
CharEscapementHeight
byte CharEscapementHeight;
Usage Restrictions
optional
Description
This is the additional height used for subscript or superscript characters in units of percent. For subscript characters the value is negative and for superscript characters positive.
CharNoHyphenation
boolean CharNoHyphenation;
Usage Restrictions
optional
Description
determines if the word can be hyphenated at the character.
CharUnderlineColor
::com::sun::star::util::Color CharUnderlineColor;
Description
gives the color of the underline for that character.
CharUnderlineHasColor
boolean CharUnderlineHasColor;
Description
specifies if the CharUnderlineColor is used for an underline.
CharStyleNames
sequence< string > CharStyleNames;
Usage Restrictions
optional
Description
specifies the names of the all styles applied to the font.

It is not guaranteed that the order in the sequence reflects the order of the evaluation of the character style attributes.

Since
OpenOffice 1.1.2
CharHidden
boolean CharHidden;
Usage Restrictions
optional
Description
If this optional property is true , then the characters are invisible.
Since
OpenOffice 2.0
TextUserDefinedAttributes
::com::sun::star::container::XNameContainer TextUserDefinedAttributes;
Usage Restrictions
optional
Description
this property stores xml attributes. They will be saved to and restored from automatic styles inside xml files.
See also
::com::sun::star::xml::AttributeContainer

 
Top of Page