Represents Microsoft Excel ChartObject object. More...

Inheritance diagram for wxAutoExcel::wxExcelChartObject:

Public Member Functions
bool	Activate ()
	Makes the current chart the active chart. More...

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

bool	Copy ()
	Copies the object to the Clipboard. More...

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

bool	Cut ()
	Cuts the object to the Clipboard. More...

bool	Delete ()
	Deletes the object. More...

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

bool	Select (wxXlTribool replace)
	Selects the object. More...

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

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

wxExcelChart	GetChart ()
	Returns a Chart object that represents the chart contained in the object. More...

bool	GetEnabled ()
	True if the object is enabled. More...

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

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

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

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

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). More...

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). More...

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

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

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

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

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. More...

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

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

bool	GetProtectChartObject ()
	True if the embedded chart frame cannot be moved, resized, or deleted through the user interface. More...

void	SetProtectChartObject (bool protectChartObject)
	True if the embedded chart frame cannot be moved, resized, or deleted through the user interface. More...

bool	GetRoundedCorners ()
	True if the embedded chart has rounded corners. More...

void	SetRoundedCorners (bool roundedCorners)
	True if the embedded chart has rounded corners. More...

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

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

wxExcelShapeRange	GetShapeRange ()
	Returns a ShapeRange object that represents the specified object or objects. More...

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). More...

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). More...

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

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

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

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

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

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

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "ChartObject". More...

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

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

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

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

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

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

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

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

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. More...

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

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. More...

Detailed Description

Represents Microsoft Excel ChartObject object.

Member Function Documentation

◆ Activate()

bool wxAutoExcel::wxExcelChartObject::Activate ( )

Makes the current chart the active chart.

MSDN documentation for ChartObject.Activate.

◆ BringToFront()

bool wxAutoExcel::wxExcelChartObject::BringToFront ( )

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

MSDN documentation for ChartObject.BringToFront.

◆ Copy()

bool wxAutoExcel::wxExcelChartObject::Copy ( )

Copies the object to the Clipboard.

MSDN documentation for ChartObject.Copy.

◆ CopyPicture()

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

Copies the selected object to the Clipboard as a picture.

MSDN documentation for ChartObject.CopyPicture.

◆ Cut()

bool wxAutoExcel::wxExcelChartObject::Cut ( )

Cuts the object to the Clipboard.

MSDN documentation for ChartObject.Cut.

◆ Delete()

bool wxAutoExcel::wxExcelChartObject::Delete ( )

Deletes the object.

MSDN documentation for ChartObject.Delete.

◆ Duplicate()

wxExcelObject wxAutoExcel::wxExcelChartObject::Duplicate ( )

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

MSDN documentation for ChartObject.Duplicate.

◆ Select()

bool wxAutoExcel::wxExcelChartObject::Select ( wxXlTribool replace )

Selects the object.

MSDN documentation for ChartObject.Select.

◆ SendToBack()

bool wxAutoExcel::wxExcelChartObject::SendToBack ( )

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

MSDN documentation for ChartObject.SendToBack.

◆ GetBottomRightCell()

wxExcelRange wxAutoExcel::wxExcelChartObject::GetBottomRightCell ( )

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

MSDN documentation for ChartObject.BottomRightCell.

◆ GetChart()

wxExcelChart wxAutoExcel::wxExcelChartObject::GetChart ( )

Returns a Chart object that represents the chart contained in the object.

MSDN documentation for ChartObject.Chart.

◆ GetEnabled()

bool wxAutoExcel::wxExcelChartObject::GetEnabled ( )

True if the object is enabled.

MSDN documentation for ChartObject.Enabled.

◆ SetEnabled()

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

True if the object is enabled.

MSDN documentation for ChartObject.Enabled.

◆ GetHeight()

double wxAutoExcel::wxExcelChartObject::GetHeight ( )

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

MSDN documentation for ChartObject.Height.

◆ SetHeight()

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

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

MSDN documentation for ChartObject.Height.

◆ GetIndex()

long wxAutoExcel::wxExcelChartObject::GetIndex ( )

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

MSDN documentation for ChartObject.Index.

◆ GetLeft()

double wxAutoExcel::wxExcelChartObject::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 ChartObject.Left.

◆ SetLeft()

void wxAutoExcel::wxExcelChartObject::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 ChartObject.Left.

◆ GetLocked()

bool wxAutoExcel::wxExcelChartObject::GetLocked ( )

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

MSDN documentation for ChartObject.Locked.

◆ SetLocked()

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

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

MSDN documentation for ChartObject.Locked.

◆ GetName()

wxString wxAutoExcel::wxExcelChartObject::GetName ( )

Returns a String value representing the name of the object.

MSDN documentation for ChartObject.Name.

◆ GetPlacement()

XlPlacement wxAutoExcel::wxExcelChartObject::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 ChartObject.Placement.

◆ SetPlacement()

void wxAutoExcel::wxExcelChartObject::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 ChartObject.Placement.

◆ GetPrintObject()

bool wxAutoExcel::wxExcelChartObject::GetPrintObject ( )

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

MSDN documentation for ChartObject.PrintObject.

◆ SetPrintObject()

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

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

MSDN documentation for ChartObject.PrintObject.

◆ GetProtectChartObject()

bool wxAutoExcel::wxExcelChartObject::GetProtectChartObject ( )

True if the embedded chart frame cannot be moved, resized, or deleted through the user interface.

MSDN documentation for ChartObject.ProtectChartObject.

◆ SetProtectChartObject()

void wxAutoExcel::wxExcelChartObject::SetProtectChartObject ( bool protectChartObject )

True if the embedded chart frame cannot be moved, resized, or deleted through the user interface.

MSDN documentation for ChartObject.ProtectChartObject.

◆ GetRoundedCorners()

bool wxAutoExcel::wxExcelChartObject::GetRoundedCorners ( )

True if the embedded chart has rounded corners.

MSDN documentation for ChartObject.RoundedCorners.

◆ SetRoundedCorners()

void wxAutoExcel::wxExcelChartObject::SetRoundedCorners ( bool roundedCorners )

True if the embedded chart has rounded corners.

MSDN documentation for ChartObject.RoundedCorners.

◆ GetShadow()

bool wxAutoExcel::wxExcelChartObject::GetShadow ( )

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

MSDN documentation for ChartObject.Shadow.

◆ SetShadow()

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

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

MSDN documentation for ChartObject.Shadow.

◆ GetShapeRange()

wxExcelShapeRange wxAutoExcel::wxExcelChartObject::GetShapeRange ( )

Returns a ShapeRange object that represents the specified object or objects.

MSDN documentation for ChartObject.ShapeRange.

◆ GetTop()

double wxAutoExcel::wxExcelChartObject::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 ChartObject.Top.

◆ SetTop()

void wxAutoExcel::wxExcelChartObject::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 ChartObject.Top.

◆ GetTopLeftCell()

wxExcelRange wxAutoExcel::wxExcelChartObject::GetTopLeftCell ( )

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

MSDN documentation for ChartObject.TopLeftCell.

◆ GetVisible()

bool wxAutoExcel::wxExcelChartObject::GetVisible ( )

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

MSDN documentation for ChartObject.Visible.

◆ SetVisible()

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

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