Represents Microsoft Excel ChartArea object. More...

#include <wxAutoExcelChartArea.h>

Inheritance diagram for wxAutoExcel::wxExcelChartArea:

Public Member Functions
bool	Clear ()
	Clears the entire object.

bool	ClearContents ()
	Clears the data from a chart but leaves the formatting.

bool	ClearFormats ()
	Clears the formatting of the object.

bool	Copy ()
	Copies the object to the Clipboard.

bool	Select ()
	Selects the object.

bool	GetAutoScaleFont ()
	True if the text in the object changes font size when the object size changes.

void	SetAutoScaleFont (bool autoScaleFont)
	True if the text in the object changes font size when the object size changes.

wxExcelChartFormat	GetFormat ()
	Returns the ChartFormat object Since Excel 2007.

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.

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	GetName ()
	Returns a String value that represents the name of the object.

bool	GetRoundedCorners ()
	True if the chart area of the chart has rounded corners.

void	SetRoundedCorners (bool roundedCorners)
	True if the chart area of the chart has rounded corners.

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.

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

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.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "ChartArea".

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 ChartArea object.

Member Function Documentation

◆ Clear()

bool wxAutoExcel::wxExcelChartArea::Clear ( )

Clears the entire object.

MSDN documentation for ChartArea.Clear.

◆ ClearContents()

bool wxAutoExcel::wxExcelChartArea::ClearContents ( )

Clears the data from a chart but leaves the formatting.

MSDN documentation for ChartArea.ClearContents.

◆ ClearFormats()

bool wxAutoExcel::wxExcelChartArea::ClearFormats ( )

Clears the formatting of the object.

MSDN documentation for ChartArea.ClearFormats.

◆ Copy()

bool wxAutoExcel::wxExcelChartArea::Copy ( )

Copies the object to the Clipboard.

MSDN documentation for ChartArea.Copy.

◆ Select()

bool wxAutoExcel::wxExcelChartArea::Select ( )

Selects the object.

MSDN documentation for ChartArea.Select.

◆ GetAutoScaleFont()

bool wxAutoExcel::wxExcelChartArea::GetAutoScaleFont ( )

True if the text in the object changes font size when the object size changes.

The default value is True. Read/write Variant.

MSDN documentation for ChartArea.AutoScaleFont.

◆ SetAutoScaleFont()

void wxAutoExcel::wxExcelChartArea::SetAutoScaleFont ( bool autoScaleFont )

True if the text in the object changes font size when the object size changes.

The default value is True. Read/write Variant.

MSDN documentation for ChartArea.AutoScaleFont.

◆ GetFormat()

wxExcelChartFormat wxAutoExcel::wxExcelChartArea::GetFormat ( )

Returns the ChartFormat object Since Excel 2007.

MSDN documentation for ChartArea.Format.

◆ GetHeight()

double wxAutoExcel::wxExcelChartArea::GetHeight ( )

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

MSDN documentation for ChartArea.Height.

◆ SetHeight()

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

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

MSDN documentation for ChartArea.Height.

◆ GetLeft()

double wxAutoExcel::wxExcelChartArea::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 ChartArea.Left.

◆ SetLeft()

void wxAutoExcel::wxExcelChartArea::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 ChartArea.Left.

◆ GetName()

wxString wxAutoExcel::wxExcelChartArea::GetName ( )

Returns a String value that represents the name of the object.

MSDN documentation for ChartArea.Name.

◆ GetRoundedCorners()

bool wxAutoExcel::wxExcelChartArea::GetRoundedCorners ( )

True if the chart area of the chart has rounded corners.

Since Excel 2010. MSDN documentation for ChartArea.RoundedCorners.

◆ SetRoundedCorners()

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

True if the chart area of the chart has rounded corners.

Since Excel 2010. MSDN documentation for ChartArea.RoundedCorners.

◆ GetShadow()

bool wxAutoExcel::wxExcelChartArea::GetShadow ( )

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

MSDN documentation for ChartArea.Shadow.

◆ SetShadow()

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

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

MSDN documentation for ChartArea.Shadow.

◆ GetTop()

double wxAutoExcel::wxExcelChartArea::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 ChartArea.Top.

◆ SetTop()

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

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 ChartArea.Top.

◆ GetWidth()

double wxAutoExcel::wxExcelChartArea::GetWidth ( )

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

MSDN documentation for ChartArea.Width.

◆ SetWidth()

void wxAutoExcel::wxExcelChartArea::SetWidth ( double width )

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