Overview | Module | Use | Devguide | Index

Included Services | Exported Interfaces | Properties' Summary | Properties' Details

:: com :: sun :: star :: text ::
service TextFrame
  Description specifies a rectangular shape which contains a ::com::sun::star::drawing::Text object and is attached to a piece of surrounding ::com::sun::star::drawing::Text . See also Text Example StarBasic This example shows how to create a TextFrame and insert it at the very beginning of Text component. The macro is ready to run, if it is a script within a text document.
       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
Developers Guide 7.3.10 Text Documents - Working with Text Documents - Shape Objects in Text - Base Frames vs. Drawing Shapes

Included Services
BaseFrame | Description contains the definition of interfaces and properties that are supported by text frames, graphic objects and embeddedobjects.

Exported Interfaces
XTextFrame | Description This interface makes it possible to access the text within this text frame.

Properties' Summary
FrameHeightAbsolute | contains the metric height value of the frame.
FrameWidthAbsolute | contains the metric width value of the frame.
FrameWidthPercent | specifies a width relative to the width of the surrounding text.
FrameHeightPercent | specifies a width relative to the width of the surrounding text.
FrameIsAutomaticHeight | If "AutomaticHeight" is set, then the object grows if it is required by the frame content.
SizeType | determines the interpretation of the height and relative height properties.
WritingMode | [ OPTIONAL ] contains the writing direction, as represented by the WritingMode2 constants

Properties' Details
FrameHeightAbsolute
long FrameHeightAbsolute; Description contains the metric height value of the frame.
FrameWidthAbsolute
long FrameWidthAbsolute; Description contains the metric width value of the frame.
FrameWidthPercent
byte FrameWidthPercent; Description specifies a width relative to the width of the surrounding text. If the value for "WidthPercent" is 0, the absolute value from is used.
FrameHeightPercent
byte FrameHeightPercent; Description specifies a width relative to the width of the surrounding text. If the value for "HeightPercent" is 0, the absolute value from is used.
FrameIsAutomaticHeight
boolean FrameIsAutomaticHeight; Description If "AutomaticHeight" is set, then the object grows if it is required by the frame content.
SizeType
short SizeType; Description determines the interpretation of the height and relative height properties. See also SizeType
WritingMode
short WritingMode; [ OPTIONAL ] Description contains the writing direction, as represented by the WritingMode2 constants

Top of Page

Copyright © 2003 Sun Microsystems, Inc.