<html> <head> <title>Service Shape</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="Shape-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"><a href="#IncludedServices" class="navisub">Included Services</a></td> <td class="navisub">Exported Interfaces</td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></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 Shape</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies the service of shapes in a text document </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/Shape_Objects_in_Text">Text - Shape Objects in Text</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Formatting">Text - Formatting</a></dd> </dl> </td> </tr> </table> <hr> <a name="IncludedServices"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Shape.html">Shape</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>This abstract service specifies the general characteristics of all ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Shape.html">Shape</a>s. </dd> </dl> </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"><a href="TextContentAnchorType.html">TextContentAnchorType</a><br> <a href="#AnchorType">AnchorType</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies how the text content is attached to its surrounding ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Text.html">Text</a>. </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">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"><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">boolean<br> <a href="#SurroundContour">SurroundContour</a></td> <td class="imsum_right">determines if the text wraps around the contour of the object. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#ContourOutside">ContourOutside</a></td> <td class="imsum_right">the text flows only around the contour of 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"><a href="XTextRange.html">XTextRange</a><br> <a href="#TextRange">TextRange</a></td> <td class="imsum_right">contains a text range where the shape should be anchored to. </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">[ readonly ] ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/HomogenMatrix3.html">HomogenMatrix3</a><br> <a href="#TransformationInHoriL2R">TransformationInHoriL2R</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determines the transformation of the shape in horizontal left-to-right layout </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#PositionLayoutDir">PositionLayoutDir</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determines layout direction the position attributes of the shape is given </td> </tr> <tr> <td class="imsum_left">[ readonly ] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Point.html">Point</a><br> <a href="#StartPositionInHoriL2R">StartPositionInHoriL2R</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determines the start position of the shape in horizontal left-to-right layout </td> </tr> <tr> <td class="imsum_left">[ readonly ] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Point.html">Point</a><br> <a href="#EndPositionInHoriL2R">EndPositionInHoriL2R</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determines the end position of the shape in horizontal left-to-right layout </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="AnchorType" class="membertitle">AnchorType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="TextContentAnchorType.html">TextContentAnchorType</a> <b>AnchorType</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies how the text content is attached to its surrounding ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Text.html">Text</a>. </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="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="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="SurroundContour" class="membertitle">SurroundContour</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SurroundContour</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines if the text wraps around the contour of the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ContourOutside" class="membertitle">ContourOutside</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>ContourOutside</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>the text flows only around the contour of 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="TextRange" class="membertitle">TextRange</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="XTextRange.html">XTextRange</a> <b>TextRange</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains a text range where the shape should be anchored to. </dd> <dd><p>There are two different ways to get newly created shapes into the text document. One of them is to use the insertTextContent() method of the <a href="XSimpleText.html">XSimpleText</a>. The other is to call the add() method of the ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/XShapes.html">XShapes</a> interface. To be able to determine an anchor position for shape that are anchored at a certain text position the property TextRange is used.</p> <p>This property is used when the shape gets inserted/added and becomes invalid after that.</p> </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/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TransformationInHoriL2R" class="membertitle">TransformationInHoriL2R</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/HomogenMatrix3.html">HomogenMatrix3</a> <b>TransformationInHoriL2R</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determines the transformation of the shape in horizontal left-to-right layout </dd> <dd><p>This property is needed for the export of the OASIS Open Office file format to the OpenOffice.org file format. It provides the transformation property of the included service com::sun::star::drawing::Shape converted to the horizontal left-to-right layout.</p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PositionLayoutDir" class="membertitle">PositionLayoutDir</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>PositionLayoutDir</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determines layout direction the position attributes of the shape is given </dd> <dd><p>Valid values are given by <a href="#PositionLayoutDir">PositionLayoutDir</a></p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="StartPositionInHoriL2R" class="membertitle">StartPositionInHoriL2R</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Point.html">Point</a> <b>StartPositionInHoriL2R</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determines the start position of the shape in horizontal left-to-right layout </dd> <dd><p>This property is needed for the export of the OASIS Open Office file format to the OpenOffice.org file format. It provides the start position property of the included service com::sun::star::drawing::Shape converted to the horizontal left-to-right layout.</p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EndPositionInHoriL2R" class="membertitle">EndPositionInHoriL2R</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Point.html">Point</a> <b>EndPositionInHoriL2R</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determines the end position of the shape in horizontal left-to-right layout </dd> <dd><p>This property is needed for the export of the OASIS Open Office file format to the OpenOffice.org file format. It provides the end position property of the included service com::sun::star::drawing::Shape converted to the horizontal left-to-right layout.</p> </dd> <dt><b/></dt> <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 © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
6537
