<html> <head> <title>Interface XReportControlFormat</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XReportControlFormat-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub">Methods' Summary</td> <td class="navisub">Methods' Details</td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">report</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XReportControlFormat</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies a format condition for a control. </dd> </dl> </td> </tr> </table> <hr> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#ControlBackground">ControlBackground</a></td> <td class="imsum_right">specifies the background color (RGB) of the control. </td> </tr> <tr> <td class="imsum_left"><a href="#ControlBackgroundTransparent">ControlBackgroundTransparent</a></td> <td class="imsum_right">determines if the back ground color is set to transparent. </td> </tr> <tr> <td class="imsum_left"><a href="#ParaAdjust">ParaAdjust</a></td> <td class="imsum_right">specifies the horizontal alignment of the text in the control. </td> </tr> <tr> <td class="imsum_left"><a href="#FontDescriptor">FontDescriptor</a></td> <td class="imsum_right">specifies the font attributes of the text in the control. </td> </tr> <tr> <td class="imsum_left"><a href="#ControlTextEmphasis">ControlTextEmphasis</a></td> <td class="imsum_right">specifies the ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontEmphasis.html">FontEmphasis</a> value of the text in the control. </td> </tr> <tr> <td class="imsum_left"><a href="#CharEmphasis">CharEmphasis</a></td> <td class="imsum_right">contains the font emphasis value as ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontEmphasis.html">FontEmphasis</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#CharCombineIsOn">CharCombineIsOn</a></td> <td class="imsum_right">determins whether text is formatted in two lines. </td> </tr> <tr> <td class="imsum_left"><a href="#CharCombinePrefix">CharCombinePrefix</a></td> <td class="imsum_right">contains the prefix (usually parenthesis) before text that is formatted in two lines. </td> </tr> <tr> <td class="imsum_left"><a href="#CharCombineSuffix">CharCombineSuffix</a></td> <td class="imsum_right">contains the suffix (usually parenthesis) after text that is formatted in two lines. </td> </tr> <tr> <td class="imsum_left"><a href="#CharHidden">CharHidden</a></td> <td class="imsum_right">If this optional property is <b>true</b>, then the characters are invisible. </td> </tr> <tr> <td class="imsum_left"><a href="#CharShadowed">CharShadowed</a></td> <td class="imsum_right">specifies if the characters are formatted and displayed with a shadow effect. </td> </tr> <tr> <td class="imsum_left"><a href="#CharContoured">CharContoured</a></td> <td class="imsum_right">specifies if the characters are formatted and displayed with a contour effect. </td> </tr> <tr> <td class="imsum_left"><a href="#CharCaseMap">CharCaseMap</a></td> <td class="imsum_right">optional property which contains the value of the case-mapping of the text for formatting and displaying. </td> </tr> <tr> <td class="imsum_left"><a href="#CharLocale">CharLocale</a></td> <td class="imsum_right">contains the value of the locale. </td> </tr> <tr> <td class="imsum_left"><a href="#CharEscapement">CharEscapement</a></td> <td class="imsum_right">specifies the percentage of raisement/lowerment of superscript/subscript characters. </td> </tr> <tr> <td class="imsum_left"><a href="#CharEscapementHeight">CharEscapementHeight</a></td> <td class="imsum_right">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. </td> </tr> <tr> <td class="imsum_left"><a href="#CharAutoKerning">CharAutoKerning</a></td> <td class="imsum_right">optional property to determine whether the kerning tables from the current font are used. </td> </tr> <tr> <td class="imsum_left"><a href="#CharKerning">CharKerning</a></td> <td class="imsum_right">optional property which contains the value of the kerning of the characters. </td> </tr> <tr> <td class="imsum_left"><a href="#CharFlash">CharFlash</a></td> <td class="imsum_right">If this optional property is <b>true</b>, then the characters are flashing. </td> </tr> <tr> <td class="imsum_left"><a href="#CharRelief">CharRelief</a></td> <td class="imsum_right">specifies the ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontRelief.html">FontRelief</a> value of the text in the control. </td> </tr> <tr> <td class="imsum_left"><a href="#CharFontName">CharFontName</a></td> <td class="imsum_right">This attribute specifies the name of the font style. </td> </tr> <tr> <td class="imsum_left"><a href="#CharFontStyleName">CharFontStyleName</a></td> <td class="imsum_right">This attribute contains the name of the font style. </td> </tr> <tr> <td class="imsum_left"><a href="#CharFontFamily">CharFontFamily</a></td> <td class="imsum_right">This attribute contains font family as specified in com.sun.star.awt.FontFamily . </td> </tr> <tr> <td class="imsum_left"><a href="#CharFontCharSet">CharFontCharSet</a></td> <td class="imsum_right">This attribute contains the text encoding of the font as specified in com.sun.star.awt.CharSet. </td> </tr> <tr> <td class="imsum_left"><a href="#CharFontPitch">CharFontPitch</a></td> <td class="imsum_right">This attribute contains the font pitch as specified in com.sun.star.awt.FontPitch. </td> </tr> <tr> <td class="imsum_left"><a href="#CharColor">CharColor</a></td> <td class="imsum_right">specifies the text color (RGB) of the control. </td> </tr> <tr> <td class="imsum_left"><a href="#CharUnderlineColor">CharUnderlineColor</a></td> <td class="imsum_right">specifies the text line color (RGB) of the control. </td> </tr> <tr> <td class="imsum_left"><a href="#CharHeight">CharHeight</a></td> <td class="imsum_right">This value contains the height of the characters in point. </td> </tr> <tr> <td class="imsum_left"><a href="#CharUnderline">CharUnderline</a></td> <td class="imsum_right">This attribute contains the value for the character underline. </td> </tr> <tr> <td class="imsum_left"><a href="#CharWeight">CharWeight</a></td> <td class="imsum_right">This attribute contains the value of the font weight. </td> </tr> <tr> <td class="imsum_left"><a href="#CharPosture">CharPosture</a></td> <td class="imsum_right">This attribute contains the value of the posture of the document. </td> </tr> <tr> <td class="imsum_left"><a href="#CharStrikeout">CharStrikeout</a></td> <td class="imsum_right">determins the type of the strike out of the character. </td> </tr> <tr> <td class="imsum_left"><a href="#CharWordMode">CharWordMode</a></td> <td class="imsum_right">If this attribute is <b>true</b>, the underline and strike-through properties are not applied to white spaces. </td> </tr> <tr> <td class="imsum_left"><a href="#CharRotation">CharRotation</a></td> <td class="imsum_right">determins the rotation of a character in degree. </td> </tr> <tr> <td class="imsum_left"><a href="#CharScaleWidth">CharScaleWidth</a></td> <td class="imsum_right">determins the percentage value for scaling the width of characters. </td> </tr> <tr> <td class="imsum_left"><a href="#ParaVertAlignment">ParaVertAlignment</a></td> <td class="imsum_right">specifies the vertical alignment of the text in the control. </td> </tr> <tr> <td class="imsum_left"><a href="#HyperLinkURL">HyperLinkURL</a></td> <td class="imsum_right">contains the URL of a hyperlink (if set). </td> </tr> <tr> <td class="imsum_left"><a href="#HyperLinkTarget">HyperLinkTarget</a></td> <td class="imsum_right">contains the name of the target for a hyperlink (if set). </td> </tr> <tr> <td class="imsum_left"><a href="#HyperLinkName">HyperLinkName</a></td> <td class="imsum_right">contains the name of the hyperlink (if set). </td> </tr> <tr> <td class="imsum_left"><a href="#VisitedCharStyleName">VisitedCharStyleName</a></td> <td class="imsum_right">contains the character style name for visited hyperlinks. </td> </tr> <tr> <td class="imsum_left"><a href="#UnvisitedCharStyleName">UnvisitedCharStyleName</a></td> <td class="imsum_right">contains the character style name for unvisited hyperlinks. </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="ControlBackground" class="membertitle">ControlBackground</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>ControlBackground</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the background color (RGB) of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ControlBackgroundTransparent" class="membertitle">ControlBackgroundTransparent</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>ControlBackgroundTransparent</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>determines if the back ground color is set to transparent. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParaAdjust" class="membertitle">ParaAdjust</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>ParaAdjust</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the horizontal alignment of the text in the control. </dd> <dd><pre> 0: left 1: center 2: right </pre> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FontDescriptor" class="membertitle">FontDescriptor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/FontDescriptor.html">FontDescriptor</a> <b>FontDescriptor</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the font attributes of the text in the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ControlTextEmphasis" class="membertitle">ControlTextEmphasis</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>ControlTextEmphasis</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontEmphasis.html">FontEmphasis</a> value of the text in the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharEmphasis" class="membertitle">CharEmphasis</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>CharEmphasis</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>contains the font emphasis value as ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontEmphasis.html">FontEmphasis</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharCombineIsOn" class="membertitle">CharCombineIsOn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>CharCombineIsOn</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>determins whether text is formatted in two lines. </dd> <dd><p>It is linked to the properties CharCombinePrefix and CharCombineSuffix.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharCombinePrefix" class="membertitle">CharCombinePrefix</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>CharCombinePrefix</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>contains the prefix (usually parenthesis) before text that is formatted in two lines. </dd> <dd><p>It is linked to the properties CharCombineIsOn and CharCombineSuffix.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharCombineSuffix" class="membertitle">CharCombineSuffix</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>CharCombineSuffix</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>contains the suffix (usually parenthesis) after text that is formatted in two lines. </dd> <dd><p>It is linked to the properties CharCombineIsOn and CharCombinePrefix.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharHidden" class="membertitle">CharHidden</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>CharHidden</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>If this optional property is <b>true</b>, then the characters are invisible. </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharShadowed" class="membertitle">CharShadowed</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>CharShadowed</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies if the characters are formatted and displayed with a shadow effect. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharContoured" class="membertitle">CharContoured</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>CharContoured</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies if the characters are formatted and displayed with a contour effect. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharCaseMap" class="membertitle">CharCaseMap</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>CharCaseMap</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>optional property which contains the value of the case-mapping of the text for formatting and displaying. </dd> <dt><b>See also</b></dt> <dd><a href="#CaseMap">CaseMap</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharLocale" class="membertitle">CharLocale</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a> <b>CharLocale</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>contains the value of the locale. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharEscapement" class="membertitle">CharEscapement</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>CharEscapement</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the percentage of raisement/lowerment of superscript/subscript characters. </dd> <dd><p>Negative values denote subscripts and positive values superscripts.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharEscapementHeight" class="membertitle">CharEscapementHeight</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] byte <b>CharEscapementHeight</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>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. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharAutoKerning" class="membertitle">CharAutoKerning</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>CharAutoKerning</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>optional property to determine whether the kerning tables from the current font are used. </dd> <dd><p>Automatic <em>kerning</em> applies a spacing in between certain pairs of characters to make the text look better.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharKerning" class="membertitle">CharKerning</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>CharKerning</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>optional property which contains the value of the kerning of the characters. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharFlash" class="membertitle">CharFlash</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>CharFlash</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>If this optional property is <b>true</b>, then the characters are flashing. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharRelief" class="membertitle">CharRelief</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>CharRelief</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontRelief.html">FontRelief</a> value of the text in the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharFontName" class="membertitle">CharFontName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>CharFontName</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>This attribute specifies the name of the font style. </dd> <dd><p>It may contain more than one name separated by comma.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharFontStyleName" class="membertitle">CharFontStyleName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>CharFontStyleName</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>This attribute contains the name of the font style. </dd> <dd><p>This attribute may be empty.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharFontFamily" class="membertitle">CharFontFamily</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>CharFontFamily</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>This attribute contains font family as specified in com.sun.star.awt.FontFamily . </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharFontCharSet" class="membertitle">CharFontCharSet</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>CharFontCharSet</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>This attribute contains the text encoding of the font as specified in com.sun.star.awt.CharSet. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharFontPitch" class="membertitle">CharFontPitch</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>CharFontPitch</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>This attribute contains the font pitch as specified in com.sun.star.awt.FontPitch. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharColor" class="membertitle">CharColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>CharColor</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the text color (RGB) of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharUnderlineColor" class="membertitle">CharUnderlineColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>CharUnderlineColor</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the text line color (RGB) of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharHeight" class="membertitle">CharHeight</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] float <b>CharHeight</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>This value contains the height of the characters in point. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharUnderline" class="membertitle">CharUnderline</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>CharUnderline</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>This attribute contains the value for the character underline.</dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/FontUnderline.html">FontUnderline</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharWeight" class="membertitle">CharWeight</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] float <b>CharWeight</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>This attribute contains the value of the font weight.</dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/FontWeight.html">FontWeight</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharPosture" class="membertitle">CharPosture</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/FontSlant.html">FontSlant</a> <b>CharPosture</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>This attribute contains the value of the posture of the document.</dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/FontSlant.html">FontSlant</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharStrikeout" class="membertitle">CharStrikeout</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>CharStrikeout</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>determins the type of the strike out of the character. </dd> <dt><b>See also</b></dt> <dd><a href="#com.sun.star.awt.FontStrikeout">com.sun.star.awt.FontStrikeout</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharWordMode" class="membertitle">CharWordMode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>CharWordMode</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>If this attribute is <b>true</b>, the underline and strike-through properties are not applied to white spaces. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharRotation" class="membertitle">CharRotation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>CharRotation</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>determins the rotation of a character in degree. </dd> <dd><p>Depending on the implementation only certain values may be allowed. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharScaleWidth" class="membertitle">CharScaleWidth</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>CharScaleWidth</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>determins the percentage value for scaling the width of characters. </dd> <dd><p>The value refers to the original width which is denoted by 100, and it has to be greater than 0.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParaVertAlignment" class="membertitle">ParaVertAlignment</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>ParaVertAlignment</b><dl> <dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the vertical alignment of the text in the control. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/ParagraphVertAlign.html">ParagraphVertAlign</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HyperLinkURL" class="membertitle">HyperLinkURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>HyperLinkURL</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>contains the URL of a hyperlink (if set). </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HyperLinkTarget" class="membertitle">HyperLinkTarget</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>HyperLinkTarget</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>contains the name of the target for a hyperlink (if set). </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HyperLinkName" class="membertitle">HyperLinkName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>HyperLinkName</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>contains the name of the hyperlink (if set). </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="VisitedCharStyleName" class="membertitle">VisitedCharStyleName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>VisitedCharStyleName</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>contains the character style name for visited hyperlinks. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UnvisitedCharStyleName" class="membertitle">UnvisitedCharStyleName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>UnvisitedCharStyleName</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>contains the character style name for unvisited hyperlinks. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>