Represents a Microsoft Excel IconSetCondition object. More...

#include <wxAutoExcelIconSetCondition.h>

Inheritance diagram for wxAutoExcel::wxExcelIconSetCondition:

Public Member Functions
void	Delete ()
	Deletes the specified conditional formatting rule object.

void	ModifyAppliesToRange (wxExcelRange range)
	Sets the cell range to which this formatting rule applies.

void	SetFirstPriority ()
	Sets the priority value for this conditional formatting rule to "1" so that it will be evaluated before all other rules on the worksheet.

void	SetLastPriority ()
	Sets the evaluation order for this conditional formatting rule so it is evaluated after all other rules on the worksheet.

wxExcelRange	GetAppliesTo ()
	Returns a Range object specifying the cell range to which the formatting rule is applied.

wxString	GetFormula ()
	Returns a String representing a formula which determines the values the icon set will be applied to.

void	SetFormula (const wxString &formula)
	Sets a String representing a formula which determines the values the icon set will be applied to.

wxExcelIconCriteria	GetIconCriteria ()
	Returns an IconCriteria collection which represents the set of criteria for an icon set conditional formatting rule.

wxExcelIconSets	GetIconSet ()
	Returns an IconSets collection which specifies the icon set used in the conditional format.

void	SetIconSet (const wxExcelIconSets &iconSet)
	Sets an IconSets collection which specifies the icon set used in the conditional format.

bool	GetPercentileValues ()
	Returns a Boolean value indicating if the thresholds for an icon set conditional format are determined using percentiles.

void	SetPercentileValues (bool percentileValues)
	Sets a Boolean value indicating if the thresholds for an icon set conditional format are determined using percentiles.

long	GetPriority ()
	Returns the priority value of the conditional formatting rule.

void	SetPriority (long priority)
	Sets the priority value of the conditional formatting rule.

bool	GetPTCondition ()
	Returns a Boolean value indicating if the conditional format is being applied to a PivotTable chart.

bool	GetReverseOrder ()
	Returns a Boolean value indicating if the order of icons is reversed for an icon set.

void	SetReverseOrder (bool reverseOrder)
	Sets a Boolean value indicating if the order of icons is reversed for an icon set.

XlPivotConditionScope	GetScopeType ()
	Returns one of the constants of the XlPivotConditionScope enumeration, which determines the scope of the conditional format when it is applied to a PivotTable chart.

void	SetScopeType (XlPivotConditionScope scopeType)
	Sets one of the constants of the XlPivotConditionScope enumeration, which determines the scope of the conditional format when it is applied to a PivotTable chart.

bool	GetShowIconOnly ()
	Returns a Boolean value indicating if only the icon is displayed for an icon set conditional format.

void	SetShowIconOnly (bool showIconOnly)
	Sets a Boolean value indicating if only the icon is displayed for an icon set conditional format.

bool	GetStopIfTrue ()
	Returns a Boolean value that determines if additional formatting rules on the cell should be evaluated if the current rule evaluates to True.

void	SetStopIfTrue (bool stopIfTrue)
	Sets a Boolean value that determines if additional formatting rules on the cell should be evaluated if the current rule evaluates to True.

XlFormatConditionType	GetType ()
	Returns one of the constants of the XlFormatConditionType enumeration, which specifies the type of conditional format.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "IconSetCondition".

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

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelIconSetCondition::Delete ( )

Deletes the specified conditional formatting rule object.

MSDN documentation for IconSetCondition.Delete.

◆ ModifyAppliesToRange()

void wxAutoExcel::wxExcelIconSetCondition::ModifyAppliesToRange ( wxExcelRange range )

Sets the cell range to which this formatting rule applies.

MSDN documentation for IconSetCondition.ModifyAppliesToRange.

◆ SetFirstPriority()

void wxAutoExcel::wxExcelIconSetCondition::SetFirstPriority ( )

Sets the priority value for this conditional formatting rule to "1" so that it will be evaluated before all other rules on the worksheet.

MSDN documentation for IconSetCondition.SetFirstPriority.

◆ SetLastPriority()

void wxAutoExcel::wxExcelIconSetCondition::SetLastPriority ( )

Sets the evaluation order for this conditional formatting rule so it is evaluated after all other rules on the worksheet.

MSDN documentation for IconSetCondition.SetLastPriority.

◆ GetAppliesTo()

wxExcelRange wxAutoExcel::wxExcelIconSetCondition::GetAppliesTo ( )

Returns a Range object specifying the cell range to which the formatting rule is applied.

Since Excel 2007.

MSDN documentation for IconSetCondition.AppliesTo.

◆ GetFormula()

wxString wxAutoExcel::wxExcelIconSetCondition::GetFormula ( )

Returns a String representing a formula which determines the values the icon set will be applied to.

Since Excel 2007.

MSDN documentation for IconSetCondition.Formula.

◆ SetFormula()

void wxAutoExcel::wxExcelIconSetCondition::SetFormula ( const wxString & formula )

Sets a String representing a formula which determines the values the icon set will be applied to.

Since Excel 2007.

MSDN documentation for IconSetCondition.Formula.

◆ GetIconCriteria()

wxExcelIconCriteria wxAutoExcel::wxExcelIconSetCondition::GetIconCriteria ( )

Returns an IconCriteria collection which represents the set of criteria for an icon set conditional formatting rule.

Since Excel 2007.

MSDN documentation for IconSetCondition.IconCriteria.

◆ GetIconSet()

wxExcelIconSets wxAutoExcel::wxExcelIconSetCondition::GetIconSet ( )

Returns an IconSets collection which specifies the icon set used in the conditional format.

Since Excel 2007.

MSDN documentation for IconSetCondition.IconSet.

◆ SetIconSet()

void wxAutoExcel::wxExcelIconSetCondition::SetIconSet ( const wxExcelIconSets & iconSet )

Sets an IconSets collection which specifies the icon set used in the conditional format.

Since Excel 2007.

MSDN documentation for IconSetCondition.IconSet.

◆ GetPercentileValues()

bool wxAutoExcel::wxExcelIconSetCondition::GetPercentileValues ( )

Returns a Boolean value indicating if the thresholds for an icon set conditional format are determined using percentiles.

Since Excel 2007.

MSDN documentation for IconSetCondition.PercentileValues.

◆ SetPercentileValues()

void wxAutoExcel::wxExcelIconSetCondition::SetPercentileValues ( bool percentileValues )

Sets a Boolean value indicating if the thresholds for an icon set conditional format are determined using percentiles.

Since Excel 2007.

MSDN documentation for IconSetCondition.PercentileValues.

◆ GetPriority()

long wxAutoExcel::wxExcelIconSetCondition::GetPriority ( )

Returns the priority value of the conditional formatting rule.

The priority determines the order of evaluation when multiple conditional formatting rules exist in a worksheet. Since Excel 2007.

MSDN documentation for IconSetCondition.Priority.

◆ SetPriority()

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

Sets the priority value of the conditional formatting rule.

The priority determines the order of evaluation when multiple conditional formatting rules exist in a worksheet. Since Excel 2007.

MSDN documentation for IconSetCondition.Priority.

◆ GetPTCondition()

bool wxAutoExcel::wxExcelIconSetCondition::GetPTCondition ( )

Returns a Boolean value indicating if the conditional format is being applied to a PivotTable chart.

Since Excel 2007.

MSDN documentation for IconSetCondition.PTCondition.

◆ GetReverseOrder()

bool wxAutoExcel::wxExcelIconSetCondition::GetReverseOrder ( )

Returns a Boolean value indicating if the order of icons is reversed for an icon set.

Since Excel 2007.

MSDN documentation for IconSetCondition.ReverseOrder.

◆ SetReverseOrder()

void wxAutoExcel::wxExcelIconSetCondition::SetReverseOrder ( bool reverseOrder )

Sets a Boolean value indicating if the order of icons is reversed for an icon set.

Since Excel 2007.

MSDN documentation for IconSetCondition.ReverseOrder.

◆ GetScopeType()

XlPivotConditionScope wxAutoExcel::wxExcelIconSetCondition::GetScopeType ( )

Returns one of the constants of the XlPivotConditionScope enumeration, which determines the scope of the conditional format when it is applied to a PivotTable chart.

Since Excel 2007.

MSDN documentation for IconSetCondition.ScopeType.

◆ SetScopeType()

void wxAutoExcel::wxExcelIconSetCondition::SetScopeType ( XlPivotConditionScope scopeType )

Sets one of the constants of the XlPivotConditionScope enumeration, which determines the scope of the conditional format when it is applied to a PivotTable chart.

Since Excel 2007.

MSDN documentation for IconSetCondition.ScopeType.

◆ GetShowIconOnly()

bool wxAutoExcel::wxExcelIconSetCondition::GetShowIconOnly ( )

Returns a Boolean value indicating if only the icon is displayed for an icon set conditional format.

Since Excel 2007.

MSDN documentation for IconSetCondition.ShowIconOnly.

◆ SetShowIconOnly()

void wxAutoExcel::wxExcelIconSetCondition::SetShowIconOnly ( bool showIconOnly )

Sets a Boolean value indicating if only the icon is displayed for an icon set conditional format.

Since Excel 2007.

MSDN documentation for IconSetCondition.ShowIconOnly.

◆ GetStopIfTrue()

bool wxAutoExcel::wxExcelIconSetCondition::GetStopIfTrue ( )

Returns a Boolean value that determines if additional formatting rules on the cell should be evaluated if the current rule evaluates to True.

Since Excel 2007.

MSDN documentation for IconSetCondition.StopIfTrue.

◆ SetStopIfTrue()

void wxAutoExcel::wxExcelIconSetCondition::SetStopIfTrue ( bool stopIfTrue )

Sets a Boolean value that determines if additional formatting rules on the cell should be evaluated if the current rule evaluates to True.

Since Excel 2007.

MSDN documentation for IconSetCondition.StopIfTrue.

◆ GetType()

XlFormatConditionType wxAutoExcel::wxExcelIconSetCondition::GetType ( )

Returns one of the constants of the XlFormatConditionType enumeration, which specifies the type of conditional format.

Since Excel 2007.

MSDN documentation for IconSetCondition.Type.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "IconSetCondition".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Delete()

◆ ModifyAppliesToRange()

◆ SetFirstPriority()

◆ SetLastPriority()

◆ GetAppliesTo()

◆ GetFormula()

◆ SetFormula()

◆ GetIconCriteria()

◆ GetIconSet()

◆ SetIconSet()

◆ GetPercentileValues()

◆ SetPercentileValues()

◆ GetPriority()

◆ SetPriority()

◆ GetPTCondition()

◆ GetReverseOrder()

◆ SetReverseOrder()

◆ GetScopeType()

◆ SetScopeType()

◆ GetShowIconOnly()

◆ SetShowIconOnly()

◆ GetStopIfTrue()

◆ SetStopIfTrue()

◆ GetType()

◆ GetAutoExcelObjectName_()