Overview | Module | Use | Devguide | Index

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

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

Properties' Summary
AnchorPageNo | contains the number of the page where the objects are anchored.
AnchorFrame | contains the text frame the current frame is anchored to.
BackColor | contains the color of the background of the object.
BackGraphicURL | contains the URL for the background graphic.
BackGraphicFilter | contains the name of the file filter for the background graphic.
BackGraphicLocation | determines the position of the background graphic.
LeftBorder | contains the left border of the object.
RightBorder | contains the right border of the object.
TopBorder | contains the top border of the object.
BottomBorder | contains the bottom border of the object.
BorderDistance | contains the distance from the border to the object.
LeftBorderDistance | contains the distance from the left border to the object.
RightBorderDistance | contains the distance from the right border to the object.
TopBorderDistance | contains the distance from the top border to the object.
BottomBorderDistance | contains the distance from the bottom border to the object.
BackTransparent | If TRUE, the "BackColor" is ignored.
ContentProtected | determines if the content is protected.
LeftMargin | contains the left margin of the object.
RightMargin | contains the right margin of the object.
TopMargin | contains the top margin of the object.
BottomMargin | contains the bottom margin of the object.
Height | contains the height of the object (1/100 mm).
Width | contains the width of the object (1/100 mm).
RelativeHeight | contains the relative height of the object.
RelativeWidth | contains the relative width of the object.
IsSyncWidthToHeight | determins whether the width follows the height.
IsSyncHeightToWidth | determins whether the height follows the width.
HoriOrient | determines the horizontal orientation of the object.
HoriOrientPosition | contains the horizontal position of the object (1/100 mm).
HoriOrientRelation | determines the environment of the object to which the orientation is related.
VertOrient | determines the vertical orientation of the object.
VertOrientPosition | contains the vertical position of the object (1/100 mm). It is only valid if TextEmbeddedObject::VertOrient is VertOrientation::NONE .
VertOrientRelation | determines the environment of the object to which the orientation is related.
HyperLinkURL | contains the URL of a hyperlink that is set at the object.
HyperLinkTarget | contains the name of the target for a hyperlink that is set at the object.
HyperLinkName | contains the name of the hyperlink that is set at the object.
Opaque | determines if the object is opaque or transparent for text.
PageToggle | determines if the object is mirrored on even pages.
PositionProtected | determines if the position is protected.
Print | determines if the object is included in printing.
ShadowFormat | contains the type of the shadow of the object.
ServerMap | determines if the object gets an image map from a server.
Size | contains the size of the object.
SizeProtected | determines if the size is protected.
Surround | [ DEPRECATED ] determines the type of the surrounding text.
SurroundAnchorOnly | determines if the text of the paragraph in which the object is anchored, wraps around the object.

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
long 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 See also BaseFrame::Width
SizeProtected
boolean SizeProtected; Description determines if the size is protected.
Surround
WrapTextMode Surround; [ 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.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.