Represents Microsoft Excel SortFields object. More...

#include <wxAutoExcelSortFields.h>

Inheritance diagram for wxAutoExcel::wxExcelSortField:

Public Member Functions
void	Delete ()
	Removes the specified SortField object from the SortFields collection.

void	ModifyKey (wxExcelRange range)
	Modify the key value by which values are sorted in the field.

void	SetIcon (wxExcelIcon icon)
	Sets an icon for a SortField object.

wxString	GetCustomOrder ()
	Specifies a custom order to sort the fields.

void	SetCustomOrder (const wxString &customOrder)
	Specifies a custom order to sort the fields.

XlSortDataOption	GetDataOption ()
	Specifies how to sort text in the range specified in SortField object.

void	SetDataOption (XlSortDataOption dataOption)
	Specifies how to sort text in the range specified in SortField object.

wxExcelRange	GetKey ()
	Specifies the range that is currently being sorted on.

XlSortOrder	GetOrder ()
	Determines the sort order for the values specified in the key.

void	SetOrder (XlSortOrder order)
	Determines the sort order for the values specified in the key.

long	GetPriority ()
	Specifies the priority for the sort field.

void	SetPriority (long priority)
	Specifies the priority for the sort field.

XlSortOn	GetSortOn ()
	Returns what attribute of the cell to sort on .

void	SetSortOn (XlSortOn sortOn)
	Sets what attribute of the cell to sort on .

wxExcelObject	GetSortOnValue ()
	Retun the value on which the sort is performed for the specified SortField object.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "SortField".

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 SortFields object.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelSortField::Delete ( )

Removes the specified SortField object from the SortFields collection.

MSDN documentation for SortField.Delete.

◆ ModifyKey()

void wxAutoExcel::wxExcelSortField::ModifyKey ( wxExcelRange range )

Modify the key value by which values are sorted in the field.

MSDN documentation for SortField.ModifyKey.

◆ SetIcon()

void wxAutoExcel::wxExcelSortField::SetIcon ( wxExcelIcon icon )

Sets an icon for a SortField object.

MSDN documentation for SortField.SetIcon.

◆ GetCustomOrder()

wxString wxAutoExcel::wxExcelSortField::GetCustomOrder ( )

Specifies a custom order to sort the fields.

Read/write Variant. Since Excel 2007.

MSDN documentation for SortField.CustomOrder.

◆ SetCustomOrder()

void wxAutoExcel::wxExcelSortField::SetCustomOrder ( const wxString & customOrder )

Specifies a custom order to sort the fields.

Read/write Variant. Since Excel 2007.

MSDN documentation for SortField.CustomOrder.

◆ GetDataOption()

XlSortDataOption wxAutoExcel::wxExcelSortField::GetDataOption ( )

Specifies how to sort text in the range specified in SortField object.

Read/write XlSortDataOption. Since Excel 2007.

MSDN documentation for SortField.DataOption.

◆ SetDataOption()

void wxAutoExcel::wxExcelSortField::SetDataOption ( XlSortDataOption dataOption )

Specifies how to sort text in the range specified in SortField object.

Read/write XlSortDataOption. Since Excel 2007.

MSDN documentation for SortField.DataOption.

◆ GetKey()

wxExcelRange wxAutoExcel::wxExcelSortField::GetKey ( )

Specifies the range that is currently being sorted on.

Since Excel 2007.

MSDN documentation for SortField.Key.

◆ GetOrder()

XlSortOrder wxAutoExcel::wxExcelSortField::GetOrder ( )

Determines the sort order for the values specified in the key.

Since Excel 2007.

MSDN documentation for SortField.Order.

◆ SetOrder()

void wxAutoExcel::wxExcelSortField::SetOrder ( XlSortOrder order )

Determines the sort order for the values specified in the key.

Since Excel 2007.

MSDN documentation for SortField.Order.

◆ GetPriority()

long wxAutoExcel::wxExcelSortField::GetPriority ( )

Specifies the priority for the sort field.

Since Excel 2007.

MSDN documentation for SortField.Priority.

◆ SetPriority()

void wxAutoExcel::wxExcelSortField::SetPriority ( long priority )

Specifies the priority for the sort field.

Since Excel 2007.

MSDN documentation for SortField.Priority.

◆ GetSortOn()

XlSortOn wxAutoExcel::wxExcelSortField::GetSortOn ( )

Returns what attribute of the cell to sort on .

Read/write XlSortOn. Since Excel 2007.

MSDN documentation for SortField.SortOn.

◆ SetSortOn()

void wxAutoExcel::wxExcelSortField::SetSortOn ( XlSortOn sortOn )

Sets what attribute of the cell to sort on .

Read/write XlSortOn. Since Excel 2007.

MSDN documentation for SortField.SortOn.

◆ GetSortOnValue()

wxExcelObject wxAutoExcel::wxExcelSortField::GetSortOnValue ( )

Retun the value on which the sort is performed for the specified SortField object.

Since Excel 2007.

MSDN documentation for SortField.SortOnValue.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "SortField".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Delete()

◆ ModifyKey()

◆ SetIcon()

◆ GetCustomOrder()

◆ SetCustomOrder()

◆ GetDataOption()

◆ SetDataOption()

◆ GetKey()

◆ GetOrder()

◆ SetOrder()

◆ GetPriority()

◆ SetPriority()

◆ GetSortOn()

◆ SetSortOn()

◆ GetSortOnValue()

◆ GetAutoExcelObjectName_()