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

import"CharacterProperties.idl";

Inheritance diagram for CharacterProperties:

Public Attributes
string	CharFontName
	This property specifies the name of the font style. More...

string	CharFontStyleName
	This property contains the name of the font style. More...

short	CharFontFamily
	This property contains font family. More...

short	CharFontCharSet
	This property contains the text encoding of the font. More...

short	CharFontPitch
	This property contains the font pitch. More...

com::sun::star::util::Color	CharColor
	This property contains the value of the text color. More...

short	CharEscapement
	specifies the percentage by which to raise/lower superscript/subscript characters. More...

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

short	CharUnderline
	This property contains the value for the character underline. More...

float	CharWeight
	This property contains the value of the font weight. More...

com::sun::star::awt::FontSlant	CharPosture
	This property contains the value of the posture of the document. More...

boolean	CharAutoKerning
	This optional property determines whether the kerning tables from the current font are used. More...

com::sun::star::util::Color	CharBackColor
	This optional property contains the text background color. More...

long	CharShadingValue
	This optional property contains the text shading value. More...

boolean	CharBackTransparent
	This property determines if the text background color is set to transparent. More...

short	CharCaseMap
	This optional property contains the value of the case-mapping of the text for formatting and displaying. More...

boolean	CharCrossedOut
	This property is `TRUE` if the characters are crossed out. More...

boolean	CharFlash
	If this optional property is `TRUE`, then the characters are flashing. More...

short	CharStrikeout
	This property determines the type of the strike out of the character. More...

boolean	CharWordMode
	If this property is `TRUE`, the underline and strike-through properties are not applied to white spaces. More...

short	CharKerning
	This optional property contains the value of the kerning of the characters. More...

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

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

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

boolean	CharShadowed
	This optional property specifies if the characters are formatted and displayed with a shadow effect. More...

short	CharFontType
	This optional property specifies the fundamental technology of the font. More...

string	CharStyleName
	This optional property specifies the name of the style of the font. More...

boolean	CharContoured
	This optional property specifies if the characters are formatted and displayed with a contour effect. More...

boolean	CharCombineIsOn
	This optional property determines whether text is formatted in two lines. More...

string	CharCombinePrefix
	This optional property contains the prefix (usually parenthesis) before text that is formatted in two lines. More...

string	CharCombineSuffix
	This optional property contains the suffix (usually parenthesis) after text that is formatted in two lines. More...

short	CharEmphasis
	This optional property contains the font emphasis value. More...

short	CharRelief
	This optional property contains the relief style of the characters. More...

string	RubyText
	This optional property contains the text that is set as ruby. More...

short	RubyAdjust
	This optional property determines the adjustment of the ruby . More...

string	RubyCharStyleName
	This optional property contains the name of the character style that is applied to RubyText. More...

boolean	RubyIsAbove
	This optional property determines whether the ruby text is printed above/left or below/right of the text. More...

short	CharRotation
	This optional property determines the rotation of a character in tenths of a degree. More...

boolean	CharRotationIsFitToLine
	This optional property determines whether the text formatting tries to fit rotated text into the surrounded line height. More...

short	CharScaleWidth
	This optional property determines the percentage value for scaling the width of characters. More...

string	HyperLinkURL
	This optional property contains the URL of a hyperlink. More...

string	HyperLinkTarget
	This optional property contains the name of the target for a hyperlink. More...

string	HyperLinkName
	This optional property contains the name of the hyperlink. More...

string	VisitedCharStyleName
	This optional property contains the character style name for visited hyperlinks. More...

string	UnvisitedCharStyleName
	This optional property contains the character style name for unvisited hyperlinks. More...

byte	CharEscapementHeight
	This is the relative height used for subscript or superscript characters in units of percent. More...

boolean	CharNoHyphenation
	This optional property determines if the word can be hyphenated at the character by automatic hyphenation. More...

com::sun::star::util::Color	CharUnderlineColor
	This property contains the color of the underline for the characters. More...

boolean	CharUnderlineHasColor
	This property specifies if the property CharUnderlineColor is used for an underline. More...

sequence< string >	CharStyleNames
	This optional property specifies the names of the all styles applied to the font. More...

boolean	CharHidden
	If this optional property is `TRUE`, then the characters are invisible. More...

com::sun::star::container::XNameContainer	TextUserDefinedAttributes
	This property stores XML attributes. More...

com::sun::star::table::BorderLine2	CharLeftBorder
	This property contains the left border of the object. More...

com::sun::star::table::BorderLine2	CharRightBorder
	This property contains the right border of the object. More...

com::sun::star::table::BorderLine2	CharTopBorder
	This property contains the top border of the object. More...

com::sun::star::table::BorderLine2	CharBottomBorder
	This property contains the bottom border of the object. More...

long	CharBorderDistance
	This property contains the distance from the border to the object. More...

long	CharLeftBorderDistance
	This property contains the distance from the left border to the object. More...

long	CharRightBorderDistance
	This property contains the distance from the right border to the object. More...

long	CharTopBorderDistance
	This property contains the distance from the top border to the object. More...

long	CharBottomBorderDistance
	This property contains the distance from the bottom border to the object. More...

com::sun::star::table::ShadowFormat	CharShadowFormat
	Determines the type, color, and width of the shadow. More...

com::sun::star::util::Color	CharHighlight
	Determines the color of the highlight. More...

sequence< com::sun::star::beans::PropertyValue >	CharInteropGrabBag
	Grab bag of character properties, used as a string-any map for interim interop purposes. More...

short	RubyPosition
	This optional property determines the position of the ruby . More...

short	CharTransparence
	This is the transparency of the character text. More...

short	CharColorTheme
	If available, keeps the color theme index, so that the character can be re-colored easily based on a theme. More...

short	CharColorTintOrShade
	Tint or shade of the character color. More...

Detailed Description

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

See also: ParagraphProperties

Developers Guide: Text Documents - Formatting
Text Documents - Ruby

Member Data Documentation

◆ CharAutoKerning

boolean CharAutoKerning

optionalproperty

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

optionalproperty

This optional property contains the text background color.

◆ CharBackTransparent

boolean CharBackTransparent

optionalproperty

This property determines if the text background color is set to transparent.

◆ CharBorderDistance

long CharBorderDistance

optionalproperty

This property contains the distance from the border to the object.

Since: LibreOffice 4.2

◆ CharBottomBorder

com::sun::star::table::BorderLine2 CharBottomBorder

optionalproperty

This property contains the bottom border of the object.

Since: LibreOffice 4.2

◆ CharBottomBorderDistance

long CharBottomBorderDistance

optionalproperty

This property contains the distance from the bottom border to the object.

Since: LibreOffice 4.2

◆ CharCaseMap

short CharCaseMap

optionalproperty

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

See also: CaseMap

◆ CharColor

com::sun::star::util::Color CharColor

property

This property contains the value of the text color.

◆ CharColorTheme

short CharColorTheme

optionalproperty

If available, keeps the color theme index, so that the character can be re-colored easily based on a theme.

Since: LibreOffice 7.3

◆ CharColorTintOrShade

short CharColorTintOrShade

optionalproperty

Tint or shade of the character color.

Since: LibreOffice 7.3

◆ CharCombineIsOn

boolean CharCombineIsOn

optionalproperty

This optional property determines whether text is formatted in two lines.

It is linked to the properties CharCombinePrefix and CharCombineSuffix.

◆ CharCombinePrefix

string CharCombinePrefix

optionalproperty

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

optionalproperty

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.

◆ CharContoured

boolean CharContoured

optionalproperty

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

◆ CharCrossedOut

boolean CharCrossedOut

optionalproperty

This property is TRUE if the characters are crossed out.

◆ CharEmphasis

short CharEmphasis

optionalproperty

This optional property contains the font emphasis value.

See also: com::sun::star::text::FontEmphasis

◆ CharEscapement

short CharEscapement

optionalproperty

specifies the percentage by which to raise/lower superscript/subscript characters.

Negative values denote subscripts and positive values superscripts.

See also: CharEscapementHeight

◆ CharEscapementHeight

byte CharEscapementHeight

optionalproperty

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

◆ CharFlash

boolean CharFlash

optionalproperty

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

◆ CharFontCharSet

short CharFontCharSet

property

This property contains the text encoding of the font.

See also: com::sun::star::awt::CharSet

◆ CharFontFamily

short CharFontFamily

property

This property contains font family.

See also: com::sun::star::awt::FontFamily

◆ CharFontName

string CharFontName

property

This property specifies the name of the font style.

It may contain more than one name separated by comma.

◆ CharFontPitch

short CharFontPitch

property

This property contains the font pitch.

See also: com::sun::star::awt::FontPitch

◆ CharFontStyleName

string CharFontStyleName

property

This property contains the name of the font style.

This property may be empty.

◆ CharFontType

short CharFontType

optionalproperty

This optional property specifies the fundamental technology of the font.

See also: com::sun::star::awt::FontType

◆ CharHeight

float CharHeight

property

This value contains the height of the characters in point.

◆ CharHidden

boolean CharHidden

optionalproperty

If this optional property is TRUE, then the characters are invisible.

Since: OOo 2.0

◆ CharHighlight

com::sun::star::util::Color CharHighlight

optionalproperty

Determines the color of the highlight.

Since: LibreOffice 4.2

◆ CharInteropGrabBag

sequence<com::sun::star::beans::PropertyValue> CharInteropGrabBag

optionalproperty

Grab bag of character properties, used as a string-any map for interim interop purposes.

Since: LibreOffice 4.3

This property is intentionally not handled by the ODF filter. Any member that should be handled there should be first moved out from this grab bag to a separate property.

◆ CharKeepTogether

boolean CharKeepTogether

optionalproperty

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.

◆ CharKerning

short CharKerning

optionalproperty

This optional property contains the value of the kerning of the characters.

◆ CharLeftBorder

com::sun::star::table::BorderLine2 CharLeftBorder

optionalproperty

This property contains the left border of the object.

Since: LibreOffice 4.2

◆ CharLeftBorderDistance

long CharLeftBorderDistance

optionalproperty

This property contains the distance from the left border to the object.

Since: LibreOffice 4.2

◆ CharLocale

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

property

This property contains the value of the locale.

◆ CharNoHyphenation

boolean CharNoHyphenation

optionalproperty

This optional property determines if the word can be hyphenated at the character by automatic hyphenation.

Setting to true will disable hyphenation enabled by ParaIsHyphenation.

Note: implemented since LibreOffice 24.2.

See also: ParaIsHyphenation

◆ CharNoLineBreak

boolean CharNoLineBreak

optionalproperty

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.

◆ CharPosture

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

property

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

See also: com::sun::star::awt::FontSlant

◆ CharRelief

short CharRelief

optionalproperty

This optional property contains the relief style of the characters.

See also: com::sun::star::text::FontRelief

◆ CharRightBorder

com::sun::star::table::BorderLine2 CharRightBorder

optionalproperty

This property contains the right border of the object.

Since: LibreOffice 4.2

◆ CharRightBorderDistance

long CharRightBorderDistance

optionalproperty

This property contains the distance from the right border to the object.

Since: LibreOffice 4.2

◆ CharRotation

short CharRotation

optionalproperty

This optional property determines the rotation of a character in tenths of a degree.

Depending on the implementation only certain values may be allowed.

◆ CharRotationIsFitToLine

boolean CharRotationIsFitToLine

optionalproperty

This optional property determines whether the text formatting tries to fit rotated text into the surrounded line height.

◆ CharScaleWidth

short CharScaleWidth

optionalproperty

This optional property determines 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.

◆ CharShadingValue

long CharShadingValue

optionalproperty

This optional property contains the text shading value.

◆ CharShadowed

boolean CharShadowed

optionalproperty

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

◆ CharShadowFormat

com::sun::star::table::ShadowFormat CharShadowFormat

optionalproperty

Determines the type, color, and width of the shadow.

Since: LibreOffice 4.2

◆ CharStrikeout

short CharStrikeout

optionalproperty

This property determines the type of the strike out of the character.

See also: com::sun::star::awt::FontStrikeout

◆ CharStyleName

string CharStyleName

optionalproperty

This optional property specifies the name of the style of the font.

◆ CharStyleNames

sequence<string> CharStyleNames

optionalproperty

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

◆ CharTopBorder

com::sun::star::table::BorderLine2 CharTopBorder

optionalproperty

This property contains the top border of the object.

Since: LibreOffice 4.2

◆ CharTopBorderDistance

long CharTopBorderDistance

optionalproperty

This property contains the distance from the top border to the object.

Since: LibreOffice 4.2

◆ CharTransparence

short CharTransparence

optionalproperty

This is the transparency of the character text.

Since: LibreOffice 7.0

The value 100 means entirely transparent, while 0 means not transparent at all.

◆ CharUnderline

short CharUnderline

property

This property contains the value for the character underline.

See also: com::sun::star::awt::FontUnderline

◆ CharUnderlineColor

com::sun::star::util::Color CharUnderlineColor

property

This property contains the color of the underline for the characters.

See also: CharUnderlineHasColor

◆ CharUnderlineHasColor

boolean CharUnderlineHasColor

property

This property specifies if the property CharUnderlineColor is used for an underline.

See also: CharUnderlineColor

◆ CharWeight

float CharWeight

property

This property contains the value of the font weight.

See also: com::sun::star::awt::FontWeight

◆ CharWordMode

boolean CharWordMode

optionalproperty

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

◆ HyperLinkName

string HyperLinkName

optionalproperty

This optional property contains the name of the hyperlink.

◆ HyperLinkTarget

string HyperLinkTarget

optionalproperty

This optional property contains the name of the target for a hyperlink.

◆ HyperLinkURL

string HyperLinkURL

optionalproperty

This optional property contains the URL of a hyperlink.

◆ RubyAdjust

short RubyAdjust

optionalproperty

This optional property determines the adjustment of the ruby .

See also: com::sun::star::text::RubyAdjust

◆ RubyCharStyleName

string RubyCharStyleName

optionalproperty

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

◆ RubyIsAbove

boolean RubyIsAbove

optionalproperty

This optional property determines whether the ruby text is printed above/left or below/right of the text.

This property is replaced by RubyPosition.

Deprecated:

◆ RubyPosition

short RubyPosition

optionalproperty

This optional property determines the position of the ruby .

See also: com::sun::star::text::RubyPosition

Since: LibreOffice 6.1

◆ RubyText

string RubyText

optionalproperty

This optional property contains the text that is set as ruby.

◆ TextUserDefinedAttributes

com::sun::star::container::XNameContainer TextUserDefinedAttributes

optionalproperty

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

◆ UnvisitedCharStyleName

string UnvisitedCharStyleName

optionalproperty

This optional property contains the character style name for unvisited hyperlinks.

◆ VisitedCharStyleName

string VisitedCharStyleName

optionalproperty

This optional property contains the character style name for visited hyperlinks.

The documentation for this service was generated from the following file:

com/sun/star/style/CharacterProperties.idl

Public Attributes

Detailed Description

Member Data Documentation

◆ CharAutoKerning

◆ CharBackColor

◆ CharBackTransparent

◆ CharBorderDistance

◆ CharBottomBorder

◆ CharBottomBorderDistance

◆ CharCaseMap

◆ CharColor

◆ CharColorTheme

◆ CharColorTintOrShade

◆ CharCombineIsOn

◆ CharCombinePrefix

◆ CharCombineSuffix

◆ CharContoured

◆ CharCrossedOut

◆ CharEmphasis

◆ CharEscapement

◆ CharEscapementHeight

◆ CharFlash

◆ CharFontCharSet

◆ CharFontFamily

◆ CharFontName

◆ CharFontPitch

◆ CharFontStyleName

◆ CharFontType

◆ CharHeight

◆ CharHidden

◆ CharHighlight

◆ CharInteropGrabBag

◆ CharKeepTogether

◆ CharKerning

◆ CharLeftBorder

◆ CharLeftBorderDistance

◆ CharLocale

◆ CharNoHyphenation

◆ CharNoLineBreak

◆ CharPosture

◆ CharRelief

◆ CharRightBorder

◆ CharRightBorderDistance

◆ CharRotation

◆ CharRotationIsFitToLine

◆ CharScaleWidth

◆ CharShadingValue

◆ CharShadowed

◆ CharShadowFormat

◆ CharStrikeout

◆ CharStyleName

◆ CharStyleNames

◆ CharTopBorder

◆ CharTopBorderDistance

◆ CharTransparence

◆ CharUnderline

◆ CharUnderlineColor

◆ CharUnderlineHasColor

◆ CharWeight

◆ CharWordMode

◆ HyperLinkName

◆ HyperLinkTarget

◆ HyperLinkURL

◆ RubyAdjust

◆ RubyCharStyleName

◆ RubyIsAbove

◆ RubyPosition

◆ RubyText

◆ TextUserDefinedAttributes

◆ UnvisitedCharStyleName

◆ VisitedCharStyleName