Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: text ::
service Shape
Description specifies the service of shapes in a text document Developers Guide 7.3.10 Text Documents - Working with Text Documents - Shape Objects in Text - Base Frames vs. Drawing Shapes 7.3.2 Text Documents - Working with Text Documents - Formatting

Included Services
::com::sun::star::drawing::Shape | This abstract service specifies the general characteristics of all ::com::sun::star::drawing::Shape s.

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.
AnchorType | [ OPTIONAL ] specifies how the text content is attached to its surrounding ::com::sun::star::drawing::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 | [ 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.
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.

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 .
AnchorType
TextContentAnchorType AnchorType; [ OPTIONAL ] Description specifies how the text content is attached to its surrounding ::com::sun::star::drawing::Text .
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
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.
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.
SurroundContour
boolean SurroundContour; Description determines if the text wraps around the contour of the object.
ContourOutside
boolean ContourOutside; Description the text flows only around the contour of the object.
Opaque
boolean Opaque; Description determines if the object is opaque or transparent for text.
TextRange
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 ::com::sun::star::drawing::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. This property is used when the shape gets inserted/added and becomes invalid after that.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.