LibreOffice
LibreOffice 6.2 SDK API Reference
Public Attributes | List of all members
XReportControlFormat Interface Reference

specifies a format condition for a control. More...

import"XReportControlFormat.idl";

Inheritance diagram for XReportControlFormat:
ReportControlFormat XFormatCondition XReportControlModel FormatCondition ReportControlModel XFixedLine XFixedText XFormattedField XImageControl XShape FixedLine FixedText FormattedField ImageControl Shape

Public Attributes

com::sun::star::util::Color ControlBackground { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies the background color (RGB) of the control. More...
 
boolean ControlBackgroundTransparent { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 determines if the back ground color is set to transparent. More...
 
short ParaAdjust { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies the horizontal alignment of the text. More...
 
com::sun::star::awt::FontDescriptor FontDescriptor { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies the font attributes of the text in the control. More...
 
com::sun::star::awt::FontDescriptor FontDescriptorAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies the font attributes of the text in the control. More...
 
com::sun::star::awt::FontDescriptor FontDescriptorComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies the font attributes of the text in the control. More...
 
short ControlTextEmphasis { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies the com::sun::star::text::FontEmphasis value of the text in the control. More...
 
short CharEmphasis { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 contains the font emphasis value as com::sun::star::text::FontEmphasis. More...
 
boolean CharCombineIsOn { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 determines whether text is formatted in two lines. More...
 
string CharCombinePrefix { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 contains the prefix (usually parenthesis) before text that is formatted in two lines. More...
 
string CharCombineSuffix { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 contains the suffix (usually parenthesis) after text that is formatted in two lines. More...
 
boolean CharHidden { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 If this optional property is TRUE, then the characters are invisible. More...
 
boolean CharShadowed { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies if the characters are formatted and displayed with a shadow effect. More...
 
boolean CharContoured { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies if the characters are formatted and displayed with a contour effect. More...
 
short CharCaseMap { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 optional property which contains the value of the case-mapping of the text for formatting and displaying. More...
 
com::sun::star::lang::Locale CharLocale { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 contains the value of the locale. More...
 
short CharEscapement { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies the percentage by which to raise/lower superscript/subscript characters. More...
 
byte CharEscapementHeight { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This is the additional height used for subscript or superscript characters in units of percent. More...
 
boolean CharAutoKerning { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 optional property to determine whether the kerning tables from the current font are used. More...
 
short CharKerning { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 optional property which contains the value of the kerning of the characters. More...
 
boolean CharFlash { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 If this optional property is TRUE, then the characters are flashing. More...
 
short CharRelief { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies the com::sun::star::text::FontRelief value of the text in the control. More...
 
string CharFontName { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This attribute specifies the name of the font style. More...
 
string CharFontStyleName { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This attribute contains the name of the font style. More...
 
short CharFontFamily { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This attribute contains font family as specified in com.sun.star.awt.FontFamily . More...
 
short CharFontCharSet { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This attribute contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More...
 
short CharFontPitch { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This attribute contains the font pitch as specified in com.sun.star.awt.FontPitch. More...
 
com::sun::star::util::Color CharColor { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies the text color (RGB) of the control. More...
 
com::sun::star::util::Color CharUnderlineColor { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies the text line color (RGB) of the control. More...
 
float CharHeight { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This value contains the height of the characters in point. More...
 
short CharUnderline { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This attribute contains the value for the character underline. More...
 
float CharWeight { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This attribute contains the value of the font weight. More...
 
com::sun::star::awt::FontSlant CharPosture { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This attribute contains the value of the posture of the document. More...
 
short CharStrikeout { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 determines the type of the strike out of the character. More...
 
boolean CharWordMode { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 If this attribute is TRUE, the underline and strike-through properties are not applied to white spaces. More...
 
short CharRotation { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 determines the rotation of a character in degree. More...
 
short CharScaleWidth { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 determines the percentage value for scaling the width of characters. More...
 
com::sun::star::style::VerticalAlignment VerticalAlign { set raises(com::sun::star::lang::IllegalArgumentException, com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies the vertical alignment of the text in the control. More...
 
string HyperLinkURL { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 contains the URL of a hyperlink (if set). More...
 
string HyperLinkTarget { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 contains the name of the target for a hyperlink (if set). More...
 
string HyperLinkName { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 contains the name of the hyperlink (if set). More...
 
string VisitedCharStyleName { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 contains the character style name for visited hyperlinks. More...
 
string UnvisitedCharStyleName { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 contains the character style name for unvisited hyperlinks. More...
 
float CharHeightAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This value contains the height of the characters in point. More...
 
float CharWeightAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This property contains the value of the font weight. More...
 
string CharFontNameAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This property specifies the name of the font style. More...
 
string CharFontStyleNameAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This property contains the name of the font style. More...
 
short CharFontFamilyAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This property contains font family as specified in com.sun.star.awt.FontFamily . More...
 
short CharFontCharSetAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More...
 
short CharFontPitchAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This property contains the font pitch as specified in com.sun.star.awt.FontPitch. More...
 
com::sun::star::awt::FontSlant CharPostureAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This property contains the value of the posture of the document. More...
 
com::sun::star::lang::Locale CharLocaleAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 contains the value of the locale. More...
 
float CharHeightComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This value contains the height of the characters in point. More...
 
float CharWeightComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This property contains the value of the font weight. More...
 
string CharFontNameComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This property specifies the name of the font style. More...
 
string CharFontStyleNameComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This property contains the name of the font style. More...
 
short CharFontFamilyComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This property contains font family as specified in com.sun.star.awt.FontFamily . More...
 
short CharFontCharSetComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More...
 
short CharFontPitchComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This property contains the font pitch as specified in com.sun.star.awt.FontPitch. More...
 
com::sun::star::awt::FontSlant CharPostureComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 This property contains the value of the posture of the document. More...
 
com::sun::star::lang::Locale CharLocaleComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 contains the value of the locale. More...
 

Detailed Description

specifies a format condition for a control.

Member Data Documentation

boolean CharAutoKerning
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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 property which contains the value of the case-mapping of the text for formatting and displaying.

See also
CaseMap

specifies the text color (RGB) of the control.

boolean CharCombineIsOn
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

determines whether text is formatted in two lines.

It is linked to the properties CharCombinePrefix and CharCombineSuffix.

string CharCombinePrefix
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

It is linked to the properties CharCombineIsOn and CharCombineSuffix.

string CharCombineSuffix
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

It is linked to the properties CharCombineIsOn and CharCombinePrefix.

boolean CharContoured
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

short CharEmphasis
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

contains the font emphasis value as com::sun::star::text::FontEmphasis.

short CharEscapement
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

Negative values denote subscripts and positive values superscripts.

byte CharEscapementHeight
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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.

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

short CharFontCharSet
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

short CharFontCharSetAsian
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

short CharFontCharSetComplex
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

short CharFontFamily
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

short CharFontFamilyAsian
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

short CharFontFamilyComplex
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

string CharFontName
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

This attribute specifies the name of the font style.

It may contain more than one name separated by comma.

string CharFontNameAsian
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

This property specifies the name of the font style.

It may contain more than one name separated by comma.

string CharFontNameComplex
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

This property specifies the name of the font style.

It may contain more than one name separated by comma.

short CharFontPitch
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

short CharFontPitchAsian
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

short CharFontPitchComplex
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

string CharFontStyleName
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

This attribute contains the name of the font style.

This attribute may be empty.

string CharFontStyleNameAsian
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

This property contains the name of the font style.

This property may be empty.

string CharFontStyleNameComplex
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

This property contains the name of the font style.

This property may be empty.

This value contains the height of the characters in point.

float CharHeightAsian
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

This value contains the height of the characters in point.

float CharHeightComplex
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

This value contains the height of the characters in point.

boolean CharHidden
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

Since
OOo 2.0

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

contains the value of the locale.

contains the value of the locale.

contains the value of the locale.

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

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

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

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

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

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

specifies the com::sun::star::text::FontRelief value of the text in the control.

short CharRotation
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

determines the rotation of a character in degree.

Depending on the implementation only certain values may be allowed.

short CharScaleWidth
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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.

boolean CharShadowed
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

short CharStrikeout
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

determines the type of the strike out of the character.

See also
com::sun::star::awt::FontStrikeout
short CharUnderline
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

This attribute contains the value for the character underline.

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

specifies the text line color (RGB) of the control.

This attribute contains the value of the font weight.

See also
com::sun::star::awt::FontWeight
float CharWeightAsian
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

This property contains the value of the font weight.

See also
com::sun::star::awt::FontWeight
float CharWeightComplex
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

This property contains the value of the font weight.

See also
com::sun::star::awt::FontWeight
boolean CharWordMode
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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

specifies the background color (RGB) of the control.

boolean ControlBackgroundTransparent
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

determines if the back ground color is set to transparent.

short ControlTextEmphasis
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

specifies the com::sun::star::text::FontEmphasis value of the text in the control.

specifies the font attributes of the text in the control.

specifies the font attributes of the text in the control.

specifies the font attributes of the text in the control.

string HyperLinkName
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

contains the name of the hyperlink (if set).

string HyperLinkTarget
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

contains the name of the target for a hyperlink (if set).

string HyperLinkURL
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

contains the URL of a hyperlink (if set).

specifies the horizontal alignment of the text.

See also
com::sun::star::style::ParagraphAdjust
string UnvisitedCharStyleName
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

contains the character style name for unvisited hyperlinks.

specifies the vertical alignment of the text in the control.

See also
com::sun::star::style::VerticalAlignment
string VisitedCharStyleName
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

contains the character style name for visited hyperlinks.


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