<html> <head> <title>Service BaseFrameProperties</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="BaseFrameProperties-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"><a href="#ServicesSummary" class="navisub">Services' Summary</a></td> <td class="navisub">Interfaces' Summary</td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#ServicesDetails" class="navisub">Services' Details</a></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">text</a> :: </p> </td> </tr> <tr> <td class="title">service BaseFrameProperties</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies the properties that are provided by all text frames, graphic objects, embedded objects and frame styles. </dd> </dl> </td> </tr> </table> <hr> <a name="ServicesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../xml/module-ix.html">xml</a>::<a href="../xml/UserDefinedAttributesSupplier.html">UserDefinedAttributesSupplier</a></td> <td class="imsum_right"><p>gives access to the UserDefinedAttributes property. (<a href="#UserDefinedAttributesSupplier">details</a>)</p> </td> </tr> </table> <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">short<br> <a href="#AnchorPageNo">AnchorPageNo</a></td> <td class="imsum_right">contains the number of the page where the objects are anchored. </td> </tr> <tr> <td class="imsum_left"><a href="XTextFrame.html">XTextFrame</a><br> <a href="#AnchorFrame">AnchorFrame</a></td> <td class="imsum_right">contains the text frame the current frame is anchored to. </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="#BackColor">BackColor</a></td> <td class="imsum_right">contains the color of the background of the object. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#BackGraphicURL">BackGraphicURL</a></td> <td class="imsum_right">contains the URL for the background graphic. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#BackGraphicFilter">BackGraphicFilter</a></td> <td class="imsum_right">contains the name of the file filter for the background graphic. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../style/module-ix.html">style</a>::<a href="../style/GraphicLocation.html">GraphicLocation</a><br> <a href="#BackGraphicLocation">BackGraphicLocation</a></td> <td class="imsum_right">determines the position of the background graphic. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/BorderLine.html">BorderLine</a><br> <a href="#LeftBorder">LeftBorder</a></td> <td class="imsum_right">contains the left border of the object. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/BorderLine.html">BorderLine</a><br> <a href="#RightBorder">RightBorder</a></td> <td class="imsum_right">contains the right border of the object. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/BorderLine.html">BorderLine</a><br> <a href="#TopBorder">TopBorder</a></td> <td class="imsum_right">contains the top border of the object. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/BorderLine.html">BorderLine</a><br> <a href="#BottomBorder">BottomBorder</a></td> <td class="imsum_right">contains the bottom border of the object. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#BorderDistance">BorderDistance</a></td> <td class="imsum_right">contains the distance from the border to the object. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#LeftBorderDistance">LeftBorderDistance</a></td> <td class="imsum_right">contains the distance from the left border to the object. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#RightBorderDistance">RightBorderDistance</a></td> <td class="imsum_right">contains the distance from the right border to the object. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#TopBorderDistance">TopBorderDistance</a></td> <td class="imsum_right">contains the distance from the top border to the object. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#BottomBorderDistance">BottomBorderDistance</a></td> <td class="imsum_right">contains the distance from the bottom border to the object. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#BackTransparent">BackTransparent</a></td> <td class="imsum_right">If TRUE, the "BackColor" is ignored. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#ContentProtected">ContentProtected</a></td> <td class="imsum_right">determines if the content is protected. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#LeftMargin">LeftMargin</a></td> <td class="imsum_right">contains the left margin of the object. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#RightMargin">RightMargin</a></td> <td class="imsum_right">contains the right margin of the object. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#TopMargin">TopMargin</a></td> <td class="imsum_right">contains the top margin of the object. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#BottomMargin">BottomMargin</a></td> <td class="imsum_right">contains the bottom margin of the object. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#Height">Height</a></td> <td class="imsum_right">contains the height of the object (1/100 mm). </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#Width">Width</a></td> <td class="imsum_right">contains the width of the object (1/100 mm). </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#RelativeHeight">RelativeHeight</a></td> <td class="imsum_right">contains the relative height of the object. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#RelativeWidth">RelativeWidth</a></td> <td class="imsum_right">contains the relative width of the object. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsSyncWidthToHeight">IsSyncWidthToHeight</a></td> <td class="imsum_right">determines whether the width follows the height. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsSyncHeightToWidth">IsSyncHeightToWidth</a></td> <td class="imsum_right">determines whether the height follows the width. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#HoriOrient">HoriOrient</a></td> <td class="imsum_right">determines the horizontal orientation of the object. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#HoriOrientPosition">HoriOrientPosition</a></td> <td class="imsum_right">contains the horizontal position of the object (1/100 mm). </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#HoriOrientRelation">HoriOrientRelation</a></td> <td class="imsum_right">determines the environment of the object to which the orientation is related. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#VertOrient">VertOrient</a></td> <td class="imsum_right">determines the vertical orientation of the object. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#VertOrientPosition">VertOrientPosition</a></td> <td class="imsum_right">contains the vertical position of the object (1/100 mm). It is only valid if <a href="TextEmbeddedObject.html">TextEmbeddedObject</a>::<a href="TextEmbeddedObject.html#VertOrient">VertOrient</a> is <b>VertOrientation::NONE</b>. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#VertOrientRelation">VertOrientRelation</a></td> <td class="imsum_right">determines the environment of the object to which the orientation is related. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HyperLinkURL">HyperLinkURL</a></td> <td class="imsum_right">contains the URL of a hyperlink that is set at the object. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HyperLinkTarget">HyperLinkTarget</a></td> <td class="imsum_right">contains the name of the target for a hyperlink that is set at the object. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HyperLinkName">HyperLinkName</a></td> <td class="imsum_right">contains the name of the hyperlink that is set at the object. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Opaque">Opaque</a></td> <td class="imsum_right">determines if the object is opaque or transparent for text. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#PageToggle">PageToggle</a></td> <td class="imsum_right">determines if the object is mirrored on even pages. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#PositionProtected">PositionProtected</a></td> <td class="imsum_right">determines if the position is protected. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Print">Print</a></td> <td class="imsum_right">determines if the object is included in printing. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/ShadowFormat.html">ShadowFormat</a><br> <a href="#ShadowFormat">ShadowFormat</a></td> <td class="imsum_right">contains the type of the shadow of the object. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#ServerMap">ServerMap</a></td> <td class="imsum_right">determines if the object gets an image map from a server. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Size.html">Size</a><br> <a href="#Size">Size</a></td> <td class="imsum_right">contains the size of the object. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#SizeProtected">SizeProtected</a></td> <td class="imsum_right">determines if the size is protected. </td> </tr> <tr> <td class="imsum_left"><a href="WrapTextMode.html">WrapTextMode</a><br> <a href="#Surround">Surround</a></td> <td class="imsum_right"><b>[ DEPRECATED ]<br> </b>determines the type of the surrounding text. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#SurroundAnchorOnly">SurroundAnchorOnly</a></td> <td class="imsum_right">determines if the text of the paragraph in which the object is anchored, wraps around the object. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#WrapInfluenceOnPosition">WrapInfluenceOnPosition</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determines the influence of the text wrap on the positioning of the shape </td> </tr> <tr> <td class="imsum_left">[ maybevoid ] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Size.html">Size</a><br> <a href="#LayoutSize">LayoutSize</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>returns the actual size of the object. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Title">Title</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains short title for the object </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Description">Description</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains description for the object </td> </tr> </table> <a name="ServicesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="UserDefinedAttributesSupplier" class="membertitle">::com::sun::star::<a href="../xml/module-ix.html">xml</a>::<a href="../xml/UserDefinedAttributesSupplier.html">UserDefinedAttributesSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>gives access to the UserDefinedAttributes property. </dd> <dt><b>Since </b></dt> <dd>OOo 2.1 </dd> </dl> </td> </tr> </table> </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="AnchorPageNo" class="membertitle">AnchorPageNo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>AnchorPageNo</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the number of the page where the objects are anchored. </dd> <dd><p> The value is valid only if the AnchorType is <b>TextContentAnchorType::AT_PAGE</b>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AnchorFrame" class="membertitle">AnchorFrame</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="XTextFrame.html">XTextFrame</a> <b>AnchorFrame</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the text frame the current frame is anchored to. </dd> <dd><p> The value is valid only if the AnchorType is <b>TextContentAnchorType::AT_FRAME</b>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BackColor" class="membertitle">BackColor</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>BackColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the color of the background of the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BackGraphicURL" class="membertitle">BackGraphicURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>BackGraphicURL</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the URL for the background graphic. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BackGraphicFilter" class="membertitle">BackGraphicFilter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>BackGraphicFilter</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the name of the file filter for the background graphic. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BackGraphicLocation" class="membertitle">BackGraphicLocation</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="../style/module-ix.html">style</a>::<a href="../style/GraphicLocation.html">GraphicLocation</a> <b>BackGraphicLocation</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines the position of the background graphic. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="LeftBorder" class="membertitle">LeftBorder</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="../table/module-ix.html">table</a>::<a href="../table/BorderLine.html">BorderLine</a> <b>LeftBorder</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the left border of the object. </dd> <dt><b>See also</b></dt> <dd><a href="BaseFrame.html">BaseFrame</a>::<a href="BaseFrame.html#com">com</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RightBorder" class="membertitle">RightBorder</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="../table/module-ix.html">table</a>::<a href="../table/BorderLine.html">BorderLine</a> <b>RightBorder</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the right border of the object. </dd> <dt><b>See also</b></dt> <dd><a href="BaseFrame.html">BaseFrame</a>::<a href="BaseFrame.html#com">com</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TopBorder" class="membertitle">TopBorder</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="../table/module-ix.html">table</a>::<a href="../table/BorderLine.html">BorderLine</a> <b>TopBorder</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the top border of the object. </dd> <dt><b>See also</b></dt> <dd><a href="BaseFrame.html">BaseFrame</a>::<a href="BaseFrame.html#com">com</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BottomBorder" class="membertitle">BottomBorder</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="../table/module-ix.html">table</a>::<a href="../table/BorderLine.html">BorderLine</a> <b>BottomBorder</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the bottom border of the object. </dd> <dt><b>See also</b></dt> <dd><a href="BaseFrame.html">BaseFrame</a>::<a href="BaseFrame.html#com">com</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BorderDistance" class="membertitle">BorderDistance</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>BorderDistance</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the distance from the border to the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="LeftBorderDistance" class="membertitle">LeftBorderDistance</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>LeftBorderDistance</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the distance from the left border to the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RightBorderDistance" class="membertitle">RightBorderDistance</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>RightBorderDistance</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the distance from the right border to the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TopBorderDistance" class="membertitle">TopBorderDistance</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>TopBorderDistance</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the distance from the top border to the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BottomBorderDistance" class="membertitle">BottomBorderDistance</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>BottomBorderDistance</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the distance from the bottom border to the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BackTransparent" class="membertitle">BackTransparent</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>BackTransparent</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If TRUE, the "BackColor" is ignored. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ContentProtected" class="membertitle">ContentProtected</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>ContentProtected</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines if the content is protected. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="LeftMargin" class="membertitle">LeftMargin</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>LeftMargin</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the left margin of the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RightMargin" class="membertitle">RightMargin</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>RightMargin</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the right margin of the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TopMargin" class="membertitle">TopMargin</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>TopMargin</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the top margin of the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BottomMargin" class="membertitle">BottomMargin</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>BottomMargin</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the bottom margin of the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Height" class="membertitle">Height</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>Height</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the height of the object (1/100 mm). </dd> <dd><p>It is only valid if <a href="TextEmbeddedObject.html">TextEmbeddedObject</a>::<a href="TextEmbeddedObject.html#RelativeHeight">RelativeHeight</a> is zero.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Width" class="membertitle">Width</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>Width</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the width of the object (1/100 mm). </dd> <dd><p>It is only valid if <a href="TextEmbeddedObject.html">TextEmbeddedObject</a>::<a href="TextEmbeddedObject.html#RelativeWidth">RelativeWidth</a> is zero.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RelativeHeight" class="membertitle">RelativeHeight</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>RelativeHeight</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the relative height of the object. </dd> <dd><p> It is only valid if it is greater than zero.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RelativeWidth" class="membertitle">RelativeWidth</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>RelativeWidth</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the relative width of the object. </dd> <dd><p> It is only valid if it is greater than zero. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsSyncWidthToHeight" class="membertitle">IsSyncWidthToHeight</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsSyncWidthToHeight</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines whether the width follows the height. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsSyncHeightToWidth" class="membertitle">IsSyncHeightToWidth</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsSyncHeightToWidth</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines whether the height follows the width. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HoriOrient" class="membertitle">HoriOrient</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>HoriOrient</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines the horizontal orientation of the object. </dd> <dt><b>See also</b></dt> <dd><a href="BaseFrame.html">BaseFrame</a>::<a href="BaseFrame.html#HoriOrientation">HoriOrientation</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HoriOrientPosition" class="membertitle">HoriOrientPosition</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>HoriOrientPosition</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the horizontal position of the object (1/100 mm). </dd> <dd><p> It is only valid if "HoriOrient" is HoriOrientation_NONE.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HoriOrientRelation" class="membertitle">HoriOrientRelation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>HoriOrientRelation</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines the environment of the object to which the orientation is related. </dd> <dt><b>See also</b></dt> <dd><a href="BaseFrame.html">BaseFrame</a>::<a href="BaseFrame.html#RelOrientation">RelOrientation</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="VertOrient" class="membertitle">VertOrient</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>VertOrient</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines the vertical orientation of the object. </dd> <dt><b>See also</b></dt> <dd><a href="BaseFrame.html">BaseFrame</a>::<a href="BaseFrame.html#VertOrientation">VertOrientation</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="VertOrientPosition" class="membertitle">VertOrientPosition</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>VertOrientPosition</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the vertical position of the object (1/100 mm). It is only valid if <a href="TextEmbeddedObject.html">TextEmbeddedObject</a>::<a href="TextEmbeddedObject.html#VertOrient">VertOrient</a> is <b>VertOrientation::NONE</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="VertOrientRelation" class="membertitle">VertOrientRelation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>VertOrientRelation</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines the environment of the object to which the orientation is related. </dd> <dt><b>See also</b></dt> <dd><a href="BaseFrame.html">BaseFrame</a>::<a href="BaseFrame.html#RelOrientation">RelOrientation</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>string <b>HyperLinkURL</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the URL of a hyperlink that is set at the object. </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>Description</b></dt> <dd>contains the name of the target for a hyperlink that is set at the object. </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>Description</b></dt> <dd>contains the name of the hyperlink that is set at the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Opaque" class="membertitle">Opaque</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Opaque</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines if the object is opaque or transparent for text. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PageToggle" class="membertitle">PageToggle</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>PageToggle</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines if the object is mirrored on even pages. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PositionProtected" class="membertitle">PositionProtected</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>PositionProtected</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines if the position is protected. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Print" class="membertitle">Print</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Print</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines if the object is included in printing. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ShadowFormat" class="membertitle">ShadowFormat</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="../table/module-ix.html">table</a>::<a href="../table/ShadowFormat.html">ShadowFormat</a> <b>ShadowFormat</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the type of the shadow of the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ServerMap" class="membertitle">ServerMap</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>ServerMap</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines if the object gets an image map from a server. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Size" class="membertitle">Size</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/Size.html">Size</a> <b>Size</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the size of the object. </dd> <dt><b>See also</b></dt> <dd><a href="BaseFrame.html">BaseFrame</a>::<a href="BaseFrame.html#Height">Height</a>, <a href="BaseFrame.html">BaseFrame</a>::<a href="BaseFrame.html#Width">Width</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SizeProtected" class="membertitle">SizeProtected</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SizeProtected</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines if the size is protected. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Surround" class="membertitle">Surround</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="WrapTextMode.html">WrapTextMode</a> <b>Surround</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dt><b>Description</b></dt> <dd>determines the type of the surrounding text. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SurroundAnchorOnly" class="membertitle">SurroundAnchorOnly</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SurroundAnchorOnly</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines if the text of the paragraph in which the object is anchored, wraps around the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="WrapInfluenceOnPosition" class="membertitle">WrapInfluenceOnPosition</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>WrapInfluenceOnPosition</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determines the influence of the text wrap on the positioning of the shape </dd> <dd><p>The value of this property is only evaluated for the positioning of the shape, if the text document setting ConsiderTextWrapOnObjPos is <b>true</b>. Valid values are given by <a href="#WrapInfluenceOnPosition">WrapInfluenceOnPosition</a></p> </dd> <dt><b>Since </b></dt> <dd>OOo 2.0 </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="LayoutSize" class="membertitle">LayoutSize</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ maybevoid ] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Size.html">Size</a> <b>LayoutSize</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>returns the actual size of the object. </dd> <dd><p>Since to obtain the correct actual size of the object not only the layouting for the frame needs to be finished but the whole document needs to be formatted as well. Thus if that was not done previously it may take some while to retrieve this value.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 2.0.4 </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Title" class="membertitle">Title</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Title</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains short title for the object </dd> <dd><p>This short title is visible as an alternative tag in HTML format. Accessibility tools can read this text.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 3.2 </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Description" class="membertitle">Description</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Description</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains description for the object </dd> <dd><p>The long description text can be entered to describe a object in more detail to users with screen reader software. The description is visible as an alternative tag for accessibility tools.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 3.2 </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>
