Represents Microsoft Excel OLEObject object. More...

#include <wxAutoExcelOLEObjects.h>

Inheritance diagram for wxAutoExcel::wxExcelOLEObject:

Public Member Functions
bool	Activate ()
	Activates the object.

bool	BringToFront ()
	Brings the object to the front of the z-order.

bool	Copy ()
	Copies the object to the Clipboard.

bool	CopyPicture (XlPictureAppearance appearance, XlCopyPictureFormat format)
	Copies the selected object to the Clipboard as a picture.

bool	Cut ()
	Cuts the object to the Clipboard or pastes it into a specified destination.

bool	Delete ()
	Deletes the object.

wxExcelObject	Duplicate ()
	Duplicates the object and returns a reference to the new copy.

bool	Select (wxXlTribool replace=wxDefaultXlTribool)
	Selects the object.

bool	SendToBack ()
	Sends the object to the back of the z-order.

bool	Update ()
	Updates the link.

bool	Verb (XlOLEVerb *verb=NULL)
	Sends a verb to the server of the specified OLE object.

bool	GetAutoLoad ()
	True if the OLE object is automatically loaded when the workbook that contains it is opened.

void	SetAutoLoad (bool autoLoad)
	True if the OLE object is automatically loaded when the workbook that contains it is opened.

bool	GetAutoUpdate ()
	True if the OLE object is updated automatically when the source changes.

wxExcelBorder	GetBorder ()
	Returns a Border Represents the border of the object.

wxExcelRange	GetBottomRightCell ()
	Returns a Range Represents the cell that lies under the lower-right corner of the object.

bool	GetEnabled ()
	True if the object is enabled.

void	SetEnabled (bool enabled)
	True if the object is enabled.

double	GetHeight ()
	Returns a Double value that represents the height, in points, of the object.

void	SetHeight (double height)
	Sets a Double value that represents the height, in points, of the object.

long	GetIndex ()
	Returns a Long value that represents the index number of the object within the collection of similar objects.

wxExcelInterior	GetInterior ()
	Returns an Interior Represents the interior of the specified object.

double	GetLeft ()
	Returns a Double value that represents the distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

void	SetLeft (double left)
	Sets a Double value that represents the distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

wxString	GetLinkedCell ()
	Returns the worksheet range linked to the control's value.

void	SetLinkedCell (const wxString &linkedCell)
	Sets the worksheet range linked to the control's value.

wxString	GetListFillRange ()
	Returns the worksheet range used to fill the specified list box.

void	SetListFillRange (const wxString &listFillRange)
	Sets the worksheet range used to fill the specified list box.

bool	GetLocked ()
	Returns a Boolean value that indicates if the object is locked.

void	SetLocked (bool locked)
	Sets a Boolean value that indicates if the object is locked.

wxString	GetName ()
	Returns a String value representing the name of the object.

void	SetName (const wxString &name)
	Sets a String value representing the name of the object.

XlOLEType	GetOLEType ()
	Returns the OLE object type.

XlPlacement	GetPlacement ()
	Returns a Variant value, containing an XlPlacement constant, that represents the way the object is attached to the cells below it.

void	SetPlacement (XlPlacement placement)
	Sets a Variant value, containing an XlPlacement constant, that represents the way the object is attached to the cells below it.

bool	GetPrintObject ()
	True if the object will be printed when the document is printed.

void	SetPrintObject (bool printObject)
	True if the object will be printed when the document is printed.

wxString	GetprogID ()
	Returns the programmatic identifiers for the object.

bool	GetShadow ()
	Returns a Boolean value that determines if the object has a shadow.

void	SetShadow (bool shadow)
	Sets a Boolean value that determines if the object has a shadow.

wxExcelShapeRange	GetShapeRange ()
	Returns a ShapeRange Represents the specified object or objects.

wxString	GetSourceName ()
	Returns a String value that represents the specified object's link source name.

void	SetSourceName (const wxString &sourceName)
	Sets a String value that represents the specified object's link source name.

double	GetTop ()
	Returns a Double value that represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

void	SetTop (double top)
	Sets a Double value that represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

wxExcelRange	GetTopLeftCell ()
	Returns a Range Represents the cell that lies under the upper-left corner of the specified object.

bool	GetVisible ()
	Returns a Boolean value that determines whether the object is visible.

void	SetVisible (bool visible)
	Sets a Boolean value that determines whether the object is visible.

double	GetWidth ()
	Returns a Double value that represents the width, in points, of the object.

void	SetWidth (double width)
	Sets a Double value that represents the width, in points, of the object.

long	GetZOrder ()
	Returns the z-order position of the object.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "OLEObject".

Public Member Functions inherited from wxAutoExcel::wxExcelObject
bool	IsOk_ () const
	Returns true if the object has a valid dispatch.

wxString	GetAutomationObjectName_ (bool stripUnderscores=false) const
	Returns object name as provided by IDispatch->GetTypeInfo()->GetDocumentation(MEMBERID_NIL, &name, NULL, NULL, NULL).

wxSharedPtr< wxAutomationObject >	GetAutomationObject_ ()
	Returns the underlying wxAutomationObject.

	operator bool () const
	Returns true if the object has a valid dispatch and its last automation call (if any), i.e.

WXLCID	GetAutomationLCID_ () const
	Returns the locale identifier used in automation calls.

bool	SetAutomationLCID_ (WXLCID lcid)
	Sets the locale identifier to be used in automation calls.

bool	GetPropertyAndMethodNames_ (wxArrayString &propertyNames, wxArrayString &methodNames, bool includeHidden=false)
	Returns lists of property and method names the automation interface exposes.

bool	GetUnimplementedObject_ (const wxString &name, wxAutomationObject &object)
	Helper function for receiving an automation object not implemented in wxAutoExcel, see FAQ on how to use.

Additional Inherited Members
Public Types inherited from wxAutoExcel::wxExcelObject
enum	ErrorFlags { Err_DoNothing = 0 , Err_LogOnInvalidDispatch = 1 , Err_AssertOnInvalidDispatch = 1 << 1 , Err_ThrowOnInvalidDispatch = 1 << 2 , Err_LogOnInvalidArgument = 1 << 3 , Err_AssertOnInvalidArgument = 1 << 4 , Err_ThrowOnInvalidArgument = 1 << 5 , Err_LogOnFailedInvoke = 1 << 6 , Err_AssertOnFailedInvoke = 1 << 7 , Err_ThrowOnFailedInvoke = 1 << 8 , Err_LogOnInvalidReturnType = 1 << 9 , Err_AssertOnInvalidReturnType = 1 << 10 , Err_ThrowOnInvalidReturnType = 1 << 11 , Err_LogOnOtherError = 1 << 12 , Err_AssertOnOtherError = 1 << 13 , Err_ThrowOnOtherError = 1 << 14 }
	Flags affecting the behaviour of wxExcelObject and its descendants when an error occurs during accessing an Excel object property or calling its method. More...

Static Public Member Functions inherited from wxAutoExcel::wxExcelObject
static unsigned	GetErrorMode_ ()
	Sets the error mode to the combination of wxExcelObject::ErrorFlags.

static void	SetErrorMode_ (unsigned mode)
	Sets the error mode as the combination of wxExcelObject::ErrorFlags.

static bool	GetUnimplementedCollectionItem_ (wxAutomationObject &collection, const long index, wxAutomationObject &item, bool asProperty)
	Helper function for obtaining an item from MS Excel collection not implemented in wxAutoExcel, see FAQ on how to use.

Detailed Description

Represents Microsoft Excel OLEObject object.

Member Function Documentation

◆ Activate()

bool wxAutoExcel::wxExcelOLEObject::Activate ( )

Activates the object.

MSDN documentation for OLEObject.Activate.

◆ BringToFront()

bool wxAutoExcel::wxExcelOLEObject::BringToFront ( )

Brings the object to the front of the z-order.

MSDN documentation for OLEObject.BringToFront.

◆ Copy()

bool wxAutoExcel::wxExcelOLEObject::Copy ( )

Copies the object to the Clipboard.

MSDN documentation for OLEObject.Copy.

◆ CopyPicture()

bool wxAutoExcel::wxExcelOLEObject::CopyPicture	(	XlPictureAppearance *	appearance,
		XlCopyPictureFormat *	format
	)

Copies the selected object to the Clipboard as a picture.

Variant.

MSDN documentation for OLEObject.CopyPicture.

◆ Cut()

bool wxAutoExcel::wxExcelOLEObject::Cut ( )

Cuts the object to the Clipboard or pastes it into a specified destination.

MSDN documentation for OLEObject.Cut.

◆ Delete()

bool wxAutoExcel::wxExcelOLEObject::Delete ( )

Deletes the object.

MSDN documentation for OLEObject.Delete.

◆ Duplicate()

wxExcelObject wxAutoExcel::wxExcelOLEObject::Duplicate ( )

Duplicates the object and returns a reference to the new copy.

MSDN documentation for OLEObject.Duplicate.

◆ Select()

bool wxAutoExcel::wxExcelOLEObject::Select ( wxXlTribool replace = wxDefaultXlTribool )

Selects the object.

MSDN documentation for OLEObject.Select.

◆ SendToBack()

bool wxAutoExcel::wxExcelOLEObject::SendToBack ( )

Sends the object to the back of the z-order.

MSDN documentation for OLEObject.SendToBack.

◆ Update()

bool wxAutoExcel::wxExcelOLEObject::Update ( )

Updates the link.

MSDN documentation for OLEObject.Update.

◆ Verb()

bool wxAutoExcel::wxExcelOLEObject::Verb ( XlOLEVerb * verb = NULL )

Sends a verb to the server of the specified OLE object.

MSDN documentation for OLEObject.Verb.

◆ GetAutoLoad()

bool wxAutoExcel::wxExcelOLEObject::GetAutoLoad ( )

True if the OLE object is automatically loaded when the workbook that contains it is opened.

MSDN documentation for OLEObject.AutoLoad.

◆ SetAutoLoad()

void wxAutoExcel::wxExcelOLEObject::SetAutoLoad ( bool autoLoad )

True if the OLE object is automatically loaded when the workbook that contains it is opened.

MSDN documentation for OLEObject.AutoLoad.

◆ GetAutoUpdate()

bool wxAutoExcel::wxExcelOLEObject::GetAutoUpdate ( )

True if the OLE object is updated automatically when the source changes.

Valid only if the object is linked (its OLEType property must be xlOLELink).

MSDN documentation for OLEObject.AutoUpdate.

◆ GetBorder()

wxExcelBorder wxAutoExcel::wxExcelOLEObject::GetBorder ( )

Returns a Border Represents the border of the object.

MSDN documentation for OLEObject.Border.

◆ GetBottomRightCell()

wxExcelRange wxAutoExcel::wxExcelOLEObject::GetBottomRightCell ( )

Returns a Range Represents the cell that lies under the lower-right corner of the object.

MSDN documentation for OLEObject.BottomRightCell.

◆ GetEnabled()

bool wxAutoExcel::wxExcelOLEObject::GetEnabled ( )

True if the object is enabled.

MSDN documentation for OLEObject.Enabled.

◆ SetEnabled()

void wxAutoExcel::wxExcelOLEObject::SetEnabled ( bool enabled )

True if the object is enabled.

MSDN documentation for OLEObject.Enabled.

◆ GetHeight()

double wxAutoExcel::wxExcelOLEObject::GetHeight ( )

Returns a Double value that represents the height, in points, of the object.

MSDN documentation for OLEObject.Height.

◆ SetHeight()

void wxAutoExcel::wxExcelOLEObject::SetHeight ( double height )

Sets a Double value that represents the height, in points, of the object.

MSDN documentation for OLEObject.Height.

◆ GetIndex()

long wxAutoExcel::wxExcelOLEObject::GetIndex ( )

Returns a Long value that represents the index number of the object within the collection of similar objects.

MSDN documentation for OLEObject.Index.

◆ GetInterior()

wxExcelInterior wxAutoExcel::wxExcelOLEObject::GetInterior ( )

Returns an Interior Represents the interior of the specified object.

MSDN documentation for OLEObject.Interior.

◆ GetLeft()

double wxAutoExcel::wxExcelOLEObject::GetLeft ( )

Returns a Double value that represents the distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

MSDN documentation for OLEObject.Left.

◆ SetLeft()

void wxAutoExcel::wxExcelOLEObject::SetLeft ( double left )

Sets a Double value that represents the distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

MSDN documentation for OLEObject.Left.

◆ GetLinkedCell()

wxString wxAutoExcel::wxExcelOLEObject::GetLinkedCell ( )

Returns the worksheet range linked to the control's value.

If you place a value in the cell, the control takes this value. Likewise, if you change the value of the control, that value is also placed in the cell.

MSDN documentation for OLEObject.LinkedCell.

◆ SetLinkedCell()

void wxAutoExcel::wxExcelOLEObject::SetLinkedCell ( const wxString & linkedCell )

Sets the worksheet range linked to the control's value.

If you place a value in the cell, the control takes this value. Likewise, if you change the value of the control, that value is also placed in the cell.

MSDN documentation for OLEObject.LinkedCell.

◆ GetListFillRange()

wxString wxAutoExcel::wxExcelOLEObject::GetListFillRange ( )

Returns the worksheet range used to fill the specified list box.

Setting this property destroys any existing list in the list box.

MSDN documentation for OLEObject.ListFillRange.

◆ SetListFillRange()

void wxAutoExcel::wxExcelOLEObject::SetListFillRange ( const wxString & listFillRange )

Sets the worksheet range used to fill the specified list box.

Setting this property destroys any existing list in the list box.

MSDN documentation for OLEObject.ListFillRange.

◆ GetLocked()

bool wxAutoExcel::wxExcelOLEObject::GetLocked ( )

Returns a Boolean value that indicates if the object is locked.

MSDN documentation for OLEObject.Locked.

◆ SetLocked()

void wxAutoExcel::wxExcelOLEObject::SetLocked ( bool locked )

Sets a Boolean value that indicates if the object is locked.

MSDN documentation for OLEObject.Locked.

◆ GetName()

wxString wxAutoExcel::wxExcelOLEObject::GetName ( )

Returns a String value representing the name of the object.

MSDN documentation for OLEObject.Name.

◆ SetName()

void wxAutoExcel::wxExcelOLEObject::SetName ( const wxString & name )

Sets a String value representing the name of the object.

MSDN documentation for OLEObject.Name.

◆ GetOLEType()

XlOLEType wxAutoExcel::wxExcelOLEObject::GetOLEType ( )

Returns the OLE object type.

Can be one of the following XlOLEType constants: xlOLELink or xlOLEEmbed. Returns xlOLELink if the object is linked (it exists outside of the file), or returns xlOLEEmbed if the object is embedded (it's entirely contained within the file).

MSDN documentation for OLEObject.OLEType.

◆ GetPlacement()

XlPlacement wxAutoExcel::wxExcelOLEObject::GetPlacement ( )

Returns a Variant value, containing an XlPlacement constant, that represents the way the object is attached to the cells below it.

MSDN documentation for OLEObject.Placement.

◆ SetPlacement()

void wxAutoExcel::wxExcelOLEObject::SetPlacement ( XlPlacement placement )

Sets a Variant value, containing an XlPlacement constant, that represents the way the object is attached to the cells below it.

MSDN documentation for OLEObject.Placement.

◆ GetPrintObject()

bool wxAutoExcel::wxExcelOLEObject::GetPrintObject ( )

True if the object will be printed when the document is printed.

MSDN documentation for OLEObject.PrintObject.

◆ SetPrintObject()

void wxAutoExcel::wxExcelOLEObject::SetPrintObject ( bool printObject )

True if the object will be printed when the document is printed.

MSDN documentation for OLEObject.PrintObject.

◆ GetprogID()

wxString wxAutoExcel::wxExcelOLEObject::GetprogID ( )

Returns the programmatic identifiers for the object.

MSDN documentation for OLEObject.progID.

◆ GetShadow()

bool wxAutoExcel::wxExcelOLEObject::GetShadow ( )

Returns a Boolean value that determines if the object has a shadow.

MSDN documentation for OLEObject.Shadow.

◆ SetShadow()

void wxAutoExcel::wxExcelOLEObject::SetShadow ( bool shadow )

Sets a Boolean value that determines if the object has a shadow.

MSDN documentation for OLEObject.Shadow.

◆ GetShapeRange()

wxExcelShapeRange wxAutoExcel::wxExcelOLEObject::GetShapeRange ( )

Returns a ShapeRange Represents the specified object or objects.

MSDN documentation for OLEObject.ShapeRange.

◆ GetSourceName()

wxString wxAutoExcel::wxExcelOLEObject::GetSourceName ( )

Returns a String value that represents the specified object's link source name.

MSDN documentation for OLEObject.SourceName.

◆ SetSourceName()

void wxAutoExcel::wxExcelOLEObject::SetSourceName ( const wxString & sourceName )

Sets a String value that represents the specified object's link source name.

MSDN documentation for OLEObject.SourceName.

◆ GetTop()

double wxAutoExcel::wxExcelOLEObject::GetTop ( )

Returns a Double value that represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

MSDN documentation for OLEObject.Top.

◆ SetTop()

void wxAutoExcel::wxExcelOLEObject::SetTop ( double top )

Sets a Double value that represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

MSDN documentation for OLEObject.Top.

◆ GetTopLeftCell()

wxExcelRange wxAutoExcel::wxExcelOLEObject::GetTopLeftCell ( )

Returns a Range Represents the cell that lies under the upper-left corner of the specified object.

MSDN documentation for OLEObject.TopLeftCell.

◆ GetVisible()

bool wxAutoExcel::wxExcelOLEObject::GetVisible ( )

Returns a Boolean value that determines whether the object is visible.

MSDN documentation for OLEObject.Visible.

◆ SetVisible()

void wxAutoExcel::wxExcelOLEObject::SetVisible ( bool visible )

Sets a Boolean value that determines whether the object is visible.