Represents a member of Microsoft Excel Sheets collection. More...

#include <wxAutoExcelSheet.h>

Inheritance diagram for wxAutoExcel::wxExcelSheet:

Public Member Functions
wxString	GetName ()
	Returns the name of the object.

XlSheetType	GetType ()
	Returns the sheet type.

bool	IsWorksheet ()
	Returns true if the sheet is a worksheet.

bool	IsChart ()
	Returns true if the sheet is a chart.

bool	Copy ()
	Copies the sheet to the new workbook.

bool	CopyAfterOrBefore (wxExcelSheet sheetAfterOrBefore, bool after)
	Copies the sheet within the same workbook, after or before the specified sheet.

bool	Move ()
	Moves the sheet to the new workbook.

bool	MoveAfterOrBefore (wxExcelSheet sheetAfterOrBefore, bool after)
	Moves the sheet within the same workbook, after or before the specified sheet.

bool	Delete ()
	Deletes the sheet.

wxExcelWorksheet	ToWorksheet ()
	If possible, returns the sheet as a worksheet (the sheet object is still preserved)

wxExcelChart	ToChart ()
	If possible, returns the sheet as a chart (the sheet object is still preserved)

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Sheet".

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 a member of Microsoft Excel Sheets collection.

Member Function Documentation

◆ GetName()

wxString wxAutoExcel::wxExcelSheet::GetName ( )

Returns the name of the object.

◆ GetType()

XlSheetType wxAutoExcel::wxExcelSheet::GetType ( )

Returns the sheet type.

May return wrong value for Charts, see e.g. here http://www.pcreview.co.uk/forums/xlchart-returning-wrong-value-t3579141.html

◆ IsWorksheet()

bool wxAutoExcel::wxExcelSheet::IsWorksheet ( )

Returns true if the sheet is a worksheet.

◆ IsChart()

bool wxAutoExcel::wxExcelSheet::IsChart ( )

Returns true if the sheet is a chart.

◆ Copy()

bool wxAutoExcel::wxExcelSheet::Copy ( )

Copies the sheet to the new workbook.

◆ CopyAfterOrBefore()

bool wxAutoExcel::wxExcelSheet::CopyAfterOrBefore	(	wxExcelSheet	sheetAfterOrBefore,
		bool	after
	)

Copies the sheet within the same workbook, after or before the specified sheet.

◆ Move()

bool wxAutoExcel::wxExcelSheet::Move ( )

Moves the sheet to the new workbook.

◆ MoveAfterOrBefore()

bool wxAutoExcel::wxExcelSheet::MoveAfterOrBefore	(	wxExcelSheet	sheetAfterOrBefore,
		bool	after
	)

Moves the sheet within the same workbook, after or before the specified sheet.

◆ Delete()

bool wxAutoExcel::wxExcelSheet::Delete ( )

Deletes the sheet.

◆ ToWorksheet()

wxExcelWorksheet wxAutoExcel::wxExcelSheet::ToWorksheet ( )

If possible, returns the sheet as a worksheet (the sheet object is still preserved)

◆ ToChart()

wxExcelChart wxAutoExcel::wxExcelSheet::ToChart ( )

If possible, returns the sheet as a chart (the sheet object is still preserved)

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "Sheet".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members