Represents Microsoft Excel Sort object. More...

#include <wxAutoExcelSort.h>

Inheritance diagram for wxAutoExcel::wxExcelSort:

Public Member Functions
void	Apply ()
	Sorts the range based on the currently applied sort states.

void	SetRange (wxExcelRange rng)
	Sets the starting and ending character positions for Sort object.

XlYesNoGuess	GetHeader ()
	Specifies whether the first row contains header information.

void	SetHeader (XlYesNoGuess header)
	Specifies whether the first row contains header information.

bool	GetMatchCase ()
	Set to True to perform a case-sensitive sort or set to False to perform non-case sensitive sort.

void	SetMatchCase (bool matchCase)
	Set to True to perform a case-sensitive sort or set to False to perform non-case sensitive sort.

XlSortOrientation	GetOrientation ()
	Specifies the orientation for the sort.

void	SetOrientation (XlSortOrientation orientation)
	Specifies the orientation for the sort.

wxExcelRange	GetRng ()
	Return the range of values on which the sort is performed.

wxExcelSortFields	GetSortFields ()
	Stores the sort state for workbooks, lists, and autofilters.

XlSortMethod	GetSortMethod ()
	Specifies the sort method for Chinese languages.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Sort".

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.