Represents Microsoft Excel Workbooks collection. More...

#include <wxAutoExcelWorkbooks.h>

Inheritance diagram for wxAutoExcel::wxExcelWorkbooks:

Public Member Functions
wxExcelWorkbook	Add (XlWBATemplate sheetType=xlWBATWorksheet)
	Creates a new workbook.

bool	CanCheckOut (const wxString &fileName)
	True if Microsoft Excel can check out a specified workbook from a server.

void	CheckOut (const wxString &fileName)
	Checks out a specified workbook from a server to a local computer for editing.

bool	Close ()
	Closes the workbook.

wxExcelWorkbook	Open (const wxString &fileName, long updateLinks=NULL, wxXlTribool readOnly=wxDefaultXlTribool, long format=NULL, const wxString &password=wxEmptyString, const wxString &writeResPassword=wxEmptyString, wxXlTribool ignoreReadOnlyRecommended=wxDefaultXlTribool, XlPlatform origin=NULL, wxXlTribool editable=wxDefaultXlTribool, wxXlTribool notify=wxDefaultXlTribool, long converter=NULL, wxXlTribool addToMru=wxDefaultXlTribool, wxXlTribool local=wxDefaultXlTribool, XlCorruptLoad *corruptLoad=NULL)
	Opens a workbook.

wxExcelWorkbook	OpenDatabase (const wxString &fileName, const wxString &commandText=wxEmptyString, XlCmdType commandType=xlCmdDefault, bool backgroundQuery=false, XlImportDataAs importDataAs=xlQueryTable)
	Returns a workbook representing a database.

long	GetCount ()
	Returns the number of workbooks in the collection.

wxExcelWorkbook	GetItem (long index)
	Returns a workbook.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Workbooks".

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

Member Function Documentation

◆ Add()

wxExcelWorkbook wxAutoExcel::wxExcelWorkbooks::Add ( XlWBATemplate sheetType = xlWBATWorksheet )

Creates a new workbook.

The new workbook becomes the active workbook.

MSDN documentation for Workbooks.Add.

◆ CanCheckOut()

bool wxAutoExcel::wxExcelWorkbooks::CanCheckOut ( const wxString & fileName )

True if Microsoft Excel can check out a specified workbook from a server.

Read/write Boolean.

MSDN documentation for Workbooks.CanCheckOut.

◆ CheckOut()

void wxAutoExcel::wxExcelWorkbooks::CheckOut ( const wxString & fileName )

Checks out a specified workbook from a server to a local computer for editing.

MSDN documentation for Workbooks.CheckOut.

◆ Close()

bool wxAutoExcel::wxExcelWorkbooks::Close ( )

Closes the workbook.

MSDN documentation for Workbooks.Close.

◆ Open()

wxExcelWorkbook wxAutoExcel::wxExcelWorkbooks::Open	(	const wxString &	fileName,
		long *	updateLinks = `NULL`,
		wxXlTribool	readOnly = `wxDefaultXlTribool`,
		long *	format = `NULL`,
		const wxString &	password = `wxEmptyString`,
		const wxString &	writeResPassword = `wxEmptyString`,
		wxXlTribool	ignoreReadOnlyRecommended = `wxDefaultXlTribool`,
		XlPlatform *	origin = `NULL`,
		wxXlTribool	editable = `wxDefaultXlTribool`,
		wxXlTribool	notify = `wxDefaultXlTribool`,
		long *	converter = `NULL`,
		wxXlTribool	addToMru = `wxDefaultXlTribool`,
		wxXlTribool	local = `wxDefaultXlTribool`,
		XlCorruptLoad *	corruptLoad = `NULL`
	)

Opens a workbook.

MSDN documentation for Workbooks.Open.

◆ OpenDatabase()

wxExcelWorkbook wxAutoExcel::wxExcelWorkbooks::OpenDatabase	(	const wxString &	fileName,
		const wxString &	commandText = `wxEmptyString`,
		XlCmdType	commandType = `xlCmdDefault`,
		bool	backgroundQuery = `false`,
		XlImportDataAs	importDataAs = `xlQueryTable`
	)

Returns a workbook representing a database.

MSDN documentation for Workbooks.OpenDatabase.

◆ GetCount()

long wxAutoExcel::wxExcelWorkbooks::GetCount ( )

Returns the number of workbooks in the collection.

MSDN documentation for Workbooks.Count.

◆ GetItem()

wxExcelWorkbook wxAutoExcel::wxExcelWorkbooks::GetItem ( long index )

Returns a workbook.

MSDN documentation for Workbooks.Item.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "Workbooks".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members