service CharacterProperties in module com::sun::star::style::

(Global Index)

Syntax

service CharacterProperties;

Description

This is a set of properties to describe the style of characters.

See also

ParagraphProperties

Property Summary

CharFontName This property specifies the name of the font style.

CharFontStyleName This property contains the name of the font style.

CharFontFamily This property contains font family as specified in com.sun.star.awt.FontFamily .

CharFontCharSet This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet.

CharFontPitch This property contains the font pitch as specified in com.sun.star.awt.FontPitch.

CharColor This property contains the value of the text color.

CharEscapement optional property which contains the relative value of the character height in subscription or superscription. @optional

CharHeight This value contains the height of the characters in point.

CharUnderline This property contains the value for the character underline.

CharWeight This property contains the value of the font weight.

CharPosture This property contains the value of the posture of the document.

CharAutoKerning optional property to determine whether the kerning tables from the current font are used.

CharBackColor optional property which contains the text background color. @optional

CharBackTransparent determines if the text background color is set to transparent.

CharCaseMap optional property which contains the value of the case-mapping of the text for formatting and displaying. @optional

CharCrossedOut This property is true if the character(s) is(are) crossed out. @optional

CharFlash If this optional property is true , then the characters are flashing. @optional

CharStrikeout determins the type of the strike out of the character.

CharWordMode If this property is true , the underline and strike-through properties are not applied to white spaces. @optional

CharKerning optional property which contains the value of the kerning of the characters. @optional

CharLocale contains the value of the locale.

CharKeepTogether optional property which marks a range of characters to prevent it from being broken into two lines.

CharNoLineBreak optional property which marks a range of characters to ignore a line break in this area.

CharShadowed specifies if the characters are formatted and displayed with a shadow effect. @optional

CharFontType optional property which specifies the fundamental technology of the font. @optional

CharStyleName specifies the name of the style of the font.

CharContoured specifies if the characters are formatted and displayed with a contour effect. @optional

CharCombineIsOn determins whether text is formatted in two lines.

CharCombinePrefix contains the prefix (usually parenthesis) before text that is formatted in two lines.

CharCombineSuffix contains the suffix (usually parenthesis) after text that is formatted in two lines.

CharEmphasize contains the font emphasis value as FontEmphasis . @optional

CharRelief contains the relief value as FontRelief . @optional

RubyText contains the text that is set as ruby. @optional

RubyAdjust determins the adjustment of the ruby text as RubyAdjust . @optional

RubyCharStyleName contains the name of the character style that is applied to RubyText. @optional

RubyIsAbove determins whether the ruby text is printed above/left or below/right of the text. @optional

CharRotation determins the rotation of a character in degree.

CharRotationIsFitToLine determins whether the text formatting tries to fit rotated text into the surrounded line height. @optional

CharScaleWidth determins the percentage value of scaling of characters. @optional

Property Details



CharFontName

Syntax

string CharFontName;

Description

This property specifies the name of the font style.

It may contain more than one name separated by comma.


CharFontStyleName

Syntax

string CharFontStyleName;

Description

This property contains the name of the font style.

This property may be empty.


CharFontFamily

Syntax

short CharFontFamily;

Description

This property contains font family as specified in com.sun.star.awt.FontFamily .


CharFontCharSet

Syntax

short CharFontCharSet;

Description

This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet.


CharFontPitch

Syntax

short CharFontPitch;

Description

This property contains the font pitch as specified in com.sun.star.awt.FontPitch.


CharColor

Syntax

long CharColor;

Description

This property contains the value of the text color.


CharEscapement [ O P T I O N A L ]

Syntax

short CharEscapement;

Description

optional property which contains the relative value of the character height in subscription or superscription. @optional


CharHeight

Syntax

float CharHeight;

Description

This value contains the height of the characters in point.


CharUnderline

Syntax

short CharUnderline;

Description

This property contains the value for the character underline.

See also

FontUnderline

CharWeight

Syntax

float CharWeight;

Description

This property contains the value of the font weight.

See also

FontWeight

CharPosture

Syntax

com::sun::star::awt::FontSlant CharPosture;

Description

This property contains the value of the posture of the document.

See also

FontSlant

CharAutoKerning [ O P T I O N A L ]

Syntax

boolean CharAutoKerning;

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.

@optional

CharBackColor [ O P T I O N A L ]

Syntax

long CharBackColor;

Description

optional property which contains the text background color. @optional


CharBackTransparent [ O P T I O N A L ]

Syntax

boolean CharBackTransparent;

Description

determines if the text background color is set to transparent.


CharCaseMap [ O P T I O N A L ]

Syntax

short CharCaseMap;

Description

optional property which contains the value of the case-mapping of the text for formatting and displaying. @optional

See also

CaseMap

CharCrossedOut [ O P T I O N A L ]

Syntax

boolean CharCrossedOut;

Description

This property is true if the character(s) is(are) crossed out. @optional


CharFlash [ O P T I O N A L ]

Syntax

boolean CharFlash;

Description

If this optional property is true , then the characters are flashing. @optional


CharStrikeout [ O P T I O N A L ]

Syntax

short CharStrikeout;

Description

determins the type of the strike out of the character.

See also

com.sun.star.awt.FontStrikeout

CharWordMode [ O P T I O N A L ]

Syntax

boolean CharWordMode;

Description

If this property is true , the underline and strike-through properties are not applied to white spaces. @optional


CharKerning [ O P T I O N A L ]

Syntax

short CharKerning;

Description

optional property which contains the value of the kerning of the characters. @optional


CharLocale

Syntax

com::sun::star::lang::Locale CharLocale;

Description

contains the value of the locale.


CharKeepTogether [ O P T I O N A L ]

Syntax

boolean CharKeepTogether;

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.

@optional

CharNoLineBreak [ O P T I O N A L ]

Syntax

boolean CharNoLineBreak;

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.

@optional

CharShadowed [ O P T I O N A L ]

Syntax

boolean CharShadowed;

Description

specifies if the characters are formatted and displayed with a shadow effect. @optional


CharFontType [ O P T I O N A L ]

Syntax

short CharFontType;

Description

optional property which specifies the fundamental technology of the font. @optional

See also

FontType

CharStyleName [ O P T I O N A L ]

Syntax

string CharStyleName;

Description

specifies the name of the style of the font.


CharContoured [ O P T I O N A L ]

Syntax

boolean CharContoured;

Description

specifies if the characters are formatted and displayed with a contour effect. @optional


CharCombineIsOn [ O P T I O N A L ]

Syntax

boolean CharCombineIsOn;

Description

determins whether text is formatted in two lines.

It is linked to the properties CharCombinePrefix and CharCombineSuffix.

@optional

CharCombinePrefix [ O P T I O N A L ]

Syntax

string CharCombinePrefix;

Description

contains the prefix (usually parenthesis) before text that is formatted in two lines.

It is linked to the properties CharCombineIsOn and CharCombineSuffix.

@optional

CharCombineSuffix [ O P T I O N A L ]

Syntax

string CharCombineSuffix;

Description

contains the suffix (usually parenthesis) after text that is formatted in two lines.

It is linked to the properties CharCombineIsOn and CharCombinePrefix.

@optional

CharEmphasize [ O P T I O N A L ]

Syntax

short CharEmphasize;

Description

contains the font emphasis value as FontEmphasis . @optional


CharRelief [ O P T I O N A L ]

Syntax

short CharRelief;

Description

contains the relief value as FontRelief . @optional


RubyText [ O P T I O N A L ]

Syntax

string RubyText;

Description

contains the text that is set as ruby. @optional


RubyAdjust [ O P T I O N A L ]

Syntax

short RubyAdjust;

Description

determins the adjustment of the ruby text as RubyAdjust . @optional


RubyCharStyleName [ O P T I O N A L ]

Syntax

string RubyCharStyleName;

Description

contains the name of the character style that is applied to RubyText. @optional


RubyIsAbove [ O P T I O N A L ]

Syntax

boolean RubyIsAbove;

Description

determins whether the ruby text is printed above/left or below/right of the text. @optional


CharRotation [ O P T I O N A L ]

Syntax

short CharRotation;

Description

determins the rotation of a character in degree.

Depending on the implementation only certain values may be allowed.

@optional

CharRotationIsFitToLine [ O P T I O N A L ]

Syntax

boolean CharRotationIsFitToLine;

Description

determins whether the text formatting tries to fit rotated text into the surrounded line height. @optional


CharScaleWidth [ O P T I O N A L ]

Syntax

short CharScaleWidth;

Description

determins the percentage value of scaling of characters. @optional

Top of Page