service TextFrame in module com::sun::star::text::

(Global Index)

Syntax

service TextFrame;

Description

specifies a rectangular shape which contains a Text object and is attached to a piece of surrounding 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

Included Services

com::sun::star::text::BaseFrame

Description

contains the definition of interfaces and properties that are supported by text frames, graphic objects and embeddedobjects.


Exported Interfaces

com::sun::star::text::XTextFrame

Description

This interface makes it possible to access the text within this text frame.


Property 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.

Property Details



FrameHeightAbsolute

Syntax

long FrameHeightAbsolute;

Description

contains the metric height value of the frame.


FrameWidthAbsolute

Syntax

long FrameWidthAbsolute;

Description

contains the metric width value of the frame.


FrameWidthPercent

Syntax

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

Syntax

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

Syntax

boolean FrameIsAutomaticHeight;

Description

If "AutomaticHeight" is set, then the object grows if it is required by the frame content.


SizeType

Syntax

short SizeType;

Description

determines the interpretation of the height and relative height properties.

See also

SizeType
Top of Page