Interface XReportControlFormat

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

:: com :: sun :: star :: report ::

interface XReportControlFormat

Description: specifies a format condition for a control.

Attributes' Summary
ControlBackground	specifies the background color (RGB) of the control.
ControlBackgroundTransparent	determines if the back ground color is set to transparent.
ParaAdjust	specifies the horizontal alignment of the text.
FontDescriptor	specifies the font attributes of the text in the control.
FontDescriptorAsian	specifies the font attributes of the text in the control.
FontDescriptorComplex	specifies the font attributes of the text in the control.
ControlTextEmphasis	specifies the ::com::sun::star::text::FontEmphasis value of the text in the control.
CharEmphasis	contains the font emphasis value as ::com::sun::star::text::FontEmphasis.
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.
CharHidden	If this optional property is true, then the characters are invisible.
CharShadowed	specifies if the characters are formatted and displayed with a shadow effect.
CharContoured	specifies if the characters are formatted and displayed with a contour effect.
CharCaseMap	optional property which contains the value of the case-mapping of the text for formatting and displaying.
CharLocale	contains the value of the locale.
CharEscapement	specifies the percentage of raisement/lowerment of superscript/subscript characters.
CharEscapementHeight	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.
CharAutoKerning	optional property to determine whether the kerning tables from the current font are used.
CharKerning	optional property which contains the value of the kerning of the characters.
CharFlash	If this optional property is true, then the characters are flashing.
CharRelief	specifies the ::com::sun::star::text::FontRelief value of the text in the control.
CharFontName	This attribute specifies the name of the font style.
CharFontStyleName	This attribute contains the name of the font style.
CharFontFamily	This attribute contains font family as specified in com.sun.star.awt.FontFamily .
CharFontCharSet	This attribute contains the text encoding of the font as specified in com.sun.star.awt.CharSet.
CharFontPitch	This attribute contains the font pitch as specified in com.sun.star.awt.FontPitch.
CharColor	specifies the text color (RGB) of the control.
CharUnderlineColor	specifies the text line color (RGB) of the control.
CharHeight	This value contains the height of the characters in point.
CharUnderline	This attribute contains the value for the character underline.
CharWeight	This attribute contains the value of the font weight.
CharPosture	This attribute contains the value of the posture of the document.
CharStrikeout	determins the type of the strike out of the character.
CharWordMode	If this attribute is true, the underline and strike-through properties are not applied to white spaces.
CharRotation	determins the rotation of a character in degree.
CharScaleWidth	determins the percentage value for scaling the width of characters.
VerticalAlign	specifies the vertical alignment of the text in the control.
HyperLinkURL	contains the URL of a hyperlink (if set).
HyperLinkTarget	contains the name of the target for a hyperlink (if set).
HyperLinkName	contains the name of the hyperlink (if set).
VisitedCharStyleName	contains the character style name for visited hyperlinks.
UnvisitedCharStyleName	contains the character style name for unvisited hyperlinks.
CharHeightAsian	This value contains the height of the characters in point.
CharWeightAsian	This property contains the value of the font weight.
CharFontNameAsian	This property specifies the name of the font style.
CharFontStyleNameAsian	This property contains the name of the font style.
CharFontFamilyAsian	This property contains font family as specified in com.sun.star.awt.FontFamily .
CharFontCharSetAsian	This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet.
CharFontPitchAsian	This property contains the font pitch as specified in com.sun.star.awt.FontPitch.
CharPostureAsian	This property contains the value of the posture of the document.
CharLocaleAsian	contains the value of the locale.
CharHeightComplex	This value contains the height of the characters in point.
CharWeightComplex	This property contains the value of the font weight.
CharFontNameComplex	This property specifies the name of the font style.
CharFontStyleNameComplex	This property contains the name of the font style.
CharFontFamilyComplex	This property contains font family as specified in com.sun.star.awt.FontFamily .
CharFontCharSetComplex	This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet.
CharFontPitchComplex	This property contains the font pitch as specified in com.sun.star.awt.FontPitch.
CharPostureComplex	This property contains the value of the posture of the document.
CharLocaleComplex	contains the value of the locale.

Attributes' Details

ControlBackground

[ bound ] ::com::sun::star::util::Color ControlBackground get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description specifies the background color (RGB) of the control.

ControlBackgroundTransparent

[ bound ] boolean ControlBackgroundTransparent get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description determines if the back ground color is set to transparent.

ParaAdjust

[ bound ] short ParaAdjust get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description specifies the horizontal alignment of the text. See also ::com::sun::star::style::ParagraphAdjust

FontDescriptor

[ bound ] ::com::sun::star::awt::FontDescriptor FontDescriptor get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description specifies the font attributes of the text in the control.

FontDescriptorAsian

[ bound ] ::com::sun::star::awt::FontDescriptor FontDescriptorAsian get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description specifies the font attributes of the text in the control.

FontDescriptorComplex

[ bound ] ::com::sun::star::awt::FontDescriptor FontDescriptorComplex get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description specifies the font attributes of the text in the control.

ControlTextEmphasis

[ bound ] short ControlTextEmphasis get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description specifies the ::com::sun::star::text::FontEmphasis value of the text in the control.

CharEmphasis

[ bound ] short CharEmphasis get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description contains the font emphasis value as ::com::sun::star::text::FontEmphasis.

CharCombineIsOn

[ bound ] boolean CharCombineIsOn get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description determins whether text is formatted in two lines. It is linked to the properties CharCombinePrefix and CharCombineSuffix.

CharCombinePrefix

[ bound ] string CharCombinePrefix get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description contains the prefix (usually parenthesis) before text that is formatted in two lines. It is linked to the properties CharCombineIsOn and CharCombineSuffix.

CharCombineSuffix

[ bound ] string CharCombineSuffix get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description contains the suffix (usually parenthesis) after text that is formatted in two lines. It is linked to the properties CharCombineIsOn and CharCombinePrefix.

CharHidden

[ bound ] boolean CharHidden get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description If this optional property is true, then the characters are invisible. Since OOo 2.0

CharShadowed

[ bound ] boolean CharShadowed get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description specifies if the characters are formatted and displayed with a shadow effect.

CharContoured

[ bound ] boolean CharContoured get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description specifies if the characters are formatted and displayed with a contour effect.

CharCaseMap

[ bound ] short CharCaseMap get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description optional property which contains the value of the case-mapping of the text for formatting and displaying. See also CaseMap

CharLocale

[ bound ] ::com::sun::star::lang::Locale CharLocale get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description contains the value of the locale.

CharEscapement

[ bound ] short CharEscapement get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description specifies the percentage of raisement/lowerment of superscript/subscript characters. Negative values denote subscripts and positive values superscripts.

CharEscapementHeight

[ bound ] byte CharEscapementHeight get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); 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.

CharAutoKerning

[ bound ] boolean CharAutoKerning get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); 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.

CharKerning

[ bound ] short CharKerning get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description optional property which contains the value of the kerning of the characters.

CharFlash

[ bound ] boolean CharFlash get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description If this optional property is true, then the characters are flashing.

CharRelief

[ bound ] short CharRelief get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description specifies the ::com::sun::star::text::FontRelief value of the text in the control.

CharFontName

[ bound ] string CharFontName get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This attribute specifies the name of the font style. It may contain more than one name separated by comma.

CharFontStyleName

[ bound ] string CharFontStyleName get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This attribute contains the name of the font style. This attribute may be empty.

CharFontFamily

[ bound ] short CharFontFamily get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This attribute contains font family as specified in com.sun.star.awt.FontFamily .

CharFontCharSet

[ bound ] short CharFontCharSet get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This attribute contains the text encoding of the font as specified in com.sun.star.awt.CharSet.

CharFontPitch

[ bound ] short CharFontPitch get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This attribute contains the font pitch as specified in com.sun.star.awt.FontPitch.

CharColor

[ bound ] ::com::sun::star::util::Color CharColor get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description specifies the text color (RGB) of the control.

CharUnderlineColor

[ bound ] ::com::sun::star::util::Color CharUnderlineColor get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description specifies the text line color (RGB) of the control.

CharHeight

[ bound ] float CharHeight get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This value contains the height of the characters in point.

CharUnderline

[ bound ] short CharUnderline get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This attribute contains the value for the character underline. See also ::com::sun::star::awt::FontUnderline

CharWeight

[ bound ] float CharWeight get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This attribute contains the value of the font weight. See also ::com::sun::star::awt::FontWeight

CharPosture

[ bound ] ::com::sun::star::awt::FontSlant CharPosture get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This attribute contains the value of the posture of the document. See also ::com::sun::star::awt::FontSlant

CharStrikeout

[ bound ] short CharStrikeout get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description determins the type of the strike out of the character. See also com.sun.star.awt.FontStrikeout

CharWordMode

[ bound ] boolean CharWordMode get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description If this attribute is true, the underline and strike-through properties are not applied to white spaces.

CharRotation

[ bound ] short CharRotation get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description determins the rotation of a character in degree. Depending on the implementation only certain values may be allowed.

CharScaleWidth

[ bound ] short CharScaleWidth get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description 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.

VerticalAlign

[ bound ] ::com::sun::star::style::VerticalAlignment VerticalAlign get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::lang::IllegalArgumentException,::com::sun::star::beans::UnknownPropertyException); Description specifies the vertical alignment of the text in the control. See also ::com::sun::star::style::VerticalAlignment

HyperLinkURL

[ bound ] string HyperLinkURL get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description contains the URL of a hyperlink (if set).

HyperLinkTarget

[ bound ] string HyperLinkTarget get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description contains the name of the target for a hyperlink (if set).

HyperLinkName

[ bound ] string HyperLinkName get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description contains the name of the hyperlink (if set).

VisitedCharStyleName

[ bound ] string VisitedCharStyleName get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description contains the character style name for visited hyperlinks.

UnvisitedCharStyleName

[ bound ] string UnvisitedCharStyleName get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description contains the character style name for unvisited hyperlinks.

CharHeightAsian

[ bound ] float CharHeightAsian get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This value contains the height of the characters in point.

CharWeightAsian

[ bound ] float CharWeightAsian get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This property contains the value of the font weight. See also ::com::sun::star::awt::FontWeight

CharFontNameAsian

[ bound ] string CharFontNameAsian get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This property specifies the name of the font style. It may contain more than one name separated by comma.

CharFontStyleNameAsian

[ bound ] string CharFontStyleNameAsian get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This property contains the name of the font style. This property may be empty.

CharFontFamilyAsian

[ bound ] short CharFontFamilyAsian get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This property contains font family as specified in com.sun.star.awt.FontFamily .

CharFontCharSetAsian

[ bound ] short CharFontCharSetAsian get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet.

CharFontPitchAsian

[ bound ] short CharFontPitchAsian get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This property contains the font pitch as specified in com.sun.star.awt.FontPitch.

CharPostureAsian

[ bound ] ::com::sun::star::awt::FontSlant CharPostureAsian get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This property contains the value of the posture of the document. See also ::com::sun::star::awt::FontSlant

CharLocaleAsian

[ bound ] ::com::sun::star::lang::Locale CharLocaleAsian get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description contains the value of the locale.

CharHeightComplex

[ bound ] float CharHeightComplex get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This value contains the height of the characters in point.

CharWeightComplex

[ bound ] float CharWeightComplex get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This property contains the value of the font weight. See also ::com::sun::star::awt::FontWeight

CharFontNameComplex

[ bound ] string CharFontNameComplex get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This property specifies the name of the font style. It may contain more than one name separated by comma.

CharFontStyleNameComplex

[ bound ] string CharFontStyleNameComplex get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This property contains the name of the font style. This property may be empty.

CharFontFamilyComplex

[ bound ] short CharFontFamilyComplex get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This property contains font family as specified in com.sun.star.awt.FontFamily .

CharFontCharSetComplex

[ bound ] short CharFontCharSetComplex get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet.

CharFontPitchComplex

[ bound ] short CharFontPitchComplex get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This property contains the font pitch as specified in com.sun.star.awt.FontPitch.

CharPostureComplex

[ bound ] ::com::sun::star::awt::FontSlant CharPostureComplex get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description This property contains the value of the posture of the document. See also ::com::sun::star::awt::FontSlant

CharLocaleComplex

[ bound ] ::com::sun::star::lang::Locale CharLocaleComplex get raises (::com::sun::star::beans::UnknownPropertyException) set raises (::com::sun::star::beans::UnknownPropertyException); Description contains the value of the locale.

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