LibreOffice: OLE2Shape Service Reference

LibreOffice LibreOffice 5.0 SDK API Reference

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Included Services | Public Attributes | List of all members
OLE2Shape Service Referencepublished

This service is for an OLE shape. More...

`import"OLE2Shape.idl";`

Inheritance diagram for OLE2Shape:

## Included Services
service | com::sun::star::drawing::Shape

## Public Attributes
string | CLSID
| If you get this property you get the CLSID of the OLE2 document stream contained in this OLE2 shape. More...
string | PersistName
| this is the internal storage name that keeps this OLE2 persist. More...
com::sun::star::frame::XModel | Model
| This is the model for the OLE2 inside this shape. More...
boolean | IsInternal
| This property returns `TRUE` for all OLE2 that are internal Office components. More...
Public Attributes inherited from Shape
long | ZOrder
| is used to query or change the ZOrder of this Shape. More...
short | LayerID
| This is the ID of the Layer to which this Shape is attached. More...
string | LayerName
| This is the name of the Layer to which this Shape is attached. More...
boolean | Visible
| If this is `FALSE`, the Shape is not visible on screen outputs. More...
boolean | Printable
| If this is `FALSE`, the Shape is not visible on printer outputs. More...
boolean | MoveProtect
| With this set to `TRUE`, this Shape cannot be moved interactively in the user interface. More...
string | Name
| This is the name of this Shape. More...
boolean | SizeProtect
| With this set to `TRUE`, this Shape may not be sized interactively in the user interface. More...
com::sun::star::style::XStyle | Style
| this property lets you get and set a style for this shape. More...
com::sun::star::drawing::HomogenMatrix3 | Transformation
| this property lets you get and set the transformation matrix for this shape. More...
com::sun::star::container::XNameContainer | ShapeUserDefinedAttributes
| this property stores xml attributes. More...
long | NavigationOrder
| this property stores the navigation order of this shape. More...
string | Hyperlink
| this property lets you get and set a hyperlink for this shape. More...
sequence< com::sun::star::beans::PropertyValue > | InteropGrabBag
| Grab bag of shape properties, used as a string-any map for interim interop purposes. More...
short | RelativeHeight
| contains the relative height of the object. More...
short | RelativeWidth
| contains the relative width of the object. More...
short | RelativeHeightRelation
| contains the relation of the relative height of the object. More...
short | RelativeWidthRelation
| contains the relation of the relative width of the object. More...

## Additional Inherited Members
Exported Interfaces inherited from Shape
interface | com::sun::star::beans::XPropertySet
| handles all the properties of this instance. More...
interface | com::sun::star::drawing::XShape
| This gives you the size and position of this Shape and lets you change it. More...
interface | com::sun::star::lang::XComponent
| is used for lifetime control of this Shape. More...
interface | com::sun::star::drawing::XShapeDescriptor
| The XShapeDescriptor tells you what kind of Shape this instance is. More...
interface | com::sun::star::drawing::XGluePointsSupplier
| This interfaces gives access to an optional container of glue points. More...
interface | com::sun::star::beans::XTolerantMultiPropertySet
Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo ()
void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
| sets the value of the property with the specified name. More...
any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| adds an XPropertyChangeListener to the specified property. More...
void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| removes an XPropertyChangeListener from the listener list. More...
void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| removes an XVetoableChangeListener from the listener list. More...
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object. More...
void | acquire ()
| increases the reference counter by one. More...
void | release ()
| decreases the reference counter by one. More...
Public Member Functions inherited from XShape
com::sun::star::awt::Point | getPosition ()
| gets the current position of this object. More...
void | setPosition ([in] com::sun::star::awt::Point aPosition)
| sets the current position of this object More...
com::sun::star::awt::Size | getSize ()
| gets the size of this object. More...
void | setSize ([in] com::sun::star::awt::Size aSize) raises ( com::sun::star::beans::PropertyVetoException )
| sets the size of this object. More...
Public Member Functions inherited from XShapeDescriptor
string | getShapeType ()
Public Member Functions inherited from XComponent
void | dispose ()
| The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
void | addEventListener ([in] XEventListener xListener)
| adds an event listener to the object. More...
void | removeEventListener ([in] XEventListener aListener)
| removes an event listener from the listener list. More...
Protected Member Functions inherited from XGluePointsSupplier
com::sun::star::container::XIndexContainer | getGluePoints ()
Protected Member Functions inherited from XTolerantMultiPropertySet
sequence< com::sun::star::beans::SetPropertyTolerantFailed > | setPropertyValuesTolerant ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::lang::IllegalArgumentException )
| sets the values to the properties with the specified names. More...
sequence< com::sun::star::beans::GetPropertyTolerantResult > | getPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
| retrieve the values of the specified properties More...
sequence< com::sun::star::beans::GetDirectPropertyTolerantResult > | getDirectPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
| retrieve only those values of the specified properties which are direct values. More...

## Detailed Description

This service is for an OLE shape.

Developers Guide
  Charts - Working With Charts - Document Structure

## Exported Interfaces

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

## Member Data Documentation

string CLSID
| property

If you get this property you get the CLSID of the OLE2 document stream contained in this OLE2 shape.

If you set it, an empty OLE2 document stream with this CLSID is created within this OLE2 shape.

boolean IsInternal
| propertyreadonly

This property returns `TRUE` for all OLE2 that are internal Office components.

com::sun::star::frame::XModel Model
| propertyreadonly

This is the model for the OLE2 inside this shape.

This property returns an empty reference if the OLE2 is not an Office component.

string PersistName
| property

this is the internal storage name that keeps this OLE2 persist.

The documentation for this service was generated from the following file:

- com/sun/star/drawing/OLE2Shape.idl