<html> <head> <title>Service TextFrame</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="TextFrame-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Shape_Objects_in_Text" 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"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></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 TextFrame</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies a rectangular shape which contains a ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Text.html">Text</a> object and is attached to a piece of surrounding ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Text.html">Text</a>. </dd> <dt><b>Example</b></dt> <dd>StarBasic <p>This example shows how to create a <a href="TextFrame.html">TextFrame</a> and insert it at the very beginning of <a href="Text.html">Text</a> component. The macro is ready to run, if it is a script within a text document. </p> <pre> Sub Main oFrame = ThisComponent.createInstance( "com.sun.star.text.TextFrame" ) oFrame.Width = 6000 ThisComponent.Text.insertTextContent( ThisComponent.Text.Start, oFrame, false ) oFrame.Text.String = "Hello, this text is within the frame." End Sub </pre> </dd> <dt><b>See also</b></dt> <dd><a href="Text.html">Text</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/Shape_Objects_in_Text">Text - Shape Objects in Text</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"><a href="BaseFrame.html">BaseFrame</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>contains the definition of interfaces and properties that are supported by text frames, graphic objects and embeddedobjects. </dd> </dl> </td> </tr> </table> <a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces</td> </tr> <tr> <td class="imsum_left"><a href="XTextFrame.html">XTextFrame</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>This interface makes it possible to access the text within this text frame. </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">long<br> <a href="#FrameHeightAbsolute">FrameHeightAbsolute</a></td> <td class="imsum_right">contains the metric height value of the frame. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#FrameWidthAbsolute">FrameWidthAbsolute</a></td> <td class="imsum_right">contains the metric width value of the frame. </td> </tr> <tr> <td class="imsum_left">byte<br> <a href="#FrameWidthPercent">FrameWidthPercent</a></td> <td class="imsum_right">specifies a width relative to the width of the surrounding text. </td> </tr> <tr> <td class="imsum_left">byte<br> <a href="#FrameHeightPercent">FrameHeightPercent</a></td> <td class="imsum_right">specifies a width relative to the width of the surrounding text. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#FrameIsAutomaticHeight">FrameIsAutomaticHeight</a></td> <td class="imsum_right">If "AutomaticHeight" is set, then the object grows if it is required by the frame content. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#SizeType">SizeType</a></td> <td class="imsum_right">determines the interpretation of the height and relative height properties. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#WidthType">WidthType</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determines the interpretation of the width and relative width properties. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#WritingMode">WritingMode</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the writing direction, as represented by the <a href="WritingMode2.html">WritingMode2</a> constants </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsFollowingTextFlow">IsFollowingTextFlow</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>controls, if the frame follows the text flow or can leave its layout environment </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="FrameHeightAbsolute" class="membertitle">FrameHeightAbsolute</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>FrameHeightAbsolute</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the metric height value of the frame. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FrameWidthAbsolute" class="membertitle">FrameWidthAbsolute</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>FrameWidthAbsolute</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the metric width value of the frame. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FrameWidthPercent" class="membertitle">FrameWidthPercent</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>byte <b>FrameWidthPercent</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies a width relative to the width of the surrounding text. </dd> <dd><p>If the value for "WidthPercent" is 0, the absolute value from is used.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FrameHeightPercent" class="membertitle">FrameHeightPercent</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>byte <b>FrameHeightPercent</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies a width relative to the width of the surrounding text. </dd> <dd><p>If the value for "HeightPercent" is 0, the absolute value from is used.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FrameIsAutomaticHeight" class="membertitle">FrameIsAutomaticHeight</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>FrameIsAutomaticHeight</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If "AutomaticHeight" is set, then the object grows if it is required by the frame content. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SizeType" class="membertitle">SizeType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>SizeType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines the interpretation of the height and relative height properties. </dd> <dt><b>See also</b></dt> <dd><a href="SizeType.html">SizeType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="WidthType" class="membertitle">WidthType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>WidthType</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determines the interpretation of the width and relative width properties. </dd> <dt><b/></dt> <dd/><dt><b>See also</b></dt> <dd><a href="SizeType.html">SizeType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="WritingMode" class="membertitle">WritingMode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>WritingMode</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the writing direction, as represented by the <a href="WritingMode2.html">WritingMode2</a> constants </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsFollowingTextFlow" class="membertitle">IsFollowingTextFlow</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsFollowingTextFlow</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>controls, if the frame follows the text flow or can leave its layout environment </dd> <dd><p>If set, the frame follows the text flow and doesn't leaves the layout environment, which is given by its anchor, above and below. E.g.: Anchor resides in the document body then the frame doesn't leave the document body above and below and follows the text flow through the document bodies of the different pages. If not set, the frame doesn't follow the text flow and stays on the page, on which its anchor is found, but it may leave the layout environment, which is given by its anchor. E.g.: Anchor resides in the document body then the frame stays on page, where this document body is, but it could leave the document body above and below, e.g. overlapping with the page header. Note: The areas for the vertical orientation relation at page areas are interpreted in dependence to this property (</dd> <dt><b>See also</b></dt> <dd><a href="#BaseFrameProperties.VertOrientRelation).">BaseFrameProperties.VertOrientRelation).</a><br> If property is set, the page area is interpreted as the layout environment, given by its anchor. E.g.: Anchor resides in the page header then the page header determines the page area. If property isn't set, the page area is determined by the document page, the anchor is on. E.g.: Anchor resides in the page header then the document page, the page header is on, determines the page area. An exception of this interpretation rule is applied, if the anchor resides in a table cell. In this situation the page area is always detemined by the table cell.</p> </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
>
6583
