Properties' 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 ]
specifies the percentage of raisement/lowerment of superscript/subscript
characters.
|
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 ]
optional property to determine whether the kerning tables from the current font are used.
|
CharBackColor |
[ OPTIONAL ]
optional property which contains the text background color.
|
CharBackTransparent |
[ OPTIONAL ]
determines if the text background color is set to transparent.
|
CharCaseMap |
[ OPTIONAL ]
optional property which contains the value of the case-mapping of the
text for formatting and displaying.
|
CharCrossedOut |
[ OPTIONAL ]
This property is true if the character(s) is(are) crossed out.
|
CharFlash |
[ OPTIONAL ]
If this optional property is true , then the characters are flashing.
|
CharStrikeout |
[ OPTIONAL ]
determins the type of the strike out of the character.
|
CharWordMode |
[ OPTIONAL ]
If this property is true , the underline and strike-through
properties are not applied to white spaces.
|
CharKerning |
[ OPTIONAL ]
optional property which contains the value of the kerning of the characters.
|
CharLocale |
contains the value of the locale.
|
CharKeepTogether |
[ OPTIONAL ]
optional property which marks a range of characters to prevent it from being broken into two lines.
|
CharNoLineBreak |
[ OPTIONAL ]
optional property which marks a range of characters to ignore a line break in this area.
|
CharShadowed |
[ OPTIONAL ]
specifies if the characters are formatted and
displayed with a shadow effect.
|
CharFontType |
[ OPTIONAL ]
optional property which specifies the fundamental technology of the font.
|
CharStyleName |
[ OPTIONAL ]
specifies the name of the style of the font.
|
CharContoured |
[ OPTIONAL ]
specifies if the characters are formatted and
displayed with a contour effect.
|
CharCombineIsOn |
[ OPTIONAL ]
determins whether text is formatted in two lines.
|
CharCombinePrefix |
[ OPTIONAL ]
contains the prefix (usually parenthesis) before text that is formatted in two lines.
|
CharCombineSuffix |
[ OPTIONAL ]
contains the suffix (usually parenthesis) after text that is formatted in two lines.
|
CharEmphasize |
[ OPTIONAL ]
contains the font emphasis value as ::com::sun::star::text::FontEmphasis .
|
CharRelief |
[ OPTIONAL ]
contains the relief value as ::com::sun::star::text::FontRelief .
|
RubyText |
[ OPTIONAL ]
contains the text that is set as ruby.
|
RubyAdjust |
[ OPTIONAL ]
determins the adjustment of the ruby text as ::com::sun::star::text::RubyAdjust .
|
RubyCharStyleName |
[ OPTIONAL ]
contains the name of the character style that is applied to RubyText.
|
RubyIsAbove |
[ OPTIONAL ]
determins whether the ruby text is printed above/left or below/right of the text.
|
CharRotation |
[ OPTIONAL ]
determins the rotation of a character in degree.
|
CharRotationIsFitToLine |
[ OPTIONAL ]
determins whether the text formatting tries to fit rotated text into the
surrounded line height.
|
CharScaleWidth |
[ OPTIONAL ]
determins the percentage value of scaling of characters.
|
HyperLinkURL |
[ OPTIONAL ]
contains the URL of a hyperlink (if set).
|
HyperLinkTarget |
[ OPTIONAL ]
contains the name of the target for a hyperlink (if set).
|
HyperLinkName |
[ OPTIONAL ]
contains the name of the hyperlink (if set).
|
VisitedCharStyleName |
[ OPTIONAL ]
contains the character style name for visited hyperlinks.
|
UnvisitedCharStyleName |
[ OPTIONAL ]
contains the character style name for unvisited hyperlinks.
|
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.
|
CharNoHyphenation |
[ OPTIONAL ]
determines if the word can be hyphenated at the character.
|
CharUnderlineColor |
gives the color of the underline for that character.
|
CharUnderlineHasColor |
specifies if the CharUnderlineColor is used for an underline.
|
CharStyleNames |
[ OPTIONAL ]
specifies the names of the all styles applied to the font.
|
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
long CharColor;
- Description
- This property contains the value of the text color.
|
|
CharEscapement
short CharEscapement;
- [ OPTIONAL ]
- Description
- specifies the percentage of raisement/lowerment of superscript/subscript
characters.
Negative values lower the character.
|
|
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;
- [ 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
long CharBackColor;
- [ OPTIONAL ]
- Description
- optional property which contains the text background color.
|
|
CharBackTransparent
boolean CharBackTransparent;
- [ OPTIONAL ]
- Description
- determines if the text background color is set to transparent.
|
|
CharCaseMap
short CharCaseMap;
- [ 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;
- [ OPTIONAL ]
- Description
- This property is true if the character(s) is(are) crossed out.
|
|
CharFlash
boolean CharFlash;
- [ OPTIONAL ]
- Description
- If this optional property is true , then the characters are flashing.
|
|
CharStrikeout
|
CharWordMode
boolean CharWordMode;
- [ OPTIONAL ]
- Description
- If this property is true , the underline and strike-through
properties are not applied to white spaces.
|
|
CharKerning
short CharKerning;
- [ 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;
- [ 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;
- [ 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;
- [ OPTIONAL ]
- Description
- specifies if the characters are formatted and
displayed with a shadow effect.
|
|
CharFontType
short CharFontType;
- [ OPTIONAL ]
- Description
- optional property which specifies the fundamental technology of the font.
- See also
- ::com::sun::star::awt::FontType
|
|
CharStyleName
string CharStyleName;
- [ OPTIONAL ]
- Description
- specifies the name of the style of the font.
|
|
CharContoured
boolean CharContoured;
- [ OPTIONAL ]
- Description
- specifies if the characters are formatted and
displayed with a contour effect.
|
|
CharCombineIsOn
boolean CharCombineIsOn;
- [ OPTIONAL ]
- Description
- determins whether text is formatted in two lines.
It is linked to the properties CharCombinePrefix and CharCombineSuffix.
|
|
CharCombinePrefix
string CharCombinePrefix;
- [ 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;
- [ OPTIONAL ]
- Description
- contains the suffix (usually parenthesis) after text that is formatted in two lines.
It is linked to the properties CharCombineIsOn and CharCombinePrefix.
|
|
CharEmphasize
short CharEmphasize;
- [ OPTIONAL ]
- Description
- contains the font emphasis value as ::com::sun::star::text::FontEmphasis .
|
|
CharRelief
short CharRelief;
- [ OPTIONAL ]
- Description
- contains the relief value as ::com::sun::star::text::FontRelief .
|
|
RubyText
string RubyText;
- [ OPTIONAL ]
- Description
- contains the text that is set as ruby.
|
|
RubyAdjust
short RubyAdjust;
- [ OPTIONAL ]
- Description
- determins the adjustment of the ruby text as ::com::sun::star::text::RubyAdjust .
|
|
RubyCharStyleName
string RubyCharStyleName;
- [ OPTIONAL ]
- Description
- contains the name of the character style that is applied to RubyText.
|
|
RubyIsAbove
boolean RubyIsAbove;
- [ OPTIONAL ]
- Description
- determins whether the ruby text is printed above/left or below/right of the text.
|
|
CharRotation
short CharRotation;
- [ OPTIONAL ]
- Description
- determins the rotation of a character in degree.
Depending on the implementation only certain values may be allowed.
|
|
CharRotationIsFitToLine
boolean CharRotationIsFitToLine;
- [ OPTIONAL ]
- Description
- determins whether the text formatting tries to fit rotated text into the
surrounded line height.
|
|
CharScaleWidth
short CharScaleWidth;
- [ OPTIONAL ]
- Description
- determins the percentage value of scaling of characters.
This is used for superscript/subscript
- See also
- CharacterProperties::CharEscapement
|
|
HyperLinkURL
string HyperLinkURL;
- [ OPTIONAL ]
- Description
- contains the URL of a hyperlink (if set).
|
|
HyperLinkTarget
string HyperLinkTarget;
- [ OPTIONAL ]
- Description
- contains the name of the target for a hyperlink (if set).
|
|
HyperLinkName
string HyperLinkName;
- [ OPTIONAL ]
- Description
- contains the name of the hyperlink (if set).
|
|
VisitedCharStyleName
string VisitedCharStyleName;
- [ OPTIONAL ]
- Description
- contains the character style name for visited hyperlinks.
|
|
UnvisitedCharStyleName
string UnvisitedCharStyleName;
- [ OPTIONAL ]
- Description
- contains the character style name for unvisited hyperlinks.
|
|
CharEscapementHeight
byte CharEscapementHeight;
- [ 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;
- [ OPTIONAL ]
- Description
- determines if the word can be hyphenated at the character.
|
|
CharUnderlineColor
long 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;
- [ 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 version
- OpenOffice.org 1.1
|
|
Copyright © 2003 Sun Microsystems, Inc.