Represents Microsoft Excel ColorStop object. More...

#include <wxAutoExcelGradient.h>

Inheritance diagram for wxAutoExcel::wxExcelColorStop:

Public Member Functions
bool	Delete ()
	Deletes the object.

wxColour	GetColor ()
	Returns the color.

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

double	GetPosition ()
	Returns its position.

void	SetPosition (double position)
	Sets the position.

XlThemeColor	GetThemeColor ()
	Returns the theme color.

void	SetThemeColor (XlThemeColor themeColor)
	Sets the theme color.

double	GetTintAndShade ()
	A number from -1 (darkest) to 1 (lightest) or 0 for neutral.

void	SetTintAndShade (double tintAndShade)
	A number from -1 (darkest) to 1 (lightest) or 0 for neutral.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "ColorStop".

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

Member Function Documentation

◆ Delete()

bool wxAutoExcel::wxExcelColorStop::Delete ( )

Deletes the object.

MSDN documentation for ColorStop.Delete.

◆ GetColor()

wxColour wxAutoExcel::wxExcelColorStop::GetColor ( )

Returns the color.

[MSDN documentation for ColorStop.Color]().

◆ SetColor()

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

Sets the color.

[MSDN documentation for ColorStop.Color]().

◆ GetPosition()

double wxAutoExcel::wxExcelColorStop::GetPosition ( )

Returns its position.

[MSDN documentation for ColorStop.Position]().

◆ SetPosition()

void wxAutoExcel::wxExcelColorStop::SetPosition ( double position )

Sets the position.

[MSDN documentation for ColorStop.Position]().

◆ GetThemeColor()

XlThemeColor wxAutoExcel::wxExcelColorStop::GetThemeColor ( )

Returns the theme color.

[MSDN documentation for ColorStop.ThemeColor]().

◆ SetThemeColor()

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

Sets the theme color.

[MSDN documentation for ColorStop.ThemeColor]().

◆ GetTintAndShade()

double wxAutoExcel::wxExcelColorStop::GetTintAndShade ( )

A number from -1 (darkest) to 1 (lightest) or 0 for neutral.

[MSDN documentation for ColorStop.TintAndShade]().

◆ SetTintAndShade()

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

A number from -1 (darkest) to 1 (lightest) or 0 for neutral.

[MSDN documentation for ColorStop.TintAndShade]().

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "ColorStop".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members