Represents Microsoft Office GradientStops collection, the stops of a gradient fill. More...

#include <wxAutoExcelGradientStops.h>

Inheritance diagram for wxAutoExcel::wxExcelGradientStops:

Public Types
typedef wxExcelCollectionIterator< wxExcelGradientStops, wxExcelGradientStop >	iterator
	The iterator over the items, see wxExcelCollectionIterator.
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...

Public Member Functions
void	Delete (long index=-1)
	Removes the gradient stop at index, or the last one when index is -1.
void	Insert (const wxColour &color, double position, double transparency=0, long index=-1)
	Adds a stop of color at position, from 0 to 1, with the given transparency, at index of the stops, or after the last one when index is -1.
void	Insert2 (const wxColour &color, double position, double transparency=0, long index=-1, double brightness=0)
	Like Insert(), also setting the brightness of the stop, from -1 (darkest) to 1 (lightest).
long	GetCount ()
	Returns the number of gradient stops.
wxExcelGradientStop	GetItem (long index)
	Returns the gradient stop at index.
iterator	begin ()
	Returns the iterator referring to the first item, or past the last item, which allows iterating over the items with a range-based for loop, see wxExcelCollectionIterator.
virtual wxString	GetAutoExcelObjectName_ () const
	Returns "GradientStops".
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.
template<typename T, typename = typename std::enable_if<std::is_same<T, bool>::value>::type>
	operator T () const
	Returns true if the object has a valid dispatch and its last automation call (if any), i.e.
bool	IsLastResultNull_ () const
	Returns true if MS Excel returned Null (or Empty) for the last property or method, e.g.
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	HasProperty_ (const wxString &name) const
	Returns true if the automation interface of the object has a property called name, ignoring the case, e.g.
bool	HasMethod_ (const wxString &name) const
	Returns true if the automation interface of the object has a method called name, ignoring the case, e.g.
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
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 Office GradientStops collection, the stops of a gradient fill.

Member Typedef Documentation

◆ iterator

typedef wxExcelCollectionIterator<wxExcelGradientStops, wxExcelGradientStop> wxAutoExcel::wxExcelGradientStops::iterator

The iterator over the items, see wxExcelCollectionIterator.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelGradientStops::Delete ( long index = -1 )

Removes the gradient stop at index, or the last one when index is -1.

MSDN documentation for GradientStops.Delete.

◆ Insert()

void wxAutoExcel::wxExcelGradientStops::Insert	(	const wxColour &	color,
		double	position,
		double	transparency = 0,
		long	index = -1 )

Adds a stop of color at position, from 0 to 1, with the given transparency, at index of the stops, or after the last one when index is -1.

MSDN documentation for GradientStops.Insert.

◆ Insert2()

void wxAutoExcel::wxExcelGradientStops::Insert2	(	const wxColour &	color,
		double	position,
		double	transparency = 0,
		long	index = -1,
		double	brightness = 0 )

Like Insert(), also setting the brightness of the stop, from -1 (darkest) to 1 (lightest).

MSDN documentation for GradientStops.Insert2.

◆ GetCount()

long wxAutoExcel::wxExcelGradientStops::GetCount ( )

Returns the number of gradient stops.

MSDN documentation for GradientStops.Count.

◆ GetItem()

wxExcelGradientStop wxAutoExcel::wxExcelGradientStops::GetItem ( long index )

Returns the gradient stop at index.

MSDN documentation for GradientStops.Item.

◆ begin()

iterator wxAutoExcel::wxExcelGradientStops::begin ( )

inline

Returns the iterator referring to the first item, or past the last item, which allows iterating over the items with a range-based for loop, see wxExcelCollectionIterator.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "GradientStops".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Types

Public Member Functions

Additional Inherited Members