Represents a Microsoft Excel ColorScale object. More...

Inheritance diagram for wxAutoExcel::wxExcelColorScale:

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

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

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. More...

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

wxExcelRange	GetAppliesTo ()
	When used without an object qualifier, this property returns an Application object that represents the Microsoft Office Excel application. More...

wxExcelColorScaleCriteria	GetColorScaleCriteria ()
	Returns a ColorScaleCriteria object which is a collection of individual ColorScaleCriterion objects. More...

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

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

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

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

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

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. More...

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. More...

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

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "ColorScale". More...

Public Member Functions inherited from wxAutoExcel::wxExcelObject
bool	IsOk_ () const
	Returns true if the object has a valid dispatch. More...

wxString	GetAutomationObjectName_ (bool stripUnderscores=false) const
	Returns object name as provided by IDispatch->GetTypeInfo()->GetDocumentation(MEMBERID_NIL, &name, NULL, NULL, NULL). More...

wxSharedPtr< wxAutomationObject >	GetAutomationObject_ ()
	Returns the underlying wxAutomationObject. More...

	operator bool () const
	Returns true if the object has a valid dispatch and its last automation call (if any), i.e. More...

WXLCID	GetAutomationLCID_ () const
	Returns the locale identifier used in automation calls. More...

bool	SetAutomationLCID_ (WXLCID lcid)
	Sets the locale identifier to be used in automation calls. More...

bool	GetPropertyAndMethodNames_ (wxArrayString &propertyNames, wxArrayString &methodNames, bool includeHidden=false)
	Returns lists of property and method names the automation interface exposes. More...

bool	GetUnimplementedObject_ (const wxString &name, wxAutomationObject &object)
	Helper function for receiving an automation object not implemented in wxAutoExcel, see FAQ on how to use. More...

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. More...

static void	SetErrorMode_ (unsigned mode)
	Sets the error mode as the combination of wxExcelObject::ErrorFlags. More...

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. More...

Detailed Description

Represents a Microsoft Excel ColorScale object.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelColorScale::Delete ( )

Deletes the specified conditional formatting rule object.

MSDN documentation for ColorScale.Delete.

◆ ModifyAppliesToRange()

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

Sets the cell range to which this formatting rule applies.

MSDN documentation for ColorScale.ModifyAppliesToRange.

◆ SetFirstPriority()

void wxAutoExcel::wxExcelColorScale::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 ColorScale.SetFirstPriority.

◆ SetLastPriority()

void wxAutoExcel::wxExcelColorScale::SetLastPriority ( )

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

MSDN documentation for ColorScale.SetLastPriority.

◆ GetAppliesTo()

wxExcelRange wxAutoExcel::wxExcelColorScale::GetAppliesTo ( )

When used without an object qualifier, this property returns an Application object that represents the Microsoft Office Excel application.

When used with an object qualifier, this property returns an Application object that represents the creator of the specified object. Since Excel 2007.

MSDN documentation for ColorScale.Application. Returns a Range object specifying the cell range to which the formatting rule is applied. Since Excel 2007.

MSDN documentation for ColorScale.AppliesTo.

◆ GetColorScaleCriteria()

wxExcelColorScaleCriteria wxAutoExcel::wxExcelColorScale::GetColorScaleCriteria ( )

Returns a ColorScaleCriteria object which is a collection of individual ColorScaleCriterion objects.

The ColorScaleCriterion object specifies the type, value, and the color of threshold criteria used in the color scale conditional format. Since Excel 2007.

MSDN documentation for ColorScale.ColorScaleCriteria.

◆ GetFormula()

wxString wxAutoExcel::wxExcelColorScale::GetFormula ( )

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

Since Excel 2007.

MSDN documentation for ColorScale.Formula.

◆ SetFormula()

void wxAutoExcel::wxExcelColorScale::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 ColorScale.Formula.

◆ GetPriority()

long wxAutoExcel::wxExcelColorScale::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 ColorScale.Priority.

◆ SetPriority()

void wxAutoExcel::wxExcelColorScale::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 ColorScale.Priority.

◆ GetPTCondition()

bool wxAutoExcel::wxExcelColorScale::GetPTCondition ( )

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

Since Excel 2007.

MSDN documentation for ColorScale.PTCondition.

◆ GetScopeType()

XlPivotConditionScope wxAutoExcel::wxExcelColorScale::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 ColorScale.ScopeType.

◆ GetStopIfTrue()

bool wxAutoExcel::wxExcelColorScale::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 ColorScale.StopIfTrue.

◆ GetType()

XlFormatConditionType wxAutoExcel::wxExcelColorScale::GetType ( )

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

Since Excel 2007.

MSDN documentation for ColorScale.Type.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "ColorScale".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Delete()

◆ ModifyAppliesToRange()

◆ SetFirstPriority()

◆ SetLastPriority()

◆ GetAppliesTo()

◆ GetColorScaleCriteria()

◆ GetFormula()

◆ SetFormula()

◆ GetPriority()

◆ SetPriority()

◆ GetPTCondition()

◆ GetScopeType()

◆ GetStopIfTrue()

◆ GetType()

◆ GetAutoExcelObjectName_()