Represents Microsoft Excel FormatConditions collection. More...

#include <wxAutoExcelFormatConditions.h>

Inheritance diagram for wxAutoExcel::wxExcelFormatConditions:

Public Member Functions
wxExcelFormatCondition	Add (XlFormatConditionType conditionType, XlFormatConditionOperator *conditionOperator=NULL, const wxVariant &formula1=wxNullVariant, const wxVariant &formula2=wxNullVariant)
	Adds a new conditional format.

wxExcelAboveAverage	AddAboveAverage ()
	Returns a new AboveAverage object representing a conditional formatting rule for the specified range.

wxExcelColorScale	AddColorScale (long colorScaleType)
	Returns a new ColorScale object representing a color scale conditional formatting rule for the selected range.

wxExcelDatabar	AddDatabar ()
	Returns a Databar object representing a data bar conditional formatting rule for the specified range.

wxExcelIconSetCondition	AddIconSetCondition ()
	Returns a new IconSetCondition object which represents an icon set conditional formatting rule for the specified range.

wxExcelTop10	AddTop10 ()
	Returns a Top10 object representing a conditional formatting rule for the specified range.

wxExcelUniqueValues	AddUniqueValues ()
	Returns a new UniqueValues object representing a conditional formatting rule for the specified range.

void	Delete ()
	Deletes the object.

wxExcelFormatCondition	Item (long index)
	Returns a single object from a collection.

long	GetCount ()
	Returns a Long value that represents the number of objects in the collection.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "FormatConditions".

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

Member Function Documentation

◆ Add()

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

Adds a new conditional format.

MSDN documentation for FormatConditions.Add.

Unfortunately it appears it is impossible to add language-agnostic formula, see here for workaround.

◆ AddAboveAverage()

wxExcelAboveAverage wxAutoExcel::wxExcelFormatConditions::AddAboveAverage ( )

Returns a new AboveAverage object representing a conditional formatting rule for the specified range.

MSDN documentation for FormatConditions.AddAboveAverage.

◆ AddColorScale()

wxExcelColorScale wxAutoExcel::wxExcelFormatConditions::AddColorScale ( long colorScaleType )

Returns a new ColorScale object representing a color scale conditional formatting rule for the selected range.

MSDN documentation for FormatConditions.AddColorScale.

◆ AddDatabar()

wxExcelDatabar wxAutoExcel::wxExcelFormatConditions::AddDatabar ( )

Returns a Databar object representing a data bar conditional formatting rule for the specified range.

MSDN documentation for FormatConditions.AddDatabar.

◆ AddIconSetCondition()

wxExcelIconSetCondition wxAutoExcel::wxExcelFormatConditions::AddIconSetCondition ( )

Returns a new IconSetCondition object which represents an icon set conditional formatting rule for the specified range.

MSDN documentation for FormatConditions.AddIconSetCondition.

◆ AddTop10()

wxExcelTop10 wxAutoExcel::wxExcelFormatConditions::AddTop10 ( )

Returns a Top10 object representing a conditional formatting rule for the specified range.

MSDN documentation for FormatConditions.AddTop10.

◆ AddUniqueValues()

wxExcelUniqueValues wxAutoExcel::wxExcelFormatConditions::AddUniqueValues ( )

Returns a new UniqueValues object representing a conditional formatting rule for the specified range.

MSDN documentation for FormatConditions.AddUniqueValues.

◆ Delete()

void wxAutoExcel::wxExcelFormatConditions::Delete ( )

Deletes the object.

MSDN documentation for FormatConditions.Delete.

◆ Item()

wxExcelFormatCondition wxAutoExcel::wxExcelFormatConditions::Item ( long index )

Returns a single object from a collection.

MSDN documentation for FormatConditions.Item.

◆ GetCount()

long wxAutoExcel::wxExcelFormatConditions::GetCount ( )

Returns a Long value that represents the number of objects in the collection.

MSDN documentation for FormatConditions.Count.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "FormatConditions".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members