specifies a style sheet for characters within a com::sun::star::text::Text. More...

import"CharacterStyle.idl";

Inheritance diagram for CharacterStyle:

Included Services
service	Style
	specifies administrative properties. More...

service	CharacterProperties
	specifies the style properties. More...

Included Services inherited from Style
service	com::sun::star::xml::UserDefinedAttributesSupplier
	contains user defined attributes. More...

Public Attributes
float	CharDiffHeight
	This value contains the character height as difference in point to the height of the character in the parent style. More...

short	CharPropHeight
	This value contains the character height as percentage value relative to the height of the character in the parent style. More...

float	CharDiffHeightAsian
	This value contains the character height as difference in point to the height of the character in the parent style in Asian text. More...

short	CharPropHeightAsian
	This value contains the character height as percentage value relative to the height of the character in the parent style in Asian text. More...

float	CharDiffHeightComplex
	This value contains the character height as difference in point to the height of the character in the parent style in complex text. More...

short	CharPropHeightComplex
	This value contains the character height as percentage value relative to the height of the character in the parent style in complex text. More...

Public Attributes inherited from Style
boolean	IsPhysical
	determines if a style is physically created. More...

string	FollowStyle
	contains the name of the style that is applied to the next paragraph. More...

string	DisplayName
	contains the name of the style as it is displayed in the user interface. More...

string	IsAutoUpdate
	determines if a style is automatically updated, if the properties of an object that the style is applied to are changed. More...

sequence< com::sun::star::beans::NamedValue >	ParaStyleConditions
	defines the context and styles for conditional paragraphs. More...

boolean	Hidden
	Flag indicating whether to hide the style in the UI. More...

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

Public Attributes inherited from CharacterProperties
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...

Additional Inherited Members
Exported Interfaces inherited from Style
interface	com::sun::star::style::XStyle

interface	com::sun::star::beans::XPropertySet

interface	com::sun::star::beans::XMultiPropertySet

interface	com::sun::star::beans::XMultiPropertyStates

Public Member Functions inherited from XStyle
boolean	isUserDefined ()
	identifies a style as defined by the user. More...

boolean	isInUse ()

string	getParentStyle ()

void	setParentStyle ([in] string aParentStyle) raises ( com::sun::star::container::NoSuchElementException )
	sets the name of the parent style. More...

Public Member Functions inherited from XNamed
string	getName ()

void	setName ([in] string aName)
	sets the programmatic name of the object. More...

Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...

void	acquire ()
	increases the reference counter by one. More...

void	release ()
	decreases the reference counter by one. More...

Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()

void	setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the value of the property with the specified name. More...

any	getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )

void	addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XPropertyChangeListener to the specified property. More...

void	removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XPropertyChangeListener from the listener list. More...

void	addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XVetoableChangeListener to the specified property with the name PropertyName. More...

void	removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XVetoableChangeListener from the listener list. More...

Protected Member Functions inherited from XStyle
boolean	isUserDefined ()
	identifies a style as defined by the user. More...

boolean	isInUse ()

string	getParentStyle ()

void	setParentStyle ([in] string aParentStyle) raises ( com::sun::star::container::NoSuchElementException )
	sets the name of the parent style. More...

Protected Member Functions inherited from XNamed
string	getName ()

void	setName ([in] string aName)
	sets the programmatic name of the object. More...

Protected Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...

void	acquire ()
	increases the reference counter by one. More...

void	release ()
	decreases the reference counter by one. More...

Protected Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()

void	setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the value of the property with the specified name. More...

any	getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )

void	addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XPropertyChangeListener to the specified property. More...

void	removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XPropertyChangeListener from the listener list. More...

void	addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XVetoableChangeListener to the specified property with the name PropertyName. More...

void	removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XVetoableChangeListener from the listener list. More...

Protected Member Functions inherited from XMultiPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()

void	setPropertyValues ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the values to the properties with the specified names. More...

sequence< any >	getPropertyValues ([in] sequence< string > aPropertyNames)

void	addPropertiesChangeListener ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
	adds an XPropertiesChangeListener to the specified property with the specified names. More...

void	removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener)
	removes an XPropertiesChangeListener from the listener list. More...

void	firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
	fires a sequence of PropertyChangeEvents to the specified listener. More...

Protected Member Functions inherited from XMultiPropertyStates
sequence< com::sun::star::beans::PropertyState >	getPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )

void	setAllPropertiesToDefault ()
	sets all properties to their default values. More...

void	setPropertiesToDefault ([in] sequence< string > aPropertyNames) raises ( com::sun::star::beans::UnknownPropertyException )
	sets the specified properties to their default values. More...

sequence< any >	getPropertyDefaults ([in] sequence< string > aPropertyNames) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )

Protected Attributes inherited from UserDefinedAttributesSupplier
::com::sun::star::container::XNameContainer	UserDefinedAttributes
	This container holds the AttributeData elements that represent uninterpreted XML attributes. More...

Detailed Description

specifies a style sheet for characters within a com::sun::star::text::Text.

Exported Interfaces

◆ CharacterProperties

service CharacterProperties

specifies the style properties.

◆ Style

service Style

specifies administrative properties.

Member Data Documentation

◆ CharDiffHeight

float CharDiffHeight

property

This value contains the character height as difference in point to the height of the character in the parent style.

◆ CharDiffHeightAsian

float CharDiffHeightAsian

property

This value contains the character height as difference in point to the height of the character in the parent style in Asian text.

◆ CharDiffHeightComplex

float CharDiffHeightComplex

property

This value contains the character height as difference in point to the height of the character in the parent style in complex text.

◆ CharPropHeight

short CharPropHeight

property

This value contains the character height as percentage value relative to the height of the character in the parent style.

◆ CharPropHeightAsian

short CharPropHeightAsian

property

This value contains the character height as percentage value relative to the height of the character in the parent style in Asian text.

◆ CharPropHeightComplex

short CharPropHeightComplex

property

This value contains the character height as percentage value relative to the height of the character in the parent style in complex text.

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

com/sun/star/style/CharacterStyle.idl

Included Services

Public Attributes

Additional Inherited Members

Detailed Description

Exported Interfaces

◆ CharacterProperties

◆ Style

Member Data Documentation

◆ CharDiffHeight

◆ CharDiffHeightAsian

◆ CharDiffHeightComplex

◆ CharPropHeight

◆ CharPropHeightAsian

◆ CharPropHeightComplex