Represents Microsoft Excel ChartFillFormat object. More...

Inheritance diagram for wxAutoExcel::wxExcelChartFillFormat:

Public Member Functions
void	OneColorGradient (MsoGradientStyle style, long variant, double degree)
	Sets the specified fill to a one-color gradient. More...

void	Patterned (MsoPatternType pattern)
	Sets the specified fill to a pattern. More...

void	PresetGradient (MsoGradientStyle style, long variant, MsoPresetGradientType presetGradientType)
	Sets the specified fill to a preset gradient. More...

void	PresetTextured (MsoPresetTexture presetTexture)
	Sets the specified fill format to a preset texture. More...

void	Solid ()
	Sets the specified fill to a uniform color. More...

void	TwoColorGradient (MsoGradientStyle style, long variant)
	Sets the specified fill to a two-color gradient. More...

void	UserPicture (const wxString &pictureFile=wxEmptyString, XlChartPictureType pictureFormat=NULL, double pictureStackUnit=NULL, XlChartPicturePlacement *picturePlacement=NULL)
	Fills the specified shape with an image. More...

void	UserTextured (const wxString &textureFile)
	Fills the specified shape with small tiles of an image. More...

wxExcelChartColorFormat	GetBackColor ()
	Returns a ChartColorFormat object that represents the specified fill background color. More...

wxExcelChartColorFormat	GetForeColor ()
	Returns a ChartColorFormat object that represents the specified foreground fill or solid color. More...

MsoGradientColorType	GetGradientColorType ()
	Returns the gradient color type for the specified fill. More...

double	GetGradientDegree ()
	Returns the gradient degree of the specified one-color shaded fill as a floating-point value from 0.0 (dark) through 1.0 (light). More...

MsoGradientStyle	GetGradientStyle ()
	Returns the gradient style for the specified fill. More...

long	GetGradientVariant ()
	Returns the shade variant for the specified fill as an integer value from 1 through 4. More...

MsoPatternType	GetPattern ()
	Returns an MsoPatternType value that represents the fill pattern. More...

void	SetPattern (MsoPatternType pattern)
	Sets an MsoPatternType value that represents the fill pattern. More...

MsoPresetGradientType	GetPresetGradientType ()
	Returns the preset gradient type for the specified fill. More...

MsoPresetTexture	GetPresetTexture ()
	Returns the preset texture for the specified fill. More...

wxString	GetTextureName ()
	Returns the name of the custom texture file for the specified fill. More...

MsoTextureType	GetTextureType ()
	Returns the texture type for the specified fill. More...

MsoFillType	GetType ()
	Returns a MsoFillType value that represents the the fill type. More...

MsoTriState	GetVisible ()
	Returns a MsoTriState value that determines whether the object is visible. More...

void	SetVisible (MsoTriState visible)
	Sets a MsoTriState value that determines whether the object is visible. More...

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

Member Function Documentation

◆ OneColorGradient()

void wxAutoExcel::wxExcelChartFillFormat::OneColorGradient	(	MsoGradientStyle	style,
		long	variant,
		double	degree
	)

Sets the specified fill to a one-color gradient.

MSDN documentation for ChartFillFormat.OneColorGradient.

◆ Patterned()

void wxAutoExcel::wxExcelChartFillFormat::Patterned ( MsoPatternType pattern )

Sets the specified fill to a pattern.

MSDN documentation for ChartFillFormat.Patterned.

◆ PresetGradient()

void wxAutoExcel::wxExcelChartFillFormat::PresetGradient	(	MsoGradientStyle	style,
		long	variant,
		MsoPresetGradientType	presetGradientType
	)

Sets the specified fill to a preset gradient.

MSDN documentation for ChartFillFormat.PresetGradient.

◆ PresetTextured()

void wxAutoExcel::wxExcelChartFillFormat::PresetTextured ( MsoPresetTexture presetTexture )

Sets the specified fill format to a preset texture.

MSDN documentation for ChartFillFormat.PresetTextured.

◆ Solid()

void wxAutoExcel::wxExcelChartFillFormat::Solid ( )

Sets the specified fill to a uniform color.

Use this method to convert a gradient, textured, patterned, or background fill back to a solid fill.

MSDN documentation for ChartFillFormat.Solid.

◆ TwoColorGradient()

void wxAutoExcel::wxExcelChartFillFormat::TwoColorGradient	(	MsoGradientStyle	style,
		long	variant
	)

Sets the specified fill to a two-color gradient.

MSDN documentation for ChartFillFormat.TwoColorGradient.

◆ UserPicture()

void wxAutoExcel::wxExcelChartFillFormat::UserPicture	(	const wxString &	pictureFile = `wxEmptyString`,
		XlChartPictureType *	pictureFormat = `NULL`,
		double *	pictureStackUnit = `NULL`,
		XlChartPicturePlacement *	picturePlacement = `NULL`
	)

Fills the specified shape with an image.

MSDN documentation for ChartFillFormat.UserPicture.

◆ UserTextured()

void wxAutoExcel::wxExcelChartFillFormat::UserTextured ( const wxString & textureFile )

Fills the specified shape with small tiles of an image.

If you want to fill the shape with one large image, use the UserPicture method.

MSDN documentation for ChartFillFormat.UserTextured.

◆ GetBackColor()

wxExcelChartColorFormat wxAutoExcel::wxExcelChartFillFormat::GetBackColor ( )

Returns a ChartColorFormat object that represents the specified fill background color.

MSDN documentation for ChartFillFormat.BackColor.

◆ GetForeColor()

wxExcelChartColorFormat wxAutoExcel::wxExcelChartFillFormat::GetForeColor ( )

Returns a ChartColorFormat object that represents the specified foreground fill or solid color.

MSDN documentation for ChartFillFormat.ForeColor.

◆ GetGradientColorType()

MsoGradientColorType wxAutoExcel::wxExcelChartFillFormat::GetGradientColorType ( )

Returns the gradient color type for the specified fill.

Read-only MsoGradientColorType.

MSDN documentation for ChartFillFormat.GradientColorType.

◆ GetGradientDegree()

double wxAutoExcel::wxExcelChartFillFormat::GetGradientDegree ( )

Returns the gradient degree of the specified one-color shaded fill as a floating-point value from 0.0 (dark) through 1.0 (light).

Read-only Single.

MSDN documentation for ChartFillFormat.GradientDegree.

◆ GetGradientStyle()

MsoGradientStyle wxAutoExcel::wxExcelChartFillFormat::GetGradientStyle ( )

Returns the gradient style for the specified fill.

Read-only MsoGradientStyle.

MSDN documentation for ChartFillFormat.GradientStyle.

◆ GetGradientVariant()

long wxAutoExcel::wxExcelChartFillFormat::GetGradientVariant ( )

Returns the shade variant for the specified fill as an integer value from 1 through 4.

The values for this property correspond to the gradient variants (numbered from left to right and from top to bottom) on the Gradient tab in the Fill Effects dialog box. Read-only Long

MSDN documentation for ChartFillFormat.GradientVariant.