Service CharacterProperties

Services' Summary

Interfaces' Summary

Properties' Summary

Services' Details

Interfaces' Details

Properties' Details

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

service CharacterProperties

Description: This is a set of properties to describe the style of characters.
See also: ParagraphProperties

Developers Guide: Text - Formatting; Text - Ruby

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.
short CharFontCharSet	This property contains the text encoding of the font.
short CharFontPitch	This property contains the font pitch.
::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 ] This optional property determines whether the kerning tables from the current font are used.
::com::sun::star::util::Color CharBackColor	[ OPTIONAL ] This optional property contains the text background color.
boolean CharBackTransparent	[ OPTIONAL ] This property determines if the text background color is set to transparent.
short CharCaseMap	[ OPTIONAL ] This optional property contains the value of the case-mapping of the text for formatting and displaying.
boolean CharCrossedOut	[ OPTIONAL ] This property is true if the characters are crossed out.
boolean CharFlash	[ OPTIONAL ] If this optional property is true, then the characters are flashing.
short CharStrikeout	[ OPTIONAL ] This property 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 ] This optional property contains the value of the kerning of the characters.
::com::sun::star::lang::Locale CharLocale	This property contains the value of the locale.
boolean CharKeepTogether	[ OPTIONAL ] This optional property marks a range of characters to prevent it from being broken into two lines.
boolean CharNoLineBreak	[ OPTIONAL ] This optional property marks a range of characters to ignore a line break in this area.
boolean CharShadowed	[ OPTIONAL ] This optional property specifies if the characters are formatted and displayed with a shadow effect.
short CharFontType	[ OPTIONAL ] This optional property specifies the fundamental technology of the font.
string CharStyleName	[ OPTIONAL ] This optional property specifies the name of the style of the font.
boolean CharContoured	[ OPTIONAL ] This optional property specifies if the characters are formatted and displayed with a contour effect.
boolean CharCombineIsOn	[ OPTIONAL ] This optional property determins whether text is formatted in two lines.
string CharCombinePrefix	[ OPTIONAL ] This optional property contains the prefix (usually parenthesis) before text that is formatted in two lines.
string CharCombineSuffix	[ OPTIONAL ] This optional property contains the suffix (usually parenthesis) after text that is formatted in two lines.
short CharEmphasis	[ OPTIONAL ] This optional property contains the font emphasis value.
short CharRelief	[ OPTIONAL ] This optional property contains the relief style of the characters.
string RubyText	[ OPTIONAL ] This optional property contains the text that is set as ruby.
short RubyAdjust	[ OPTIONAL ] This optional property determins the adjustment of the ruby .
string RubyCharStyleName	[ OPTIONAL ] This optional property contains the name of the character style that is applied to RubyText.
boolean RubyIsAbove	[ OPTIONAL ] This optional property determins whether the ruby text is printed above/left or below/right of the text.
short CharRotation	[ OPTIONAL ] This optional property determins the rotation of a character in tenths of a degree.
boolean CharRotationIsFitToLine	[ OPTIONAL ] This optional property determins whether the text formatting tries to fit rotated text into the surrounded line height.
short CharScaleWidth	[ OPTIONAL ] This optional property determins the percentage value for scaling the width of characters.
string HyperLinkURL	[ OPTIONAL ] This optional property contains the URL of a hyperlink.
string HyperLinkTarget	[ OPTIONAL ] This optional property contains the name of the target for a hyperlink.
string HyperLinkName	[ OPTIONAL ] This optional property contains the name of the hyperlink.
string VisitedCharStyleName	[ OPTIONAL ] This optional property contains the character style name for visited hyperlinks.
string UnvisitedCharStyleName	[ OPTIONAL ] This optional property contains the character style name for unvisited hyperlinks.
byte CharEscapementHeight	[ OPTIONAL ] This is the relative height used for subscript or superscript characters in units of percent.
boolean CharNoHyphenation	[ OPTIONAL ] This optional property determines if the word can be hyphenated at the character.
::com::sun::star::util::Color CharUnderlineColor	This property contains the color of the underline for the characters.
boolean CharUnderlineHasColor	This property specifies if the property CharUnderlineColor is used for an underline.
sequence< string > CharStyleNames	[ OPTIONAL ] This optional property 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. See also ::com::sun::star::awt::FontFamily

CharFontCharSet

short CharFontCharSet; Description This property contains the text encoding of the font. See also ::com::sun::star::awt::CharSet

CharFontPitch

short CharFontPitch; Description This property contains the font pitch. See also ::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. See also CharEscapementHeight

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 This optional property determines 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 This optional property contains the text background color.

CharBackTransparent

boolean CharBackTransparent; Usage Restrictions optional Description This property determines if the text background color is set to transparent.

CharCaseMap

short CharCaseMap; Usage Restrictions optional Description This optional property 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 characters 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 This property 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 This optional property contains the value of the kerning of the characters.

CharLocale

::com::sun::star::lang::Locale CharLocale; Description This property contains the value of the locale.

CharKeepTogether

boolean CharKeepTogether; Usage Restrictions optional Description This optional property 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 This optional property 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 This optional property specifies if the characters are formatted and displayed with a shadow effect.

CharFontType

short CharFontType; Usage Restrictions optional Description This optional property specifies the fundamental technology of the font. See also ::com::sun::star::awt::FontType

CharStyleName

string CharStyleName; Usage Restrictions optional Description This optional property specifies the name of the style of the font.

CharContoured

boolean CharContoured; Usage Restrictions optional Description This optional property specifies if the characters are formatted and displayed with a contour effect.

CharCombineIsOn

boolean CharCombineIsOn; Usage Restrictions optional Description This optional property determins whether text is formatted in two lines. It is linked to the properties CharCombinePrefix and CharCombineSuffix.

CharCombinePrefix

string CharCombinePrefix; Usage Restrictions optional Description This optional property 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 This optional property 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 This optional property contains the font emphasis value. See also ::com::sun::star::text::FontEmphasis

CharRelief

short CharRelief; Usage Restrictions optional Description This optional property contains the relief style of the characters. See also ::com::sun::star::text::FontRelief

RubyText

string RubyText; Usage Restrictions optional Description This optional property contains the text that is set as ruby.

RubyAdjust

short RubyAdjust; Usage Restrictions optional Description This optional property determins the adjustment of the ruby . See also ::com::sun::star::text::RubyAdjust

RubyCharStyleName

string RubyCharStyleName; Usage Restrictions optional Description This optional property contains the name of the character style that is applied to RubyText.

RubyIsAbove

boolean RubyIsAbove; Usage Restrictions optional Description This optional property determins whether the ruby text is printed above/left or below/right of the text.

CharRotation

short CharRotation; Usage Restrictions optional Description This optional property 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 This optional property determins whether the text formatting tries to fit rotated text into the surrounded line height.

CharScaleWidth

short CharScaleWidth; Usage Restrictions optional Description This optional property 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 This optional property contains the URL of a hyperlink.

HyperLinkTarget

string HyperLinkTarget; Usage Restrictions optional Description This optional property contains the name of the target for a hyperlink.

HyperLinkName

string HyperLinkName; Usage Restrictions optional Description This optional property contains the name of the hyperlink.

VisitedCharStyleName

string VisitedCharStyleName; Usage Restrictions optional Description This optional property contains the character style name for visited hyperlinks.

UnvisitedCharStyleName

string UnvisitedCharStyleName; Usage Restrictions optional Description This optional property contains the character style name for unvisited hyperlinks.

CharEscapementHeight

byte CharEscapementHeight; Usage Restrictions optional Description This is the relative height used for subscript or superscript characters in units of percent. The value 100 denotes the original height of the characters. See also CharEscapement

CharNoHyphenation

boolean CharNoHyphenation; Usage Restrictions optional Description This optional property determines if the word can be hyphenated at the character.

CharUnderlineColor

::com::sun::star::util::Color CharUnderlineColor; Description This property contains the color of the underline for the characters. See also CharUnderlineHasColor

CharUnderlineHasColor

boolean CharUnderlineHasColor; Description This property specifies if the property CharUnderlineColor is used for an underline. See also CharUnderlineColor

CharStyleNames

sequence< string > CharStyleNames; Usage Restrictions optional Description This optional property 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 OOo 1.1.2

CharHidden

boolean CharHidden; Usage Restrictions optional Description If this optional property is true, then the characters are invisible. Since OOo 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

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous