<html> <head> <title>Service CharacterProperties</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="CharacterProperties-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="#devmanual" class="navimain">Devguide</a></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">Services' Summary</td> <td class="navisub">Interfaces' Summary</td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub">Services' Details</td> <td class="navisub">Interfaces' Details</td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' 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">style</a> :: </p> </td> </tr> <tr> <td class="title">service CharacterProperties</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This is a set of properties to describe the style of characters.</dd> <dt><b>See also</b></dt> <dd><a href="ParagraphProperties.html">ParagraphProperties</a></dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Formatting">Text - Formatting</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Ruby">Text - Ruby</a></dd> </dl> </td> </tr> </table> <hr> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">string<br> <a href="#CharFontName">CharFontName</a></td> <td class="imsum_right">This property specifies the name of the font style. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#CharFontStyleName">CharFontStyleName</a></td> <td class="imsum_right">This property contains the name of the font style. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#CharFontFamily">CharFontFamily</a></td> <td class="imsum_right">This property contains font family. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#CharFontCharSet">CharFontCharSet</a></td> <td class="imsum_right">This property contains the text encoding of the font. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#CharFontPitch">CharFontPitch</a></td> <td class="imsum_right">This property contains the font pitch. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a><br> <a href="#CharColor">CharColor</a></td> <td class="imsum_right">This property contains the value of the text color. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#CharEscapement">CharEscapement</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies the percentage by which to raise/lower superscript/subscript characters. </td> </tr> <tr> <td class="imsum_left">float<br> <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">short<br> <a href="#CharUnderline">CharUnderline</a></td> <td class="imsum_right">This property contains the value for the character underline. </td> </tr> <tr> <td class="imsum_left">float<br> <a href="#CharWeight">CharWeight</a></td> <td class="imsum_right">This property contains the value of the font weight. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/FontSlant.html">FontSlant</a><br> <a href="#CharPosture">CharPosture</a></td> <td class="imsum_right">This property contains the value of the posture of the document. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CharAutoKerning">CharAutoKerning</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property determines whether the kerning tables from the current font are used. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a><br> <a href="#CharBackColor">CharBackColor</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property contains the text background color. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CharBackTransparent">CharBackTransparent</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This property determines if the text background color is set to transparent. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#CharCaseMap">CharCaseMap</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property contains the value of the case-mapping of the text for formatting and displaying. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CharCrossedOut">CharCrossedOut</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This property is <b>true</b> if the characters are crossed out. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CharFlash">CharFlash</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>If this optional property is <b>true</b>, then the characters are flashing. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#CharStrikeout">CharStrikeout</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This property determines the type of the strike out of the character. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CharWordMode">CharWordMode</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>If this property is <b>true</b>, the underline and strike-through properties are not applied to white spaces. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#CharKerning">CharKerning</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property contains the value of the kerning of the characters. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a><br> <a href="#CharLocale">CharLocale</a></td> <td class="imsum_right">This property contains the value of the locale. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CharKeepTogether">CharKeepTogether</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property marks a range of characters to prevent it from being broken into two lines. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CharNoLineBreak">CharNoLineBreak</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property marks a range of characters to ignore a line break in this area. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CharShadowed">CharShadowed</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property specifies if the characters are formatted and displayed with a shadow effect. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#CharFontType">CharFontType</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property specifies the fundamental technology of the font. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#CharStyleName">CharStyleName</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property specifies the name of the style of the font. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CharContoured">CharContoured</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property specifies if the characters are formatted and displayed with a contour effect. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CharCombineIsOn">CharCombineIsOn</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property determines whether text is formatted in two lines. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#CharCombinePrefix">CharCombinePrefix</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property contains the prefix (usually parenthesis) before text that is formatted in two lines. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#CharCombineSuffix">CharCombineSuffix</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property contains the suffix (usually parenthesis) after text that is formatted in two lines. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#CharEmphasis">CharEmphasis</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property contains the font emphasis value. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#CharRelief">CharRelief</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property contains the relief style of the characters. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#RubyText">RubyText</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property contains the text that is set as ruby. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#RubyAdjust">RubyAdjust</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property determines the adjustment of the ruby . </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#RubyCharStyleName">RubyCharStyleName</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property contains the name of the character style that is applied to RubyText. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#RubyIsAbove">RubyIsAbove</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property determines whether the ruby text is printed above/left or below/right of the text. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#CharRotation">CharRotation</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property determines the rotation of a character in tenths of a degree. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CharRotationIsFitToLine">CharRotationIsFitToLine</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property determines whether the text formatting tries to fit rotated text into the surrounded line height. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#CharScaleWidth">CharScaleWidth</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property determines the percentage value for scaling the width of characters. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HyperLinkURL">HyperLinkURL</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property contains the URL of a hyperlink. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HyperLinkTarget">HyperLinkTarget</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property contains the name of the target for a hyperlink. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HyperLinkName">HyperLinkName</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property contains the name of the hyperlink. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#VisitedCharStyleName">VisitedCharStyleName</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property contains the character style name for visited hyperlinks. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#UnvisitedCharStyleName">UnvisitedCharStyleName</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property contains the character style name for unvisited hyperlinks. </td> </tr> <tr> <td class="imsum_left">byte<br> <a href="#CharEscapementHeight">CharEscapementHeight</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This is the relative height used for subscript or superscript characters in units of percent. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CharNoHyphenation">CharNoHyphenation</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property determines if the word can be hyphenated at the character. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a><br> <a href="#CharUnderlineColor">CharUnderlineColor</a></td> <td class="imsum_right">This property contains the color of the underline for the characters. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CharUnderlineHasColor">CharUnderlineHasColor</a></td> <td class="imsum_right">This property specifies if the property CharUnderlineColor is used for an underline. </td> </tr> <tr> <td class="imsum_left">sequence< string ><br> <a href="#CharStyleNames">CharStyleNames</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This optional property specifies the names of the all styles applied to the font. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CharHidden">CharHidden</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>If this optional property is <b>true</b>, then the characters are invisible. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameContainer.html">XNameContainer</a><br> <a href="#TextUserDefinedAttributes">TextUserDefinedAttributes</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This property stores XML attributes. They will be saved to and restored from automatic styles inside XML files. </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</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>string <b>CharFontName</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property 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>string <b>CharFontStyleName</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property contains the name of the font style. </dd> <dd><p>This property 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>short <b>CharFontFamily</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property contains font family. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/FontFamily.html">FontFamily</a></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>short <b>CharFontCharSet</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property contains the text encoding of the font. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/CharSet.html">CharSet</a></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>short <b>CharFontPitch</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property contains the font pitch. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/FontPitch.html">FontPitch</a></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>::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>CharColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property contains the value of the text color. </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>short <b>CharEscapement</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies the percentage by which to raise/lower superscript/subscript characters. </dd> <dd><p>Negative values denote subscripts and positive values superscripts.</p> </dd> <dt><b>See also</b></dt> <dd><a href="#CharEscapementHeight">CharEscapementHeight</a></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>float <b>CharHeight</b>;<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>short <b>CharUnderline</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property 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>float <b>CharWeight</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property 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>::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/FontSlant.html">FontSlant</a> <b>CharPosture</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property 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="CharAutoKerning" class="membertitle">CharAutoKerning</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>CharAutoKerning</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property determines 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="CharBackColor" class="membertitle">CharBackColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>CharBackColor</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property contains the text background color. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharBackTransparent" class="membertitle">CharBackTransparent</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>CharBackTransparent</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This property determines if the text background color is set to transparent. </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>short <b>CharCaseMap</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property 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.html">CaseMap</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharCrossedOut" class="membertitle">CharCrossedOut</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>CharCrossedOut</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This property is <b>true</b> if the characters are crossed out. </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>boolean <b>CharFlash</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <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="CharStrikeout" class="membertitle">CharStrikeout</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>CharStrikeout</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This property determines the type of the strike out of the character. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/FontStrikeout.html">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>boolean <b>CharWordMode</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>If this property 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="CharKerning" class="membertitle">CharKerning</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>CharKerning</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property contains the value of the kerning of the characters. </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>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a> <b>CharLocale</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property contains the value of the locale. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharKeepTogether" class="membertitle">CharKeepTogether</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>CharKeepTogether</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property marks a range of characters to prevent it from being broken into two lines. </dd> <dd><p> A line break is applied before the range of characters if the layout makes a break necessary within the range.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharNoLineBreak" class="membertitle">CharNoLineBreak</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>CharNoLineBreak</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property marks a range of characters to ignore a line break in this area. </dd> <dd><p> A line break is applied behind the range of characters if the layout makes a break necessary within the range. That means that the text may go through the border.</p> </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>boolean <b>CharShadowed</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property 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="CharFontType" class="membertitle">CharFontType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>CharFontType</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property specifies the fundamental technology of the font. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/FontType.html">FontType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharStyleName" class="membertitle">CharStyleName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>CharStyleName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property specifies the name of the style of the font. </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>boolean <b>CharContoured</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property 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="CharCombineIsOn" class="membertitle">CharCombineIsOn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>CharCombineIsOn</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property determines 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>string <b>CharCombinePrefix</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property 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>string <b>CharCombineSuffix</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property 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="CharEmphasis" class="membertitle">CharEmphasis</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>CharEmphasis</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property contains the font emphasis value. </dd> <dt><b>See also</b></dt> <dd>::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="CharRelief" class="membertitle">CharRelief</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>CharRelief</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property contains the relief style of the characters. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontRelief.html">FontRelief</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RubyText" class="membertitle">RubyText</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>RubyText</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property contains the text that is set as ruby. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RubyAdjust" class="membertitle">RubyAdjust</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>RubyAdjust</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property determines the adjustment of the ruby . </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/RubyAdjust.html">RubyAdjust</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RubyCharStyleName" class="membertitle">RubyCharStyleName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>RubyCharStyleName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property contains the name of the character style that is applied to RubyText. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RubyIsAbove" class="membertitle">RubyIsAbove</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>RubyIsAbove</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property determines whether the ruby text is printed above/left or below/right of the text. </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>short <b>CharRotation</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property determines the rotation of a character in tenths of a 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="CharRotationIsFitToLine" class="membertitle">CharRotationIsFitToLine</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>CharRotationIsFitToLine</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property determines whether the text formatting tries to fit rotated text into the surrounded line height. </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>short <b>CharScaleWidth</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property determines 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="HyperLinkURL" class="membertitle">HyperLinkURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>HyperLinkURL</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property contains the URL of a hyperlink. </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>string <b>HyperLinkTarget</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property contains the name of the target for a hyperlink. </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>string <b>HyperLinkName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property contains the name of the hyperlink. </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>string <b>VisitedCharStyleName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property 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>string <b>UnvisitedCharStyleName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property contains the character style name for unvisited hyperlinks. </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>byte <b>CharEscapementHeight</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This is the relative height used for subscript or superscript characters in units of percent. </dd> <dd><p>The value 100 denotes the original height of the characters.</p> </dd> <dt><b>See also</b></dt> <dd><a href="#CharEscapement">CharEscapement</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharNoHyphenation" class="membertitle">CharNoHyphenation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>CharNoHyphenation</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property determines if the word can be hyphenated at the character. </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>::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>CharUnderlineColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property contains the color of the underline for the characters. </dd> <dt><b>See also</b></dt> <dd><a href="#CharUnderlineHasColor">CharUnderlineHasColor</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharUnderlineHasColor" class="membertitle">CharUnderlineHasColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>CharUnderlineHasColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property specifies if the property CharUnderlineColor is used for an underline. </dd> <dt><b>See also</b></dt> <dd><a href="#CharUnderlineColor">CharUnderlineColor</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharStyleNames" class="membertitle">CharStyleNames</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>sequence< string > <b>CharStyleNames</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This optional property specifies the names of the all styles applied to the font. </dd> <dd><p> It is not guaranteed that the order in the sequence reflects the order of the evaluation of the character style attributes.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 1.1.2 </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>boolean <b>CharHidden</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>If this optional property is <b>true</b>, then the characters are invisible. </dd> <dt><b>Since </b></dt> <dd>OOo 2.0 </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TextUserDefinedAttributes" class="membertitle">TextUserDefinedAttributes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameContainer.html">XNameContainer</a> <b>TextUserDefinedAttributes</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This property stores XML attributes. They will be saved to and restored from automatic styles inside XML files. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../xml/module-ix.html">xml</a>::<a href="../xml/AttributeContainer.html">AttributeContainer</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
