Represents Microsoft Excel FormatCondition object. More...

Inheritance diagram for wxAutoExcel::wxExcelFormatCondition:

Public Member Functions
void	Delete ()
	Deletes the object. More...

void	Modify (XlFormatConditionType conditionType, XlFormatConditionOperator *conditionOperator=NULL, const wxVariant &formula1=wxNullVariant, const wxVariant &formula2=wxNullVariant)
	Modifies an existing conditional format. 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...

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

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

wxExcelBorders	GetBorders ()
	Returns a Borders collection that represents the borders of a style or a range of cells (including a range defined as part of a conditional format). More...

wxExcelFont	GetFont ()
	Returns a Font object that represents the font of the specified object. More...

wxString	GetFormula1 ()
	Returns the value or expression associated with the conditional format or data validation. More...

wxString	GetFormula2 ()
	Returns the value or expression associated with the second part of a conditional format or data validation. More...

wxExcelInterior	GetInterior ()
	Returns an Interior object that represents the interior of the specified object. More...

wxString	GetNumberFormat ()
	Returns the number format applied to a cell if the conditional formatting rule evaluates to True. More...

void	SetNumberFormat (const wxString &numberFormat)
	Sets the number format applied to a cell if the conditional formatting rule evaluates to True. More...

XlFormatConditionOperator	GetOperator ()
	Returns a Long value that represents the operator for the conditional format. More...

wxExcelObject	GetParent ()
	Returns the parent object for the specified object. 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...

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

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

wxString	GetText ()
	Returns a String value specifying the text string used by the conditional formatting rule. More...

void	SetText (const wxString &text)
	Sets a String value specifying the text string used by the conditional formatting rule. More...

XlContainsOperator	GetTextOperator ()
	Returns one of the constants of the XlContainsOperator enumeration specifying the text search performed by the conditional formatting rule. More...

void	SetTextOperator (XlContainsOperator textOperator)
	Sets one of the constants of the XlContainsOperator enumeration specifying the text search performed by the conditional formatting rule. More...

XlFormatConditionType	GetType ()
	Returns a Long value, containing a xlFormatConditionType value, that represents the object type. More...

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "FormatCondition". 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 Microsoft Excel FormatCondition object.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelFormatCondition::Delete ( )

Deletes the object.

MSDN documentation for FormatCondition.Delete.

◆ Modify()

void wxAutoExcel::wxExcelFormatCondition::Modify	(	XlFormatConditionType	conditionType,
		XlFormatConditionOperator *	conditionOperator = `NULL`,
		const wxVariant &	formula1 = `wxNullVariant`,
		const wxVariant &	formula2 = `wxNullVariant`
	)

Modifies an existing conditional format.

MSDN documentation for FormatCondition.Modify.

See wxExcelFormatCondition::Add() for a note about adding language-agnostic formulas.

◆ ModifyAppliesToRange()

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

Sets the cell range to which this formatting rule applies.

MSDN documentation for FormatCondition.ModifyAppliesToRange.

◆ SetFirstPriority()

void wxAutoExcel::wxExcelFormatCondition::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 FormatCondition.SetFirstPriority.

◆ SetLastPriority()

void wxAutoExcel::wxExcelFormatCondition::SetLastPriority ( )

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

MSDN documentation for FormatCondition.SetLastPriority.

◆ GetApplication()

wxExcelApplication wxAutoExcel::wxExcelFormatCondition::GetApplication ( )

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

When used with an object qualifier, this property returns an Application object that represents the creator of the specified object (you can use this property with an OLE Automation object to return the application of that object).

MSDN documentation for FormatCondition.Application.

◆ GetAppliesTo()

wxExcelRange wxAutoExcel::wxExcelFormatCondition::GetAppliesTo ( )

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

Since Excel 2007.

MSDN documentation for FormatCondition.AppliesTo.

◆ GetBorders()

wxExcelBorders wxAutoExcel::wxExcelFormatCondition::GetBorders ( )

Returns a Borders collection that represents the borders of a style or a range of cells (including a range defined as part of a conditional format).

MSDN documentation for FormatCondition.Borders.

◆ GetFont()

wxExcelFont wxAutoExcel::wxExcelFormatCondition::GetFont ( )

Returns a Font object that represents the font of the specified object.

MSDN documentation for FormatCondition.Font.

◆ GetFormula1()

wxString wxAutoExcel::wxExcelFormatCondition::GetFormula1 ( )

Returns the value or expression associated with the conditional format or data validation.

Can be a constant value, a string value, a cell reference, or a formula.

MSDN documentation for FormatCondition.Formula1.

◆ GetFormula2()

wxString wxAutoExcel::wxExcelFormatCondition::GetFormula2 ( )

Returns the value or expression associated with the second part of a conditional format or data validation.

Used only when the data validation conditional format Operator property is xlBetween or xlNotBetween. Can be a constant value, a string value, a cell reference, or a formula.

MSDN documentation for FormatCondition.Formula2.

◆ GetInterior()

wxExcelInterior wxAutoExcel::wxExcelFormatCondition::GetInterior ( )

Returns an Interior object that represents the interior of the specified object.

MSDN documentation for FormatCondition.Interior.

◆ GetNumberFormat()

wxString wxAutoExcel::wxExcelFormatCondition::GetNumberFormat ( )

Returns the number format applied to a cell if the conditional formatting rule evaluates to True.

Read/write Variant. Since Excel 2007.

MSDN documentation for FormatCondition.NumberFormat.

◆ SetNumberFormat()

void wxAutoExcel::wxExcelFormatCondition::SetNumberFormat ( const wxString & numberFormat )

Sets the number format applied to a cell if the conditional formatting rule evaluates to True.

Read/write Variant. Since Excel 2007.

MSDN documentation for FormatCondition.NumberFormat.

◆ GetOperator()

XlFormatConditionOperator wxAutoExcel::wxExcelFormatCondition::GetOperator ( )

Returns a Long value that represents the operator for the conditional format.

MSDN documentation for FormatCondition.Operator.

◆ GetParent()

wxExcelObject wxAutoExcel::wxExcelFormatCondition::GetParent ( )

Returns the parent object for the specified object.

MSDN documentation for FormatCondition.Parent.

◆ GetPriority()

long wxAutoExcel::wxExcelFormatCondition::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 FormatCondition.Priority.

◆ SetPriority()

void wxAutoExcel::wxExcelFormatCondition::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 FormatCondition.Priority.

◆ GetPTCondition()

bool wxAutoExcel::wxExcelFormatCondition::GetPTCondition ( )

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

Since Excel 2007.

MSDN documentation for FormatCondition.PTCondition.

◆ GetScopeType()

XlPivotConditionScope wxAutoExcel::wxExcelFormatCondition::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 FormatCondition.ScopeType.

◆ SetScopeType()

void wxAutoExcel::wxExcelFormatCondition::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 FormatCondition.ScopeType.

◆ GetStopIfTrue()

bool wxAutoExcel::wxExcelFormatCondition::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 FormatCondition.StopIfTrue.

◆ SetStopIfTrue()

void wxAutoExcel::wxExcelFormatCondition::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 FormatCondition.StopIfTrue.

◆ GetText()

wxString wxAutoExcel::wxExcelFormatCondition::GetText ( )

Returns a String value specifying the text string used by the conditional formatting rule.

Since Excel 2007.

MSDN documentation for FormatCondition.Text.

◆ SetText()

void wxAutoExcel::wxExcelFormatCondition::SetText ( const wxString & text )

Sets a String value specifying the text string used by the conditional formatting rule.

Since Excel 2007.

MSDN documentation for FormatCondition.Text.

◆ GetTextOperator()

XlContainsOperator wxAutoExcel::wxExcelFormatCondition::GetTextOperator ( )

Returns one of the constants of the XlContainsOperator enumeration specifying the text search performed by the conditional formatting rule.

Since Excel 2007.

MSDN documentation for FormatCondition.TextOperator.

◆ SetTextOperator()

void wxAutoExcel::wxExcelFormatCondition::SetTextOperator ( XlContainsOperator textOperator )

Sets one of the constants of the XlContainsOperator enumeration specifying the text search performed by the conditional formatting rule.

Since Excel 2007.

MSDN documentation for FormatCondition.TextOperator.

◆ GetType()

XlFormatConditionType wxAutoExcel::wxExcelFormatCondition::GetType ( )

Returns a Long value, containing a xlFormatConditionType value, that represents the object type.

MSDN documentation for FormatCondition.Type.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "FormatCondition".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Delete()

◆ Modify()

◆ ModifyAppliesToRange()

◆ SetFirstPriority()

◆ SetLastPriority()

◆ GetApplication()

◆ GetAppliesTo()

◆ GetBorders()

◆ GetFont()

◆ GetFormula1()

◆ GetFormula2()

◆ GetInterior()

◆ GetNumberFormat()

◆ SetNumberFormat()

◆ GetOperator()

◆ GetParent()

◆ GetPriority()

◆ SetPriority()

◆ GetPTCondition()

◆ GetScopeType()

◆ SetScopeType()

◆ GetStopIfTrue()

◆ SetStopIfTrue()

◆ GetText()

◆ SetText()

◆ GetTextOperator()

◆ SetTextOperator()

◆ GetType()

◆ GetAutoExcelObjectName_()