Represents Microsoft Excel SeriesCollection collection. More...

#include <wxAutoExcelSeriesCollection.h>

Inheritance diagram for wxAutoExcel::wxExcelSeriesCollection:

Public Member Functions
wxExcelSeries	Add (wxExcelRange source, XlRowCol *rowCol=NULL, wxXlTribool seriesLabels=wxDefaultXlTribool, wxXlTribool categoryLabels=wxDefaultXlTribool, wxXlTribool replace=wxDefaultXlTribool)
	Adds one or more new series to the SeriesCollection collection.

bool	Extend (wxExcelRange source, XlRowCol *rowCol=NULL, wxXlTribool categoryLabels=wxDefaultXlTribool)
	Adds new data points to an existing series collection.

wxExcelSeries	Item (long index)
	Returns a single object from a collection.

wxExcelSeries	NewSeries ()
	Creates a new series.

bool	Paste (XlRowCol *rowcol=NULL, wxXlTribool seriesLabels=wxDefaultXlTribool, wxXlTribool categoryLabels=wxDefaultXlTribool, wxXlTribool replace=wxDefaultXlTribool, wxXlTribool newSeries=wxDefaultXlTribool)
	Pastes data from the Clipboard into the specified series collection.

long	GetCount ()
	Returns a Long value that represents the number of objects in the collection.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "SeriesCollection".

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

Member Function Documentation

◆ Add()

wxExcelSeries wxAutoExcel::wxExcelSeriesCollection::Add	(	wxExcelRange	source,
		XlRowCol *	rowCol = `NULL`,
		wxXlTribool	seriesLabels = `wxDefaultXlTribool`,
		wxXlTribool	categoryLabels = `wxDefaultXlTribool`,
		wxXlTribool	replace = `wxDefaultXlTribool`
	)

Adds one or more new series to the SeriesCollection collection.

MSDN documentation for SeriesCollection.Add.

◆ Extend()

bool wxAutoExcel::wxExcelSeriesCollection::Extend	(	wxExcelRange	source,
		XlRowCol *	rowCol = `NULL`,
		wxXlTribool	categoryLabels = `wxDefaultXlTribool`
	)

Adds new data points to an existing series collection.

MSDN documentation for SeriesCollection.Extend.

◆ Item()

wxExcelSeries wxAutoExcel::wxExcelSeriesCollection::Item ( long index )

Returns a single object from a collection.

MSDN documentation for SeriesCollection.Item.

◆ NewSeries()

wxExcelSeries wxAutoExcel::wxExcelSeriesCollection::NewSeries ( )

Creates a new series.

Returns a Series object that represents the new series.

MSDN documentation for SeriesCollection.NewSeries.

◆ Paste()

bool wxAutoExcel::wxExcelSeriesCollection::Paste	(	XlRowCol *	rowcol = `NULL`,
		wxXlTribool	seriesLabels = `wxDefaultXlTribool`,
		wxXlTribool	categoryLabels = `wxDefaultXlTribool`,
		wxXlTribool	replace = `wxDefaultXlTribool`,
		wxXlTribool	newSeries = `wxDefaultXlTribool`
	)

Pastes data from the Clipboard into the specified series collection.

MSDN documentation for SeriesCollection.Paste.

◆ GetCount()

long wxAutoExcel::wxExcelSeriesCollection::GetCount ( )

Returns a Long value that represents the number of objects in the collection.

MSDN documentation for SeriesCollection.Count.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "SeriesCollection".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members