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

(Global Index)

Syntax

service BaseFrameProperties;

Description

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

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

Property Details



AnchorPageNo

Syntax

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

Syntax

com::sun::star::text::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

Syntax

long BackColor;

Description

contains the color of the background of the object.


BackGraphicURL

Syntax

string BackGraphicURL;

Description

contains the URL for the background graphic.


BackGraphicFilter

Syntax

string BackGraphicFilter;

Description

contains the name of the file filter for the background graphic.


BackGraphicLocation

Syntax

com::sun::star::style::GraphicLocation BackGraphicLocation;

Description

determines the position of the background graphic.


LeftBorder

Syntax

com::sun::star::table::BorderLine LeftBorder;

Description

contains the left border of the object.

See also

BaseFrame::com::sun::star::table::BorderLine

RightBorder

Syntax

com::sun::star::table::BorderLine RightBorder;

Description

contains the right border of the object.

See also

BaseFrame::com::sun::star::table::BorderLine

TopBorder

Syntax

com::sun::star::table::BorderLine TopBorder;

Description

contains the top border of the object.

See also

BaseFrame::com::sun::star::table::BorderLine

BottomBorder

Syntax

com::sun::star::table::BorderLine BottomBorder;

Description

contains the bottom border of the object.

See also

BaseFrame::com::sun::star::table::BorderLine

BorderDistance

Syntax

long BorderDistance;

Description

contains the distance from the border to the object.


LeftBorderDistance

Syntax

long LeftBorderDistance;

Description

contains the distance from the left border to the object.


RightBorderDistance

Syntax

long RightBorderDistance;

Description

contains the distance from the right border to the object.


TopBorderDistance

Syntax

long TopBorderDistance;

Description

contains the distance from the top border to the object.


BottomBorderDistance

Syntax

long BottomBorderDistance;

Description

contains the distance from the bottom border to the object.


BackTransparent

Syntax

boolean BackTransparent;

Description

If TRUE, the "BackColor" is ignored.


ContentProtected

Syntax

boolean ContentProtected;

Description

determines if the content is protected.


LeftMargin

Syntax

long LeftMargin;

Description

contains the left margin of the object.


RightMargin

Syntax

long RightMargin;

Description

contains the right margin of the object.


TopMargin

Syntax

long TopMargin;

Description

contains the top margin of the object.


BottomMargin

Syntax

long BottomMargin;

Description

contains the bottom margin of the object.


Height

Syntax

long Height;

Description

contains the height of the object (1/100 mm).

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


Width

Syntax

long Width;

Description

contains the width of the object (1/100 mm).

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


RelativeHeight

Syntax

short RelativeHeight;

Description

contains the relative height of the object.

It is only valid if it is greater than zero.


RelativeWidth

Syntax

short RelativeWidth;

Description

contains the relative width of the object.

It is only valid if it is greater than zero.


IsSyncWidthToHeight

Syntax

boolean IsSyncWidthToHeight;

Description

determins whether the width follows the height.


IsSyncHeightToWidth

Syntax

boolean IsSyncHeightToWidth;

Description

determins whether the height follows the width.


HoriOrient

Syntax

short HoriOrient;

Description

determines the horizontal orientation of the object.

See also

BaseFrame::HoriOrientation

HoriOrientPosition

Syntax

long HoriOrientPosition;

Description

contains the horizontal position of the object (1/100 mm).

It is only valid if "HoriOrient" is HoriOrientation_NONE.


HoriOrientRelation

Syntax

short HoriOrientRelation;

Description

determines the environment of the object to which the orientation is related.

See also

BaseFrame::RelOrientation

VertOrient

Syntax

short VertOrient;

Description

determines the vertical orientation of the object.

See also

BaseFrame::VertOrientation

VertOrientPosition

Syntax

long VertOrientPosition;

Description

contains the vertical position of the object (1/100 mm). It is only valid if TextEmbeddedObject::VertOrient is VertOrientation::NONE .


VertOrientRelation

Syntax

short VertOrientRelation;

Description

determines the environment of the object to which the orientation is related.

See also

BaseFrame::RelOrientation

HyperLinkURL

Syntax

string HyperLinkURL;

Description

contains the URL of a hyperlink that is set at the object.


HyperLinkTarget

Syntax

string HyperLinkTarget;

Description

contains the name of the target for a hyperlink that is set at the object.


HyperLinkName

Syntax

string HyperLinkName;

Description

contains the name of the hyperlink that is set at the object.


Opaque

Syntax

boolean Opaque;

Description

determines if the object is opaque or transparent for text.


PageToggle

Syntax

boolean PageToggle;

Description

determines if the object is mirrored on even pages.


PositionProtected

Syntax

boolean PositionProtected;

Description

determines if the position is protected.


Print

Syntax

boolean Print;

Description

determines if the object is included in printing.


ShadowFormat

Syntax

com::sun::star::table::ShadowFormat ShadowFormat;

Description

contains the type of the shadow of the object.


ServerMap

Syntax

boolean ServerMap;

Description

determines if the object gets an image map from a server.


Size

Syntax

com::sun::star::awt::Size Size;

Description

contains the size of the object.

See also

BaseFrame::Height

See also

BaseFrame::Width

SizeProtected

Syntax

boolean SizeProtected;

Description

determines if the size is protected.


Surround

[ DEPRECATED ]

Syntax

com::sun::star::text::WrapTextMode Surround;

Description

determines the type of the surrounding text.


SurroundAnchorOnly

Syntax

boolean SurroundAnchorOnly;

Description

determines if the text of the paragraph in which the object is anchored, wraps around the object.

Top of Page