wxAutoExcel::wxExcelRangeOwner Class Reference

Helper object that contains methods common to objects that can return Ranges. More...

#include <wxAutoExcelRangeOwner.h>

Inheritance diagram for wxAutoExcel::wxExcelRangeOwner:

Public Member Functions
wxExcelRange	GetCells (long *row=NULL, long *column=NULL)
	wxExcelApplication: Returns a Range representing all the cells on the active worksheet.
wxExcelRange	GetRange (const wxString &cell1, const wxString &cell2=wxEmptyString)
	wxExcelWorksheet: Returns a Range representing a cell or a range of cells.
wxExcelRange	GetRows ()
	wxExcelWorksheet: Returns a Range representing all the rows on the specified worksheet.
wxExcelRange	GetRows (long rowIndex)
	wxExcelRange: Returns a Range containing just one row with rowIndex (starting with 1).
wxExcelRange	GetRows (const wxString &rowRange)
	wxExcelWorksheet: Returns a Range that can contain several contiguous rows.
wxExcelRange	GetColumns ()
	wxExcelWorksheet: Returns a Range representing all the columns on the active worksheet.
wxExcelRange	GetColumns (long columnIndex)
	wxExcelRange: Returns a Range containing just one column with columnIndex (starting with 1).
wxExcelRange	GetColumns (const wxString &columnRange)
	wxExcelWorksheet: Returns a Range that can contain several contiguous columns.
virtual wxString	GetAutoExcelObjectName_ () const
	Returns "RangeOwner (internal object)".
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

Helper object that contains methods common to objects that can return Ranges.

Member Function Documentation

GetCells()

wxExcelRange wxAutoExcel::wxExcelRangeOwner::GetCells	(	long *	row = NULL,
		long *	column = NULL
	)

wxExcelApplication: Returns a Range representing all the cells on the active worksheet.

If the active document isn't a worksheet, this property fails. MSDN documentation for Application.Cells.

wxExcelWorksheet: Returns a Range representing all the cells on the worksheet (not just the cells that are currently in use. MSDN documentation for Worksheet.Cells.

wxExcelRange: Returns a Range representing the cells in the specified range. MSDN documentation for Range.Cells.

GetRange()

wxExcelRange wxAutoExcel::wxExcelRangeOwner::GetRange	(	const wxString &	cell1,
		const wxString &	cell2 = wxEmptyString
	)

wxExcelWorksheet: Returns a Range representing a cell or a range of cells.

MSDN documentation for Worksheet.Range.

wxExcelRange: Returns a Range representing a cell or a range of cells. MSDN documentation for Range.Range.

GetRows() [1/3]

wxExcelRange wxAutoExcel::wxExcelRangeOwner::GetRows

(

)

wxExcelWorksheet: Returns a Range representing all the rows on the specified worksheet.

Read-only Range object. MSDN documentation for Worksheet.Rows.

wxExcelRange: Returns a Range representing all the rows in the specified range. Read-only Range object. MSDN documentation for Range.Rows.

GetRows() [2/3]

wxExcelRange wxAutoExcel::wxExcelRangeOwner::GetRows

(

long

rowIndex

)

wxExcelRange: Returns a Range containing just one row with rowIndex (starting with 1).

MSDN documentation for Range.Rows.

GetRows() [3/3]

wxExcelRange wxAutoExcel::wxExcelRangeOwner::GetRows

(

const wxString &

rowRange

)

wxExcelWorksheet: Returns a Range that can contain several contiguous rows.

Pass the address in the format "firstRowIndex:lastRowIndex", e.g. "1:5" to get first five rows of the range.

MSDN documentation for Range.Rows.

GetColumns() [1/3]

wxExcelRange wxAutoExcel::wxExcelRangeOwner::GetColumns

(

)

wxExcelWorksheet: Returns a Range representing all the columns on the active worksheet.

If the active document isn't a worksheet, the Columns property fails. MSDN documentation for Worksheet.Columns.

wxExcelRange: Returns a Range representing the columns in the specified range. MSDN documentation for Range.Columns.

GetColumns() [2/3]

wxExcelRange wxAutoExcel::wxExcelRangeOwner::GetColumns

(

long

columnIndex

)

wxExcelRange: Returns a Range containing just one column with columnIndex (starting with 1).

MSDN documentation for Range.Rows.

GetColumns() [3/3]

wxExcelRange wxAutoExcel::wxExcelRangeOwner::GetColumns

(

const wxString &

columnRange

)

wxExcelWorksheet: Returns a Range that can contain several contiguous columns.

Pass the address in the format "firstColumnLetter:lastColumnLetter", e.g. "A:E" to get first five columns of the range.

MSDN documentation for Range.Rows.

GetAutoExcelObjectName_()

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

inlinevirtual

Returns "RangeOwner (internal object)".

Reimplemented from wxAutoExcel::wxExcelObject.

Reimplemented in wxAutoExcel::wxExcelApplication, wxAutoExcel::wxExcelRange, and wxAutoExcel::wxExcelWorksheet.