Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.3 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

service BaseFrame
Description
specifies the base service of text frames, graphic objects, and embedded objects
Developers Guide
Text - Shape Objects in Text

Included Services - Summary
BaseFrameProperties
(referenced entity's summary:)
specifies the properties that are provided by all text frames, graphic objects, embedded objects and frame styles.
TextContent
(referenced entity's summary:)
is an object which can be anchored in a text, like instances of TextFrame or TextField.
Exported Interfaces - Summary
::com::sun::star::drawing::XShape

This interface specifies the access to the shape data (position and size) of the text frame. (details)

::com::sun::star::beans::XPropertySet

This interface makes it possible to access the properties of this text frame. (details)

::com::sun::star::container::XNamed

This interface specifies the name of this text frame. (details)

Properties' Summary
string
FrameStyleName
contains the name of the frame style that is applied to this object.  
Included Services - Details
BaseFrameProperties
(referenced entity's summary:)
specifies the properties that are provided by all text frames, graphic objects, embedded objects and frame styles.
TextContent
(referenced entity's summary:)
is an object which can be anchored in a text, like instances of TextFrame or TextField.
Exported Interfaces - Details
::com::sun::star::drawing::XShape
Usage Restrictions
optional
Description
This interface specifies the access to the shape data (position and size) of the text frame.

This interface is valid before the text frame is attached to a surrounding text, but when attached the values can change (e.g., due to a revised layout of the surrounding text).

The position is relative to the position of the anchor [see XTextFrame::getAnchor()]. Size and position are both measured in 100th mm. The size is not valid if the size is relative and no layout exists or if the layout is invalid.

This interface is only for the layout. In particular, the setting of values is only allowed for the layout component of the owner text of this text component.

::com::sun::star::beans::XPropertySet
Description
This interface makes it possible to access the properties of this text frame.

This interface is valid before the text frame is attached to a surrounding text.

::com::sun::star::container::XNamed
Description
This interface specifies the name of this text frame.

The name may be set automatically by the container if it is not set when inserted. In this case a random, unique name is assigned.

Properties' Details
FrameStyleName
string FrameStyleName;
Description
contains the name of the frame style that is applied to this object.

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.