Represents a Microsoft Excel IconCriterion object. More...

#include <wxAutoExcelIconCriteria.h>

Inheritance diagram for wxAutoExcel::wxExcelIconCriterion:

Public Member Functions
wxExcelIcon	GetIcon ()
	The icon for a criterion in an icon set conditional formatting rule.

void	SetIcon (const wxExcelIcon &icon)
	The icon for a criterion in an icon set conditional formatting rule.

long	GetIndex ()
	Returns a Long value indicating which threshold the criteria represents.

XlFormatConditionOperator	GetOperator ()
	Returns one of the constants of the XlFormatConditionOperator enumeration which specifes if the threshold is "greater than" or "greater than or equal" to the threshold value.

void	SetOperator (XlFormatConditionOperator conditionOperator)
	Sets one of the constants of the XlFormatConditionOperator enumeration which specifes if the threshold is "greater than" or "greater than or equal" to the threshold value.

XlConditionValueTypes	GetType ()
	Returns one of the constants of the XlConditionValueTypes enumeration, which specifies how the threshold value for an icon set is determined.

wxVariant	GetValue ()
	Returns the threshold value for an icon in a conditional format.

void	SetValue (const wxVariant &value)
	Sets the threshold value for an icon in a conditional format.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "IconCriterion".

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 Microsoft Excel IconCriterion object.

Member Function Documentation

◆ GetIcon()

wxExcelIcon wxAutoExcel::wxExcelIconCriterion::GetIcon ( )

The icon for a criterion in an icon set conditional formatting rule.

. Since Excel 2010.

MSDN documentation for IconCriterion.Icon.

◆ SetIcon()

void wxAutoExcel::wxExcelIconCriterion::SetIcon ( const wxExcelIcon & icon )

The icon for a criterion in an icon set conditional formatting rule.

. Since Excel 2010.

MSDN documentation for IconCriterion.Icon.

◆ GetIndex()

long wxAutoExcel::wxExcelIconCriterion::GetIndex ( )

Returns a Long value indicating which threshold the criteria represents.

Since Excel 2007.

MSDN documentation for IconCriterion.Index.

◆ GetOperator()

XlFormatConditionOperator wxAutoExcel::wxExcelIconCriterion::GetOperator ( )

Returns one of the constants of the XlFormatConditionOperator enumeration which specifes if the threshold is "greater than" or "greater than or equal" to the threshold value.

Since Excel 2007.

MSDN documentation for IconCriterion.Operator.

◆ SetOperator()

void wxAutoExcel::wxExcelIconCriterion::SetOperator ( XlFormatConditionOperator conditionOperator )

Sets one of the constants of the XlFormatConditionOperator enumeration which specifes if the threshold is "greater than" or "greater than or equal" to the threshold value.

Since Excel 2007.

MSDN documentation for IconCriterion.Operator.

◆ GetType()

XlConditionValueTypes wxAutoExcel::wxExcelIconCriterion::GetType ( )

Returns one of the constants of the XlConditionValueTypes enumeration, which specifies how the threshold value for an icon set is determined.

Since Excel 2007.

MSDN documentation for IconCriterion.Type.

◆ GetValue()

wxVariant wxAutoExcel::wxExcelIconCriterion::GetValue ( )

Returns the threshold value for an icon in a conditional format.

Read/write Variant. Since Excel 2007.

MSDN documentation for IconCriterion.Value.

◆ SetValue()

void wxAutoExcel::wxExcelIconCriterion::SetValue ( const wxVariant & value )

Sets the threshold value for an icon in a conditional format.

Read/write Variant. Since Excel 2007.

MSDN documentation for IconCriterion.Value.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "IconCriterion".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetIcon()

◆ SetIcon()

◆ GetIndex()

◆ GetOperator()

◆ SetOperator()

◆ GetType()

◆ GetValue()

◆ SetValue()

◆ GetAutoExcelObjectName_()