Represents Microsoft Excel Interior. More...

#include <wxAutoExcelInterior.h>

Inheritance diagram for wxAutoExcel::wxExcelInterior:

Public Member Functions
wxColour	GetColor ()
	Returns the primary color.

void	SetColor (const wxColour &color)
	Sets the primary color.

long	GetColorIndex ()
	Returns the color index into palette.

void	SetColorIndex (long colorIndex)
	Sets the color index into palette.

wxExcelLinearGradient	GetLinearGradient ()
	Returns the Gradient property of an Interior object of a selection.

bool	GetInvertIfNegative ()
	True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

void	SetInvertIfNegative (bool invertIfNegative)
	True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

XlPattern	GetPattern ()
	An xlPattern constant that represents the interior pattern.

void	SetPattern (XlPattern pattern)
	An xlPattern constant that represents the interior pattern.

wxColour	GetPatternColor ()
	Returns the color of the interior pattern.

void	SetPatternColor (const wxColour &patternColor)
	Sets the color of the interior pattern.

long	GetPatternColorIndex ()
	Returns the color of the interior pattern as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone.

void	SetPatternColorIndex (long patternColorIndex)
	Sets the color of the interior pattern as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone.

XlThemeColor	GetPatternThemeColor ()
	Returns a theme color pattern.

void	SetPatternThemeColor (XlThemeColor patternThemeColor)
	Sets a theme color pattern.

double	GetPatternTintAndShade ()
	Returns a tint and shade pattern.

void	SetPatternTintAndShade (double patternTintAndShade)
	Sets a tint and shade pattern.

XlThemeColor	GetThemeColor ()
	Returns the theme color in the applied color scheme.

void	SetThemeColor (XlThemeColor themeColor)
	Sets the theme color in the applied color scheme.

double	GetTintAndShade ()
	Returns a value that lightens or darkens a color.

void	SetTintAndShade (double tintAndShade)
	Sets a value that lightens or darkens a color.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Object".

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

Member Function Documentation

◆ GetColor()

wxColour wxAutoExcel::wxExcelInterior::GetColor ( )

Returns the primary color.

MSDN documentation for Interior.Color.

◆ SetColor()

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

Sets the primary color.

MSDN documentation for Interior.Color.

◆ GetColorIndex()

long wxAutoExcel::wxExcelInterior::GetColorIndex ( )

Returns the color index into palette.

MSDN documentation for Interior.ColorIndex.

◆ SetColorIndex()

void wxAutoExcel::wxExcelInterior::SetColorIndex ( long colorIndex )

Sets the color index into palette.

MSDN documentation for Interior.ColorIndex.

◆ GetLinearGradient()

wxExcelLinearGradient wxAutoExcel::wxExcelInterior::GetLinearGradient ( )

Returns the Gradient property of an Interior object of a selection.

Since Excel 2007. You can call GetLinearGradient() only if GetPattern() returns xlPatternLinearGradient. You can call GetRectangularGradient() only if GetPattern() returns xlPatternRectangularGradient.

MSDN documentation for Interior.Gradient.

◆ GetInvertIfNegative()

bool wxAutoExcel::wxExcelInterior::GetInvertIfNegative ( )

True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

MSDN documentation for Interior.InvertIfNegative.

◆ SetInvertIfNegative()

void wxAutoExcel::wxExcelInterior::SetInvertIfNegative ( bool invertIfNegative )

True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

MSDN documentation for Interior.InvertIfNegative.

◆ GetPattern()

XlPattern wxAutoExcel::wxExcelInterior::GetPattern ( )

An xlPattern constant that represents the interior pattern.

MSDN documentation for Interior.Pattern.

◆ SetPattern()

void wxAutoExcel::wxExcelInterior::SetPattern ( XlPattern pattern )

An xlPattern constant that represents the interior pattern.

MSDN documentation for Interior.Pattern.

◆ GetPatternColor()

wxColour wxAutoExcel::wxExcelInterior::GetPatternColor ( )

Returns the color of the interior pattern.

MSDN documentation for Interior.PatternColor.

◆ SetPatternColor()

void wxAutoExcel::wxExcelInterior::SetPatternColor ( const wxColour & patternColor )

Sets the color of the interior pattern.

MSDN documentation for Interior.PatternColor.

◆ GetPatternColorIndex()

long wxAutoExcel::wxExcelInterior::GetPatternColorIndex ( )

Returns the color of the interior pattern as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone.

MSDN documentation for Interior.PatternColorIndex.

◆ SetPatternColorIndex()

void wxAutoExcel::wxExcelInterior::SetPatternColorIndex ( long patternColorIndex )

Sets the color of the interior pattern as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone.

MSDN documentation for Interior.PatternColorIndex.

◆ GetPatternThemeColor()

XlThemeColor wxAutoExcel::wxExcelInterior::GetPatternThemeColor ( )

Returns a theme color pattern.

Since Excel 2007.

MSDN documentation for Interior.PatternThemeColor.

◆ SetPatternThemeColor()

void wxAutoExcel::wxExcelInterior::SetPatternThemeColor ( XlThemeColor patternThemeColor )

Sets a theme color pattern.

MSDN documentation for Interior.PatternThemeColor.

◆ GetPatternTintAndShade()

double wxAutoExcel::wxExcelInterior::GetPatternTintAndShade ( )

Returns a tint and shade pattern.

Since Excel 2007.

MSDN documentation for Interior.PatternTintAndShade.

◆ SetPatternTintAndShade()

void wxAutoExcel::wxExcelInterior::SetPatternTintAndShade ( double patternTintAndShade )

Sets a tint and shade pattern.

MSDN documentation for Interior.PatternTintAndShade.

◆ GetThemeColor()

XlThemeColor wxAutoExcel::wxExcelInterior::GetThemeColor ( )

Returns the theme color in the applied color scheme.

Since Excel 2007.

MSDN documentation for Interior.ThemeColor.

◆ SetThemeColor()

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

Sets the theme color in the applied color scheme.

MSDN documentation for Interior.ThemeColor.

◆ GetTintAndShade()

double wxAutoExcel::wxExcelInterior::GetTintAndShade ( )

Returns a value that lightens or darkens a color.

Since Excel 2007.

MSDN documentation for Interior.TintAndShade.

◆ SetTintAndShade()

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

Sets a value that lightens or darkens a color.

MSDN documentation for Interior.TintAndShade.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "Object".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetColor()

◆ SetColor()

◆ GetColorIndex()

◆ SetColorIndex()

◆ GetLinearGradient()

◆ GetInvertIfNegative()

◆ SetInvertIfNegative()

◆ GetPattern()

◆ SetPattern()

◆ GetPatternColor()

◆ SetPatternColor()

◆ GetPatternColorIndex()

◆ SetPatternColorIndex()

◆ GetPatternThemeColor()

◆ SetPatternThemeColor()

◆ GetPatternTintAndShade()

◆ SetPatternTintAndShade()

◆ GetThemeColor()

◆ SetThemeColor()

◆ GetTintAndShade()

◆ SetTintAndShade()

◆ GetAutoExcelObjectName_()