Represents a Microsoft Excel Databar object. More...

#include <wxAutoExcelDatabar.h>

Inheritance diagram for wxAutoExcel::wxExcelDatabar:

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.

wxExcelFormatColor	GetAxisColor ()
	Returns the color of the axis for cells with conditional formatting as data bars.

XlDataBarAxisPosition	GetAxisPosition ()
	The position of the axis of the data bars specified by a conditional formatting rule.

void	SetAxisPosition (XlDataBarAxisPosition axisPosition)
	The position of the axis of the data bars specified by a conditional formatting rule.

wxExcelDataBarBorder	GetBarBorder ()
	Returns an object that specifies the border of a data bar.

wxExcelFormatColor	GetBarColor ()
	Returns a FormatColor object that you can use to modify the color of the bars in a data bar conditional format.

XlDataBarFillType	GetBarFillType ()
	How a data bar is filled with color.

void	SetBarFillType (XlDataBarFillType fillType)
	How a data bar is filled with color.

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.

wxExcelConditionValue	GetMaxPoint ()
	Returns a ConditionValue object which specifies how the longest bar is evaluated for a data bar conditional format.

wxExcelConditionValue	GetMinPoint ()
	Returns a ConditionValue object which specifies how the shortest bar is evaluated for a data bar conditional format.

wxExcelNegativeBarFormat	GetNegativeBarFormat ()
	Returns Returns the NegativeBarFormat object associated with a data bar conditional formatting rule.

long	GetPercentMax ()
	Returns a Long value that specifies the length of the longest data bar as a percentage of cell width.

void	SetPercentMax (long percentMax)
	Sets a Long value that specifies the length of the longest data bar as a percentage of cell width.

long	GetPercentMin ()
	Returns a Long value that specifies the length of the shortest data bar as a percentage of cell width.

void	SetPercentMin (long percentMin)
	Sets a Long value that specifies the length of the shortest data bar as a percentage of cell width.

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.

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	GetShowValue ()
	Returns a Boolean value that specifies if the value in the cell is displayed if the data bar conditional format is applied to the range.

void	SetShowValue (bool showValue)
	Sets a Boolean value that specifies if the value in the cell is displayed if the data bar conditional format is applied to the range.

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

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

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelDatabar::Delete ( )

Deletes the specified conditional formatting rule object.

MSDN documentation for Databar.?Delete.

◆ ModifyAppliesToRange()

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

Sets the cell range to which this formatting rule applies.

MSDN documentation for Databar.ModifyAppliesToRange.

◆ SetFirstPriority()

void wxAutoExcel::wxExcelDatabar::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 Databar.SetFirstPriority.

◆ SetLastPriority()

void wxAutoExcel::wxExcelDatabar::SetLastPriority ( )

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

MSDN documentation for Databar.SetLastPriority.

◆ GetAppliesTo()

wxExcelRange wxAutoExcel::wxExcelDatabar::GetAppliesTo ( )

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

Since Excel 2007.

MSDN documentation for Databar.AppliesTo.

◆ GetAxisColor()

wxExcelFormatColor wxAutoExcel::wxExcelDatabar::GetAxisColor ( )

Returns the color of the axis for cells with conditional formatting as data bars.

Since Excel 2010.

MSDN documentation for Databar.AxisColor.

◆ GetAxisPosition()

XlDataBarAxisPosition wxAutoExcel::wxExcelDatabar::GetAxisPosition ( )

The position of the axis of the data bars specified by a conditional formatting rule.

Since Excel 2010.

MSDN documentation for Databar.AxisPosition.

◆ SetAxisPosition()

void wxAutoExcel::wxExcelDatabar::SetAxisPosition ( XlDataBarAxisPosition axisPosition )

The position of the axis of the data bars specified by a conditional formatting rule.

Since Excel 2010.

MSDN documentation for Databar.AxisPosition.

◆ GetBarBorder()

wxExcelDataBarBorder wxAutoExcel::wxExcelDatabar::GetBarBorder ( )

Returns an object that specifies the border of a data bar.

Since Excel 2007.

MSDN documentation for Databar.BarBorder.

◆ GetBarColor()

wxExcelFormatColor wxAutoExcel::wxExcelDatabar::GetBarColor ( )

Returns a FormatColor object that you can use to modify the color of the bars in a data bar conditional format.

Since Excel 2007.

MSDN documentation for Databar.BarColor.

◆ GetBarFillType()

XlDataBarFillType wxAutoExcel::wxExcelDatabar::GetBarFillType ( )

How a data bar is filled with color.

Since Excel 2010.

MSDN documentation for Databar.BarFillType.

◆ SetBarFillType()

void wxAutoExcel::wxExcelDatabar::SetBarFillType ( XlDataBarFillType fillType )

How a data bar is filled with color.

Since Excel 2010.

MSDN documentation for Databar.BarFillType.

◆ GetFormula()

wxString wxAutoExcel::wxExcelDatabar::GetFormula ( )

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

Since Excel 2007.

MSDN documentation for Databar.Formula.

◆ SetFormula()

void wxAutoExcel::wxExcelDatabar::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 Databar.Formula.

◆ GetMaxPoint()

wxExcelConditionValue wxAutoExcel::wxExcelDatabar::GetMaxPoint ( )

Returns a ConditionValue object which specifies how the longest bar is evaluated for a data bar conditional format.

Since Excel 2007.

MSDN documentation for Databar.MaxPoint.

◆ GetMinPoint()

wxExcelConditionValue wxAutoExcel::wxExcelDatabar::GetMinPoint ( )

Returns a ConditionValue object which specifies how the shortest bar is evaluated for a data bar conditional format.

Since Excel 2007.

MSDN documentation for Databar.MinPoint.

◆ GetNegativeBarFormat()

wxExcelNegativeBarFormat wxAutoExcel::wxExcelDatabar::GetNegativeBarFormat ( )

Returns Returns the NegativeBarFormat object associated with a data bar conditional formatting rule.

Since Excel 2010.

MSDN documentation for Databar.NegativeBarFormat.

◆ GetPercentMax()

long wxAutoExcel::wxExcelDatabar::GetPercentMax ( )

Returns a Long value that specifies the length of the longest data bar as a percentage of cell width.

Since Excel 2007.

MSDN documentation for Databar.PercentMax.

◆ SetPercentMax()

void wxAutoExcel::wxExcelDatabar::SetPercentMax ( long percentMax )

Sets a Long value that specifies the length of the longest data bar as a percentage of cell width.

Since Excel 2007.

MSDN documentation for Databar.PercentMax.

◆ GetPercentMin()

long wxAutoExcel::wxExcelDatabar::GetPercentMin ( )

Returns a Long value that specifies the length of the shortest data bar as a percentage of cell width.

Since Excel 2007.

MSDN documentation for Databar.PercentMin.

◆ SetPercentMin()

void wxAutoExcel::wxExcelDatabar::SetPercentMin ( long percentMin )

Sets a Long value that specifies the length of the shortest data bar as a percentage of cell width.

Since Excel 2007.

MSDN documentation for Databar.PercentMin.

◆ GetPriority()

long wxAutoExcel::wxExcelDatabar::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 Databar.Priority.

◆ SetPriority()

void wxAutoExcel::wxExcelDatabar::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 Databar.Priority.

◆ GetPTCondition()

bool wxAutoExcel::wxExcelDatabar::GetPTCondition ( )

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

Since Excel 2007.

MSDN documentation for Databar.PTCondition.

◆ GetScopeType()

XlPivotConditionScope wxAutoExcel::wxExcelDatabar::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 Databar.ScopeType.

◆ SetScopeType()

void wxAutoExcel::wxExcelDatabar::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 Databar.ScopeType.

◆ GetShowValue()

bool wxAutoExcel::wxExcelDatabar::GetShowValue ( )

Returns a Boolean value that specifies if the value in the cell is displayed if the data bar conditional format is applied to the range.

Since Excel 2007.

MSDN documentation for Databar.ShowValue.

◆ SetShowValue()

void wxAutoExcel::wxExcelDatabar::SetShowValue ( bool showValue )

Sets a Boolean value that specifies if the value in the cell is displayed if the data bar conditional format is applied to the range.

Since Excel 2007.

MSDN documentation for Databar.ShowValue.

◆ GetStopIfTrue()

bool wxAutoExcel::wxExcelDatabar::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 Databar.StopIfTrue.

◆ SetStopIfTrue()

void wxAutoExcel::wxExcelDatabar::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 Databar.StopIfTrue.

◆ GetType()

XlFormatConditionType wxAutoExcel::wxExcelDatabar::GetType ( )

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

Since Excel 2007.

MSDN documentation for Databar.Type.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "Databar".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Delete()

◆ ModifyAppliesToRange()

◆ SetFirstPriority()

◆ SetLastPriority()

◆ GetAppliesTo()

◆ GetAxisColor()

◆ GetAxisPosition()

◆ SetAxisPosition()

◆ GetBarBorder()

◆ GetBarColor()

◆ GetBarFillType()

◆ SetBarFillType()

◆ GetFormula()

◆ SetFormula()

◆ GetMaxPoint()

◆ GetMinPoint()

◆ GetNegativeBarFormat()

◆ GetPercentMax()

◆ SetPercentMax()

◆ GetPercentMin()

◆ SetPercentMin()

◆ GetPriority()

◆ SetPriority()

◆ GetPTCondition()

◆ GetScopeType()

◆ SetScopeType()

◆ GetShowValue()

◆ SetShowValue()

◆ GetStopIfTrue()

◆ SetStopIfTrue()

◆ GetType()

◆ GetAutoExcelObjectName_()