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

(Global Index)

Syntax

service Shape;

Description

specifies the service of shapes in a text document

Included Services

com::sun::star::drawing::Shape

Description

This abstract service specifies the general characteristics of all Shape s.


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.

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

AnchorType specifies how the text content is attached to its surrounding Text .

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.

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.

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.

SurroundContour determines if the text wraps around the contour of the object.

ContourOutside the text flows only around the contour of the object.

Opaque determines if the object is opaque or transparent for text.

TextRange contains a text range where the shape should be anchored to.

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 .


SurroundAnchorOnly

Syntax

boolean SurroundAnchorOnly;

Description

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


AnchorType [ O P T I O N A L ]

Syntax

com::sun::star::text::TextContentAnchorType AnchorType;

Description

specifies how the text content is attached to its surrounding Text .


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

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.


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.


SurroundContour

Syntax

boolean SurroundContour;

Description

determines if the text wraps around the contour of the object.


ContourOutside

Syntax

boolean ContourOutside;

Description

the text flows only around the contour of the object.


Opaque

Syntax

boolean Opaque;

Description

determines if the object is opaque or transparent for text.


TextRange

Syntax

com::sun::star::text::XTextRange TextRange;

Description

contains a text range where the shape should be anchored to.

There are two different ways to get newly created shapes into the text document. One of them is to use the insertTextContent() method of the XSimpleText . The other is to call the add() method of the XShapes interface. To be able to determine an anchor position for shape that are anchored at a certain text position the property TextRange is used.

Top of Page