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 Shape
Description
specifies the service of shapes in a text document
Developers Guide
Text - Shape Objects in Text
Text - Formatting

Included Services - Summary
::com::sun::star::drawing::Shape
(referenced entity's summary:)
This abstract service specifies the general characteristics of all ::com::sun::star::drawing::Shapes.
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.  
TextContentAnchorType
AnchorType
[ OPTIONAL ]
specifies how the text content is attached to its surrounding Text.  
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.  
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.  
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.  
boolean
SurroundContour
determines if the text wraps around the contour of the object.  
boolean
ContourOutside
the text flows only around the contour of the object.  
boolean
Opaque
determines if the object is opaque or transparent for text.  
XTextRange
TextRange
contains a text range where the shape should be anchored to.  
short
WrapInfluenceOnPosition
[ OPTIONAL ]
determines the influence of the text wrap on the positioning of the shape  
[ readonly ] ::com::sun::star::drawing::HomogenMatrix3
TransformationInHoriL2R
[ OPTIONAL ]
determines the transformation of the shape in horizontal left-to-right layout  
short
PositionLayoutDir
[ OPTIONAL ]
determines layout direction the position attributes of the shape is given  
[ readonly ] ::com::sun::star::awt::Point
StartPositionInHoriL2R
[ OPTIONAL ]
determines the start position of the shape in horizontal left-to-right layout  
[ readonly ] ::com::sun::star::awt::Point
EndPositionInHoriL2R
[ OPTIONAL ]
determines the end position of the shape in horizontal left-to-right layout  
Included Services - Details
::com::sun::star::drawing::Shape
(referenced entity's summary:)
This abstract service specifies the general characteristics of all ::com::sun::star::drawing::Shapes.
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;
Usage Restrictions
optional
Description
specifies how the text content is attached to its surrounding 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;
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.
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.

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
TransformationInHoriL2R
[ readonly ] ::com::sun::star::drawing::HomogenMatrix3 TransformationInHoriL2R;
Usage Restrictions
optional
Description
determines the transformation of the shape in horizontal left-to-right layout

This property is needed for the export of the OASIS Open Office file format to the OpenOffice.org file format. It provides the transformation property of the included service com::sun::star::drawing::Shape converted to the horizontal left-to-right layout.

Since
OOo 2.0
PositionLayoutDir
short PositionLayoutDir;
Usage Restrictions
optional
Description
determines layout direction the position attributes of the shape is given

Valid values are given by PositionLayoutDir

Since
OOo 2.0
StartPositionInHoriL2R
[ readonly ] ::com::sun::star::awt::Point StartPositionInHoriL2R;
Usage Restrictions
optional
Description
determines the start position of the shape in horizontal left-to-right layout

This property is needed for the export of the OASIS Open Office file format to the OpenOffice.org file format. It provides the start position property of the included service com::sun::star::drawing::Shape converted to the horizontal left-to-right layout.

Since
OOo 2.0
EndPositionInHoriL2R
[ readonly ] ::com::sun::star::awt::Point EndPositionInHoriL2R;
Usage Restrictions
optional
Description
determines the end position of the shape in horizontal left-to-right layout

This property is needed for the export of the OASIS Open Office file format to the OpenOffice.org file format. It provides the end position property of the included service com::sun::star::drawing::Shape converted to the horizontal left-to-right layout.

Since
OOo 2.0

 
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.