Represents Microsoft Excel PlotArea object. More...

Inheritance diagram for wxAutoExcel::wxExcelPlotArea:

Public Member Functions
bool	ClearFormats ()
	Clears the formatting of the object. More...

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

wxExcelChartFormat	GetFormat ()
	Returns the ChartFormat object. 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...

double	GetInsideHeight ()
	Returns the inside height of the plot area, in points. More...

double	GetInsideLeft ()
	Returns the distance from the chart edge to the inside left edge of the plot area, in points. More...

double	GetInsideTop ()
	Returns the distance from the chart edge to the inside top edge of the plot area, in points. More...

double	GetInsideWidth ()
	Returns the inside width of the plot area, in points. 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...

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

XlChartElementPosition	GetPosition ()
	Returns the position of the plot area on the chart. More...

void	SetPosition (XlChartElementPosition position)
	Sets the position of the plot area on the chart. 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...

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

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "PlotArea". 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 PlotArea object.

Member Function Documentation

◆ ClearFormats()

bool wxAutoExcel::wxExcelPlotArea::ClearFormats ( )

Clears the formatting of the object.

MSDN documentation for PlotArea.ClearFormats.

◆ Select()

bool wxAutoExcel::wxExcelPlotArea::Select ( )

Selects the object.

MSDN documentation for PlotArea.Select.

◆ GetFormat()

wxExcelChartFormat wxAutoExcel::wxExcelPlotArea::GetFormat ( )

Returns the ChartFormat object.

Since Excel 2007.

MSDN documentation for PlotArea.Format.

◆ GetHeight()

double wxAutoExcel::wxExcelPlotArea::GetHeight ( )

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

MSDN documentation for PlotArea.Height.

◆ SetHeight()

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

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

MSDN documentation for PlotArea.Height.

◆ GetInsideHeight()

double wxAutoExcel::wxExcelPlotArea::GetInsideHeight ( )

Returns the inside height of the plot area, in points.

Read-only Double.

MSDN documentation for PlotArea.InsideHeight.

◆ GetInsideLeft()

double wxAutoExcel::wxExcelPlotArea::GetInsideLeft ( )

Returns the distance from the chart edge to the inside left edge of the plot area, in points.

Read-only Double.

MSDN documentation for PlotArea.InsideLeft.

◆ GetInsideTop()

double wxAutoExcel::wxExcelPlotArea::GetInsideTop ( )

Returns the distance from the chart edge to the inside top edge of the plot area, in points.

Read-only Double.

MSDN documentation for PlotArea.InsideTop.

◆ GetInsideWidth()

double wxAutoExcel::wxExcelPlotArea::GetInsideWidth ( )

Returns the inside width of the plot area, in points.

Read-only Double.

MSDN documentation for PlotArea.InsideWidth.

◆ GetLeft()

double wxAutoExcel::wxExcelPlotArea::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 PlotArea.Left.

◆ SetLeft()

void wxAutoExcel::wxExcelPlotArea::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 PlotArea.Left.

◆ GetName()

wxString wxAutoExcel::wxExcelPlotArea::GetName ( )

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

MSDN documentation for PlotArea.Name.

◆ GetPosition()

XlChartElementPosition wxAutoExcel::wxExcelPlotArea::GetPosition ( )

Returns the position of the plot area on the chart.

Since Excel 2007.

MSDN documentation for PlotArea.Position.

◆ SetPosition()

void wxAutoExcel::wxExcelPlotArea::SetPosition ( XlChartElementPosition position )

Sets the position of the plot area on the chart.

Since Excel 2007.

MSDN documentation for PlotArea.Position.

◆ GetTop()

double wxAutoExcel::wxExcelPlotArea::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 PlotArea.Top.

◆ SetTop()

void wxAutoExcel::wxExcelPlotArea::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 PlotArea.Top.

◆ GetWidth()

double wxAutoExcel::wxExcelPlotArea::GetWidth ( )

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

MSDN documentation for PlotArea.Width.

◆ SetWidth()

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

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

MSDN documentation for PlotArea.Width.

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelPlotArea::GetAutoExcelObjectName_ ( ) const

inlinevirtual

Returns "PlotArea".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ClearFormats()

◆ Select()

◆ GetFormat()

◆ GetHeight()

◆ SetHeight()

◆ GetInsideHeight()

◆ GetInsideLeft()

◆ GetInsideTop()

◆ GetInsideWidth()

◆ GetLeft()

◆ SetLeft()

◆ GetName()

◆ GetPosition()

◆ SetPosition()

◆ GetTop()

◆ SetTop()

◆ GetWidth()

◆ SetWidth()

◆ GetAutoExcelObjectName_()