wxAutoExcel  2.0.0
wxAutoExcel::wxExcelColorFormat Class Reference

Represents Microsoft Excel ColorFormat object. More...

Inheritance diagram for wxAutoExcel::wxExcelColorFormat:
wxAutoExcel::wxExcelObject

Public Member Functions

double GetBrightness ()
 The luminosity of the specified object. More...
 
MsoThemeColorIndex GetObjectThemeColor ()
 Returns a color that is mapped to the theme color scheme. More...
 
void SetObjectThemeColor (MsoThemeColorIndex objectThemeColor)
 Sets a color that is mapped to the theme color scheme. More...
 
wxColour GetRGB ()
 Returns a Long value that represents the red-green-blue value of the specified color. More...
 
void SetRGB (const wxColour &RGB)
 Sets a Long value that represents the red-green-blue value of the specified color. More...
 
long GetSchemeColor ()
 Returns an Integer value that represents the color of a Color object, as an index in the current color scheme. More...
 
void SetSchemeColor (long schemeColor)
 Sets an Integer value that represents the color of a Color object, as an index in the current color scheme. More...
 
double GetTintAndShade ()
 Returns a value that lightens or darkens a color. More...
 
void SetTintAndShade (double tintAndShade)
 Sets a value that lightens or darkens a color. More...
 
MsoColorType GetType ()
 Returns a MsoColorType value that represents the color format type. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "ColorFormat". 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 Microsoft Excel ColorFormat object.

Member Function Documentation

◆ GetBrightness()

double wxAutoExcel::wxExcelColorFormat::GetBrightness ( )

The luminosity of the specified object.

Since Excel 2010.

MSDN documentation for ColorFormat.Brightness.

◆ GetObjectThemeColor()

MsoThemeColorIndex wxAutoExcel::wxExcelColorFormat::GetObjectThemeColor ( )

Returns a color that is mapped to the theme color scheme.

Since Excel 2007.

MSDN documentation for ColorFormat.ObjectThemeColor.

◆ SetObjectThemeColor()

void wxAutoExcel::wxExcelColorFormat::SetObjectThemeColor ( MsoThemeColorIndex  objectThemeColor)

Sets a color that is mapped to the theme color scheme.

MSDN documentation for ColorFormat.ObjectThemeColor.

◆ GetRGB()

wxColour wxAutoExcel::wxExcelColorFormat::GetRGB ( )

Returns a Long value that represents the red-green-blue value of the specified color.

MSDN documentation for ColorFormat.RGB.

◆ SetRGB()

void wxAutoExcel::wxExcelColorFormat::SetRGB ( const wxColour &  RGB)

Sets a Long value that represents the red-green-blue value of the specified color.

MSDN documentation for ColorFormat.RGB.

◆ GetSchemeColor()

long wxAutoExcel::wxExcelColorFormat::GetSchemeColor ( )

Returns an Integer value that represents the color of a Color object, as an index in the current color scheme.

MSDN documentation for ColorFormat.SchemeColor.

◆ SetSchemeColor()

void wxAutoExcel::wxExcelColorFormat::SetSchemeColor ( long  schemeColor)

Sets an Integer value that represents the color of a Color object, as an index in the current color scheme.

MSDN documentation for ColorFormat.SchemeColor.

◆ GetTintAndShade()

double wxAutoExcel::wxExcelColorFormat::GetTintAndShade ( )

Returns a value that lightens or darkens a color.

MSDN documentation for ColorFormat.TintAndShade.

◆ SetTintAndShade()

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

Sets a value that lightens or darkens a color.

MSDN documentation for ColorFormat.TintAndShade.

◆ GetType()

MsoColorType wxAutoExcel::wxExcelColorFormat::GetType ( )

Returns a MsoColorType value that represents the color format type.

MSDN documentation for ColorFormat.Type.

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelColorFormat::GetAutoExcelObjectName_ ( ) const
inlinevirtual

Returns "ColorFormat".

Reimplemented from wxAutoExcel::wxExcelObject.