|
long | FrameHeightAbsolute |
| contains the metric height value of the frame.
|
long | FrameWidthAbsolute |
| contains the metric width value of the frame.
|
byte | FrameWidthPercent |
| specifies a width relative to the width of the surrounding text.
|
byte | FrameHeightPercent |
| specifies a width relative to the width of the surrounding text.
|
boolean | FrameIsAutomaticHeight |
| If "AutomaticHeight" is set, then the object grows if it is required by the frame content.
|
short | SizeType |
| determines the interpretation of the height and relative height properties.
|
boolean | EditInReadonly |
| determines if the text frame should be editable in a read-only document.
|
short | WidthType |
| determines the interpretation of the width and relative width properties.
|
short | WritingMode |
| contains the writing direction, as represented by the com::sun::star::text::WritingMode2 constants
|
boolean | IsFollowingTextFlow |
| controls, if the frame follows the text flow or can leave its layout environment
|
com::sun::star::drawing::TextVerticalAdjust | TextVerticalAdjust |
| adjusts the vertical position of the text inside of the frame.
|
com::sun::star::text::XText | ParentText |
| Parent text of this text frame.
|
string | FrameStyleName |
| contains the name of the frame style that is applied to this object.
|
short | AnchorPageNo |
| contains the number of the page where the objects are anchored.
|
com::sun::star::text::XTextFrame | AnchorFrame |
| contains the text frame the current frame is anchored to.
|
com::sun::star::util::Color | BackColor |
| contains the color of the background of the object.
|
string | BackGraphicURL |
| contains the URL for the background graphic.
|
string | BackGraphicFilter |
| contains the name of the file filter for the background graphic.
|
com::sun::star::style::GraphicLocation | BackGraphicLocation |
| determines the position of the background graphic.
|
com::sun::star::table::BorderLine | LeftBorder |
| contains the left border of the object.
|
com::sun::star::table::BorderLine | RightBorder |
| contains the right border of the object.
|
com::sun::star::table::BorderLine | TopBorder |
| contains the top border of the object.
|
com::sun::star::table::BorderLine | BottomBorder |
| contains the bottom border of the object.
|
long | BorderDistance |
| contains the distance from the border to the object.
|
long | LeftBorderDistance |
| contains the distance from the left border to the object.
|
long | RightBorderDistance |
| contains the distance from the right border to the object.
|
long | TopBorderDistance |
| contains the distance from the top border to the object.
|
long | BottomBorderDistance |
| contains the distance from the bottom border to the object.
|
boolean | BackTransparent |
| If TRUE, the "BackColor" is ignored.
|
boolean | ContentProtected |
| determines if the content is protected.
|
long | LeftMargin |
| contains the left margin of the object.
|
long | RightMargin |
| contains the right margin of the object.
|
long | TopMargin |
| contains the top margin of the object.
|
long | BottomMargin |
| contains the bottom margin of the object.
|
long | Height |
| contains the height of the object (1/100 mm).
|
long | Width |
| contains the width of the object (1/100 mm).
|
short | RelativeHeight |
| contains the relative height of the object.
|
short | RelativeWidth |
| contains the relative width of the object.
|
boolean | IsSyncWidthToHeight |
| determines whether the width follows the height.
|
boolean | IsSyncHeightToWidth |
| determines whether the height follows the width.
|
short | HoriOrient |
| determines the horizontal orientation of the object.
|
long | HoriOrientPosition |
| contains the horizontal position of the object (1/100 mm).
|
short | HoriOrientRelation |
| determines the environment of the object to which the orientation is related.
|
short | VertOrient |
| determines the vertical orientation of the object.
|
long | VertOrientPosition |
| contains the vertical position of the object (1/100 mm).
|
short | VertOrientRelation |
| determines the environment of the object to which the orientation is related.
|
string | HyperLinkURL |
| contains the URL of a hyperlink that is set at the object.
|
string | HyperLinkTarget |
| contains the name of the target for a hyperlink that is set at the object.
|
string | HyperLinkName |
| contains the name of the hyperlink that is set at the object.
|
boolean | Opaque |
| determines if the object is opaque or transparent for text.
|
boolean | PageToggle |
| determines if the object is mirrored on even pages.
|
boolean | PositionProtected |
| determines if the position is protected.
|
boolean | Print |
| determines if the object is included in printing.
|
com::sun::star::table::ShadowFormat | ShadowFormat |
| contains the type of the shadow of the object.
|
boolean | ServerMap |
| determines if the object gets an image map from a server.
|
com::sun::star::awt::Size | Size |
| contains the size of the object.
|
boolean | SizeProtected |
| determines if the size is protected.
|
com::sun::star::text::WrapTextMode | Surround |
| determines the type of the surrounding text.
|
boolean | SurroundAnchorOnly |
| determines if the text of the paragraph in which the object is anchored, wraps around the object.
|
short | WrapInfluenceOnPosition |
| determines the influence of the text wrap on the positioning of the shape
|
com::sun::star::awt::Size | LayoutSize |
| returns the actual size of the object.
|
string | Title |
| contains short title for the object
|
string | Description |
| contains description for the object
|
com::sun::star::drawing::FillStyle | FillStyle |
| This enumeration selects the style the area will be filled with.
|
com::sun::star::awt::Gradient | FillGradient |
| If the property FillStyle is set to FillStyle::GRADIENT, this describes the gradient used.
|
string | FillGradientName |
| If the property FillStyle is set to FillStyle::GRADIENT, this is the name of the gradient used.
|
short | ShadowTransparence |
| This defines the degree of transparence of the shadow in percent.
|
short | RelativeHeightRelation |
| contains the relation of the relative height of the object.
|
short | RelativeWidthRelation |
| contains the relation of the relative width of the object.
|
com::sun::star::graphic::XGraphic | BackGraphic |
| contains the graphic for the background.
|
boolean | AllowOverlap |
| This defines if the frame is allowed to overlap with other anchored objects.
|
string | Tooltip |
| Contains popup text for the frame, used to for tooltip purposes if it's non-empty.
|
boolean | Decorative |
| Determines if the frame is purely decorative.
|
boolean | IsSplitAllowed |
| If TRUE, the frame is allowed to be split at page breaks.
|
boolean | WrapTextAtFlyStart |
| If TRUE, text wraps around a split fly on all pages.
|
com::sun::star::text::TextContentAnchorType | AnchorType |
| specifies how the text content is attached to its surrounding Text.
|
com::sun::star::text::WrapTextMode | TextWrap |
| specifies if the text content is a shape and how the text is wrapped around the shape.
|
|
typedef sequence< com::sun::star::beans::PropertyValue > | FrameInteropGrabBag |
| Grab bag of frame properties, used as a string-any map for interim interop purposes.
|
typedef sequence< com::sun::star::text::TextContentAnchorType > | AnchorTypes |
| contains the anchor type of the text content.
|
void | attach ([in] com::sun::star::text::XTextRange xTextRange) raises ( com::sun::star::lang::IllegalArgumentException ) |
| is called when this object gets embedded in a text.
|
com::sun::star::text::XTextRange | getAnchor () |
void | dispose () |
| The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references.
|
void | addEventListener ([in] XEventListener xListener) |
| adds an event listener to the object.
|
void | removeEventListener ([in] XEventListener aListener) |
| removes an event listener from the listener list.
|
any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object.
|
void | acquire () |
| increases the reference counter by one.
|
void | release () |
| decreases the reference counter by one.
|
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
| sets the value of the property with the specified name.
|
any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XPropertyChangeListener to the specified property.
|
void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XPropertyChangeListener from the listener list.
|
void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XVetoableChangeListener to the specified property with the name PropertyName.
|
void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XVetoableChangeListener from the listener list.
|
string | getName () |
void | setName ([in] string aName) |
| sets the programmatic name of the object.
|
com::sun::star::text::XText | getText () |
com::sun::star::awt::Point | getPosition () |
| gets the current position of this object.
|
void | setPosition ([in] com::sun::star::awt::Point aPosition) |
| sets the current position of this object
|
com::sun::star::awt::Size | getSize () |
| gets the size of this object.
|
void | setSize ([in] com::sun::star::awt::Size aSize) raises ( com::sun::star::beans::PropertyVetoException ) |
| sets the size of this object.
|
string | getShapeType () |
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
| sets the value of the property with the specified name.
|
any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XPropertyChangeListener to the specified property.
|
void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XPropertyChangeListener from the listener list.
|
void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XVetoableChangeListener to the specified property with the name PropertyName.
|
void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XVetoableChangeListener from the listener list.
|
string | getName () |
void | setName ([in] string aName) |
| sets the programmatic name of the object.
|
::com::sun::star::container::XNameContainer | UserDefinedAttributes |
| This container holds the AttributeData elements that represent uninterpreted XML attributes.
|
specifies a rectangular shape which contains a Text object and is attached to a piece of surrounding Text.
- See also
- Text
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
- Text Documents - Shape Objects in Text