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

service Shape

Exported Interfaces - Summary
::com::sun::star::beans::XPropertySet

handles all the properties of this instance.

XShape

This gives you the size and position of this Shape and lets you change it. You can use getShapeType() to determine what kind of shape this is.

::com::sun::star::lang::XComponent

is used for lifetime control of this Shape.

XShapeDescriptor

The XShapeDescriptor tells you what kind of Shape this instance is.

XGluePointsSupplier

This interfaces gives access to an optional container of glue points. To have unique ids you should query the returned interface for com::sun::star::container::XIdentifierContainer. (details)

::com::sun::star::beans::XTolerantMultiPropertySet
Properties' Summary
long
ZOrder
[ OPTIONAL ]
is used to query or change the ZOrder of this Shape.  
short
LayerID
[ OPTIONAL ]
This is the ID of the Layer to which this Shape is attached.  
string
LayerName
[ OPTIONAL ]
This is the name of the Layer to which this Shape is attached.  
boolean
Visible
[ OPTIONAL ]
If this is `FALSE`, the Shape is not visible on screen outputs. Please note that the Shape may still be visible when printed, see #Printable.  
boolean
Printable
[ OPTIONAL ]
If this is `FALSE`, the Shape is not visible on printer outputs.  
boolean
MoveProtect
[ OPTIONAL ]
With this set to `TRUE`, this Shape cannot be moved interactively in the user interface.  
string
Name
[ OPTIONAL ]
This is the name of this Shape.  
boolean
SizeProtect
[ OPTIONAL ]
With this set to `TRUE`, this Shape may not be sized interactively in the user interface.  
::com::sun::star::style::XStyle
Style
[ OPTIONAL ]
this property lets you get and set a style for this shape.  
HomogenMatrix3
Transformation
[ OPTIONAL ]
this property lets you get and set the transformation matrix for this shape. The transformation is a 3x3 homogeneous matrix and can contain translation, rotation, shearing and scaling.  
::com::sun::star::container::XNameContainer
ShapeUserDefinedAttributes
[ OPTIONAL ]
this property stores xml attributes. They will be saved to and restored from automatic styles inside xml files.  
long
NavigationOrder
[ OPTIONAL ]
this property stores the navigation order of this shape. If this value is negative, the navigation order for this shapes page is equal to the z-order.  
string
Hyperlink
[ OPTIONAL ]
this property lets you get and set a hyperlink for this shape.  
sequence< ::com::sun::star::beans::PropertyValue >
InteropGrabBag
[ OPTIONAL ]
Grab bag of shape properties, used as a string-any map for interim interop purposes.
Since LibreOffice 4.2  
short
RelativeHeight
[ OPTIONAL ]
contains the relative height of the object.  
short
RelativeWidth
[ OPTIONAL ]
contains the relative width of the object.  
short
RelativeHeightRelation
[ OPTIONAL ]
contains the relation of the relative height of the object.  
short
RelativeWidthRelation
[ OPTIONAL ]
contains the relation of the relative width of the object.  
Exported Interfaces - Details
::com::sun::star::beans::XPropertySet
Description
handles all the properties of this instance.
XShape
Description
This gives you the size and position of this Shape and lets you change it. You can use getShapeType() to determine what kind of shape this is.
::com::sun::star::lang::XComponent
Description
is used for lifetime control of this Shape.
XShapeDescriptor
Description
The XShapeDescriptor tells you what kind of Shape this instance is.
XGluePointsSupplier
Usage Restrictions
optional
Description
This interfaces gives access to an optional container of glue points. To have unique ids you should query the returned interface for com::sun::star::container::XIdentifierContainer.
::com::sun::star::beans::XTolerantMultiPropertySet
Usage Restrictions
optional
Properties' Details
ZOrder
long ZOrder;
Usage Restrictions
optional
Description
is used to query or change the ZOrder of this Shape.
LayerID
short LayerID;
Usage Restrictions
optional
Description
This is the ID of the Layer to which this Shape is attached.
LayerName
string LayerName;
Usage Restrictions
optional
Description
This is the name of the Layer to which this Shape is attached.
Visible
boolean Visible;
Usage Restrictions
optional
Description
If this is `FALSE`, the Shape is not visible on screen outputs. Please note that the Shape may still be visible when printed, see #Printable.
Printable
boolean Printable;
Usage Restrictions
optional
Description
If this is `FALSE`, the Shape is not visible on printer outputs.
MoveProtect
boolean MoveProtect;
Usage Restrictions
optional
Description
With this set to `TRUE`, this Shape cannot be moved interactively in the user interface.
Name
string Name;
Usage Restrictions
optional
Description
This is the name of this Shape.
SizeProtect
boolean SizeProtect;
Usage Restrictions
optional
Description
With this set to `TRUE`, this Shape may not be sized interactively in the user interface.
Style
::com::sun::star::style::XStyle Style;
Usage Restrictions
optional
Description
this property lets you get and set a style for this shape.
Transformation
HomogenMatrix3 Transformation;
Usage Restrictions
optional
Description
this property lets you get and set the transformation matrix for this shape. The transformation is a 3x3 homogeneous matrix and can contain translation, rotation, shearing and scaling.
ShapeUserDefinedAttributes
::com::sun::star::container::XNameContainer ShapeUserDefinedAttributes;
Usage Restrictions
optional
Description
this property stores xml attributes. They will be saved to and restored from automatic styles inside xml files.
See also
::com::sun::star::xml::AttributeContainer
NavigationOrder
long NavigationOrder;
Usage Restrictions
optional
Description
this property stores the navigation order of this shape. If this value is negative, the navigation order for this shapes page is equal to the z-order.
Hyperlink
string Hyperlink;
Usage Restrictions
optional
Description
this property lets you get and set a hyperlink for this shape.
InteropGrabBag
sequence< ::com::sun::star::beans::PropertyValue > InteropGrabBag;
Usage Restrictions
optional
Description
Grab bag of shape properties, used as a string-any map for interim interop purposes.
Since LibreOffice 4.2

This property is intentionally not handled by the ODF filter. Any member that should be handled there should be first moved out from this grab bag to a separate property.

RelativeHeight
short RelativeHeight;
Usage Restrictions
optional
Description
contains the relative height of the object.

It is only valid if it is greater than zero.


Since LibreOffice 4.3
RelativeWidth
short RelativeWidth;
Usage Restrictions
optional
Description
contains the relative width of the object.

It is only valid if it is greater than zero.


Since LibreOffice 4.3
RelativeHeightRelation
short RelativeHeightRelation;
Usage Restrictions
optional
Description
contains the relation of the relative height of the object.

It is only valid if RelativeHeight is greater than zero.

See also
::com::sun::star::text::RelOrientation

Since LibreOffice 4.3
RelativeWidthRelation
short RelativeWidthRelation;
Usage Restrictions
optional
Description
contains the relation of the relative width of the object.

It is only valid if RelativeWidth is greater than zero.

See also
::com::sun::star::text::RelOrientation

Since LibreOffice 4.3

 
Top of Page