Represents a Microsoft Excel Top10 object. More...

#include <wxAutoExcelTop10.h>

Inheritance diagram for wxAutoExcel::wxExcelTop10:

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.

wxExcelBorders	GetBorders ()
	Returns a Borders collection that specifies the formatting of cell borders if the conditional formatting rule evaluates to True.

XlCalcFor	GetCalcFor ()
	Returns one of the constants of XlCalcFor enumeration which specifies the scope of data to be evaluated for the conditional format in a PivotTable report.

void	SetCalcFor (XlCalcFor calcFor)
	Sets one of the constants of XlCalcFor enumeration which specifies the scope of data to be evaluated for the conditional format in a PivotTable report.

wxExcelFont	GetFont ()
	Returns a Font object that specifies the font formatting if the conditional formatting rule evaluates to True.

wxExcelInterior	GetInterior ()
	Returns an Interior object that specifies a cell's interior attributes for a conditional formatting rule that evaluates to True.

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

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

bool	GetPercent ()
	Returns a Boolean value specifying if the rank is determined by a percentage value.

void	SetPercent (bool percent)
	Sets a Boolean value specifying if the rank is determined by a percentage value.

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.

long	GetRank ()
	Returns a Long value specifying either the number or percentage of the rank value for the conditional format rule.

void	SetRank (long rank)
	Sets a Long value specifying either the number or percentage of the rank value for the conditional format rule.

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

XlTopBottom	GetTopBottom ()
	Returns one of the constants of XlTopBottom enumeration determining if the ranking is evaluated from the top or bottom.

void	SetTopBottom (XlTopBottom topBottom)
	Sets one of the constants of XlTopBottom enumeration determining if the ranking is evaluated from the top or bottom.

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

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Top10".

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

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelTop10::Delete ( )

Deletes the specified conditional formatting rule object.

MSDN documentation for Top10.Delete.

◆ ModifyAppliesToRange()

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

Sets the cell range to which this formatting rule applies.

MSDN documentation for Top10.ModifyAppliesToRange.

◆ SetFirstPriority()

void wxAutoExcel::wxExcelTop10::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 Top10.SetFirstPriority.

◆ SetLastPriority()

void wxAutoExcel::wxExcelTop10::SetLastPriority ( )

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

MSDN documentation for Top10.SetLastPriority.

◆ GetAppliesTo()

wxExcelRange wxAutoExcel::wxExcelTop10::GetAppliesTo ( )

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

Since Excel 2007.

MSDN documentation for Top10.AppliesTo.

◆ GetBorders()

wxExcelBorders wxAutoExcel::wxExcelTop10::GetBorders ( )

Returns a Borders collection that specifies the formatting of cell borders if the conditional formatting rule evaluates to True.

Since Excel 2007.

MSDN documentation for Top10.Borders.

◆ GetCalcFor()

XlCalcFor wxAutoExcel::wxExcelTop10::GetCalcFor ( )

Returns one of the constants of XlCalcFor enumeration which specifies the scope of data to be evaluated for the conditional format in a PivotTable report.

Since Excel 2007.

MSDN documentation for Top10.CalcFor.

◆ SetCalcFor()

void wxAutoExcel::wxExcelTop10::SetCalcFor ( XlCalcFor calcFor )

Sets one of the constants of XlCalcFor enumeration which specifies the scope of data to be evaluated for the conditional format in a PivotTable report.

Since Excel 2007.

MSDN documentation for Top10.CalcFor.

◆ GetFont()

wxExcelFont wxAutoExcel::wxExcelTop10::GetFont ( )

Returns a Font object that specifies the font formatting if the conditional formatting rule evaluates to True.

Since Excel 2007.

MSDN documentation for Top10.Font.

◆ GetInterior()

wxExcelInterior wxAutoExcel::wxExcelTop10::GetInterior ( )

Returns an Interior object that specifies a cell's interior attributes for a conditional formatting rule that evaluates to True.

Since Excel 2007.

MSDN documentation for Top10.Interior.

◆ GetNumberFormat()

wxString wxAutoExcel::wxExcelTop10::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 Top10.NumberFormat.

◆ SetNumberFormat()

void wxAutoExcel::wxExcelTop10::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 Top10.NumberFormat.

◆ GetPercent()

bool wxAutoExcel::wxExcelTop10::GetPercent ( )

Returns a Boolean value specifying if the rank is determined by a percentage value.

Since Excel 2007.

MSDN documentation for Top10.Percent.

◆ SetPercent()

void wxAutoExcel::wxExcelTop10::SetPercent ( bool percent )

Sets a Boolean value specifying if the rank is determined by a percentage value.

Since Excel 2007.

MSDN documentation for Top10.Percent.

◆ GetPriority()

long wxAutoExcel::wxExcelTop10::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 Top10.Priority.

◆ SetPriority()

void wxAutoExcel::wxExcelTop10::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 Top10.Priority.

◆ GetPTCondition()

bool wxAutoExcel::wxExcelTop10::GetPTCondition ( )

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

Since Excel 2007.

MSDN documentation for Top10.PTCondition.

◆ GetRank()

long wxAutoExcel::wxExcelTop10::GetRank ( )

Returns a Long value specifying either the number or percentage of the rank value for the conditional format rule.

Since Excel 2007.

MSDN documentation for Top10.Rank.

◆ SetRank()

void wxAutoExcel::wxExcelTop10::SetRank ( long rank )

Sets a Long value specifying either the number or percentage of the rank value for the conditional format rule.

Since Excel 2007.

MSDN documentation for Top10.Rank.

◆ GetScopeType()

XlPivotConditionScope wxAutoExcel::wxExcelTop10::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 Top10.ScopeType.

◆ SetScopeType()

void wxAutoExcel::wxExcelTop10::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 Top10.ScopeType.

◆ GetStopIfTrue()

bool wxAutoExcel::wxExcelTop10::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 Top10.StopIfTrue.

◆ SetStopIfTrue()

void wxAutoExcel::wxExcelTop10::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 Top10.StopIfTrue.

◆ GetTopBottom()

XlTopBottom wxAutoExcel::wxExcelTop10::GetTopBottom ( )

Returns one of the constants of XlTopBottom enumeration determining if the ranking is evaluated from the top or bottom.

Since Excel 2007.

MSDN documentation for Top10.TopBottom.

◆ SetTopBottom()

void wxAutoExcel::wxExcelTop10::SetTopBottom ( XlTopBottom topBottom )

Sets one of the constants of XlTopBottom enumeration determining if the ranking is evaluated from the top or bottom.

Since Excel 2007.

MSDN documentation for Top10.TopBottom.

◆ GetType()

XlFormatConditionType wxAutoExcel::wxExcelTop10::GetType ( )

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

Since Excel 2007.

MSDN documentation for Top10.Type.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "Top10".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Delete()

◆ ModifyAppliesToRange()

◆ SetFirstPriority()

◆ SetLastPriority()

◆ GetAppliesTo()

◆ GetBorders()

◆ GetCalcFor()

◆ SetCalcFor()

◆ GetFont()

◆ GetInterior()

◆ GetNumberFormat()

◆ SetNumberFormat()

◆ GetPercent()

◆ SetPercent()

◆ GetPriority()

◆ SetPriority()

◆ GetPTCondition()

◆ GetRank()

◆ SetRank()

◆ GetScopeType()

◆ SetScopeType()

◆ GetStopIfTrue()

◆ SetStopIfTrue()

◆ GetTopBottom()

◆ SetTopBottom()

◆ GetType()

◆ GetAutoExcelObjectName_()