Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

service BaseFrameProperties
Description
specifies the properties that are provided by all text frames, graphic objects, embedded objects and frame styles.

Included Services - Summary
::com::sun::star::xml::UserDefinedAttributesSupplier

gives access to the UserDefinedAttributes property. (details)

Properties' Summary
short
AnchorPageNo
contains the number of the page where the objects are anchored.  
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
determins whether the width follows the height.  
boolean
IsSyncHeightToWidth
determins 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). It is only valid if TextEmbeddedObject::VertOrient is VertOrientation::NONE.  
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.  
WrapTextMode
Surround
[ DEPRECATED ]
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
[ OPTIONAL ]
determines the influence of the text wrap on the positioning of the shape  
[ maybevoid ] ::com::sun::star::awt::Size
LayoutSize
[ OPTIONAL ]
returns the actual size of the object.  
string
Title
[ OPTIONAL ]
contains short title for the object  
string
Description
[ OPTIONAL ]
contains description for the object  
Included Services - Details
::com::sun::star::xml::UserDefinedAttributesSupplier
Usage Restrictions
optional
Description
gives access to the UserDefinedAttributes property.
Since
OOo 2.1
Properties' Details
AnchorPageNo
short AnchorPageNo;
Description
contains the number of the page where the objects are anchored.

The value is valid only if the AnchorType is TextContentAnchorType::AT_PAGE.

AnchorFrame
XTextFrame AnchorFrame;
Description
contains the text frame the current frame is anchored to.

The value is valid only if the AnchorType is TextContentAnchorType::AT_FRAME.

BackColor
::com::sun::star::util::Color BackColor;
Description
contains the color of the background of the object.
BackGraphicURL
string BackGraphicURL;
Description
contains the URL for the background graphic.
BackGraphicFilter
string BackGraphicFilter;
Description
contains the name of the file filter for the background graphic.
BackGraphicLocation
::com::sun::star::style::GraphicLocation BackGraphicLocation;
Description
determines the position of the background graphic.
LeftBorder
::com::sun::star::table::BorderLine LeftBorder;
Description
contains the left border of the object.
See also
BaseFrame::com
RightBorder
::com::sun::star::table::BorderLine RightBorder;
Description
contains the right border of the object.
See also
BaseFrame::com
TopBorder
::com::sun::star::table::BorderLine TopBorder;
Description
contains the top border of the object.
See also
BaseFrame::com
BottomBorder
::com::sun::star::table::BorderLine BottomBorder;
Description
contains the bottom border of the object.
See also
BaseFrame::com
BorderDistance
long BorderDistance;
Description
contains the distance from the border to the object.
LeftBorderDistance
long LeftBorderDistance;
Description
contains the distance from the left border to the object.
RightBorderDistance
long RightBorderDistance;
Description
contains the distance from the right border to the object.
TopBorderDistance
long TopBorderDistance;
Description
contains the distance from the top border to the object.
BottomBorderDistance
long BottomBorderDistance;
Description
contains the distance from the bottom border to the object.
BackTransparent
boolean BackTransparent;
Description
If TRUE, the "BackColor" is ignored.
ContentProtected
boolean ContentProtected;
Description
determines if the content is protected.
LeftMargin
long LeftMargin;
Description
contains the left margin of the object.
RightMargin
long RightMargin;
Description
contains the right margin of the object.
TopMargin
long TopMargin;
Description
contains the top margin of the object.
BottomMargin
long BottomMargin;
Description
contains the bottom margin of the object.
Height
long Height;
Description
contains the height of the object (1/100 mm).

It is only valid if TextEmbeddedObject::RelativeHeight is zero.

Width
long Width;
Description
contains the width of the object (1/100 mm).

It is only valid if TextEmbeddedObject::RelativeWidth is zero.

RelativeHeight
short RelativeHeight;
Description
contains the relative height of the object.

It is only valid if it is greater than zero.

RelativeWidth
short RelativeWidth;
Description
contains the relative width of the object.

It is only valid if it is greater than zero.

IsSyncWidthToHeight
boolean IsSyncWidthToHeight;
Description
determins whether the width follows the height.
IsSyncHeightToWidth
boolean IsSyncHeightToWidth;
Description
determins whether the height follows the width.
HoriOrient
short HoriOrient;
Description
determines the horizontal orientation of the object.
See also
BaseFrame::HoriOrientation
HoriOrientPosition
long HoriOrientPosition;
Description
contains the horizontal position of the object (1/100 mm).

It is only valid if "HoriOrient" is HoriOrientation_NONE.

HoriOrientRelation
short HoriOrientRelation;
Description
determines the environment of the object to which the orientation is related.
See also
BaseFrame::RelOrientation
VertOrient
short VertOrient;
Description
determines the vertical orientation of the object.
See also
BaseFrame::VertOrientation
VertOrientPosition
long VertOrientPosition;
Description
contains the vertical position of the object (1/100 mm). It is only valid if TextEmbeddedObject::VertOrient is VertOrientation::NONE.
VertOrientRelation
short VertOrientRelation;
Description
determines the environment of the object to which the orientation is related.
See also
BaseFrame::RelOrientation
HyperLinkURL
string HyperLinkURL;
Description
contains the URL of a hyperlink that is set at the object.
HyperLinkTarget
string HyperLinkTarget;
Description
contains the name of the target for a hyperlink that is set at the object.
HyperLinkName
string HyperLinkName;
Description
contains the name of the hyperlink that is set at the object.
Opaque
boolean Opaque;
Description
determines if the object is opaque or transparent for text.
PageToggle
boolean PageToggle;
Description
determines if the object is mirrored on even pages.
PositionProtected
boolean PositionProtected;
Description
determines if the position is protected.
Print
boolean Print;
Description
determines if the object is included in printing.
ShadowFormat
::com::sun::star::table::ShadowFormat ShadowFormat;
Description
contains the type of the shadow of the object.
ServerMap
boolean ServerMap;
Description
determines if the object gets an image map from a server.
Size
::com::sun::star::awt::Size Size;
Description
contains the size of the object.
See also
BaseFrame::Height, BaseFrame::Width
SizeProtected
boolean SizeProtected;
Description
determines if the size is protected.
Surround
WrapTextMode Surround;
Usage Restrictions
deprecated
Description
determines the type of the surrounding text.
SurroundAnchorOnly
boolean SurroundAnchorOnly;
Description
determines if the text of the paragraph in which the object is anchored, wraps around the object.
WrapInfluenceOnPosition
short WrapInfluenceOnPosition;
Usage Restrictions
optional
Description
determines the influence of the text wrap on the positioning of the shape

The value of this property is only evaluated for the positioning of the shape, if the text document setting ConsiderTextWrapOnObjPos is true. Valid values are given by WrapInfluenceOnPosition

Since
OOo 2.0
LayoutSize
[ maybevoid ] ::com::sun::star::awt::Size LayoutSize;
Usage Restrictions
optional
Description
returns the actual size of the object.

Since to obtain the correct actual size of the object not only the layouting for the frame needs to be finished but the whole document needs to be formatted as well. Thus if that was not done previously it may take some while to retrieve this value.

Since
OOo 2.0.4
Title
string Title;
Usage Restrictions
optional
Description
contains short title for the object

This short title is visible as an alternative tag in HTML format. Accessibility tools can read this text.

Since
OOo 3.2
Description
string Description;
Usage Restrictions
optional
Description
contains description for the object

The long description text can be entered to describe a object in more detail to users with screen reader software. The description is visible as an alternative tag for accessibility tools.

Since
OOo 3.2

 
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.