Represents a Microsoft Excel FormatColor object. More...

Inheritance diagram for wxAutoExcel::wxExcelFormatColor:

Public Member Functions
wxColour	GetColor ()
	Returns the fill color associated with a threshold for a data bar or color scale conditional formatting rule. More...

void	SetColor (const wxColour &color)
	Sets the fill color associated with a threshold for a data bar or color scale conditional formatting rule. More...

XlColorIndex	GetColorIndex ()
	Returns one of the constants of the XlColorIndex enumeration specifying if the fill color is expressed as an index value into the current color palette. More...

void	SetColorIndex (XlColorIndex colorIndex)
	Sets one of the constants of the XlColorIndex enumeration specifying if the fill color is expressed as an index value into the current color palette. More...

XlThemeColor	GetThemeColor ()
	Returns of sets one of the constants of the XlThemeColor enumeration specifying the theme color used in a threshold of a data bar or color scale conditional format. More...

void	SetThemeColor (XlThemeColor themeColor)
	Returns of sets one of the constants of the XlThemeColor enumeration specifying the theme color used in a threshold of a data bar or color scale conditional format. More...

double	GetTintAndShade ()
	Returns a Single that lightens or darkens the fill color of a cell for a thresholds of a data bar or color scale conditional formatting rule. More...

void	SetTintAndShade (double tintAndShade)
	Sets a Single that lightens or darkens the fill color of a cell for a thresholds of a data bar or color scale conditional formatting rule. More...

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

Member Function Documentation

◆ GetColor()

wxColour wxAutoExcel::wxExcelFormatColor::GetColor ( )

Returns the fill color associated with a threshold for a data bar or color scale conditional formatting rule.

Since Excel 2007.

MSDN documentation for FormatColor.Color.

◆ SetColor()

void wxAutoExcel::wxExcelFormatColor::SetColor ( const wxColour & color )

Sets the fill color associated with a threshold for a data bar or color scale conditional formatting rule.

Since Excel 2007.

MSDN documentation for FormatColor.Color.

◆ GetColorIndex()

XlColorIndex wxAutoExcel::wxExcelFormatColor::GetColorIndex ( )

Returns one of the constants of the XlColorIndex enumeration specifying if the fill color is expressed as an index value into the current color palette.

Since Excel 2007.

MSDN documentation for FormatColor.ColorIndex.

◆ SetColorIndex()

void wxAutoExcel::wxExcelFormatColor::SetColorIndex ( XlColorIndex colorIndex )

Sets one of the constants of the XlColorIndex enumeration specifying if the fill color is expressed as an index value into the current color palette.

Since Excel 2007.

MSDN documentation for FormatColor.ColorIndex.

◆ GetThemeColor()

XlThemeColor wxAutoExcel::wxExcelFormatColor::GetThemeColor ( )

Returns of sets one of the constants of the XlThemeColor enumeration specifying the theme color used in a threshold of a data bar or color scale conditional format.

Since Excel 2007.

MSDN documentation for FormatColor.ThemeColor.

◆ SetThemeColor()

void wxAutoExcel::wxExcelFormatColor::SetThemeColor ( XlThemeColor themeColor )

Returns of sets one of the constants of the XlThemeColor enumeration specifying the theme color used in a threshold of a data bar or color scale conditional format.

Since Excel 2007.

MSDN documentation for FormatColor.ThemeColor.

◆ GetTintAndShade()

double wxAutoExcel::wxExcelFormatColor::GetTintAndShade ( )

Returns a Single that lightens or darkens the fill color of a cell for a thresholds of a data bar or color scale conditional formatting rule.

Since Excel 2007.

MSDN documentation for FormatColor.TintAndShade.

◆ SetTintAndShade()

void wxAutoExcel::wxExcelFormatColor::SetTintAndShade ( double tintAndShade )

Sets a Single that lightens or darkens the fill color of a cell for a thresholds of a data bar or color scale conditional formatting rule.

Since Excel 2007.

MSDN documentation for FormatColor.TintAndShade.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "FormatColor".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetColor()

◆ SetColor()

◆ GetColorIndex()

◆ SetColorIndex()

◆ GetThemeColor()

◆ SetThemeColor()

◆ GetTintAndShade()

◆ SetTintAndShade()

◆ GetAutoExcelObjectName_()