Represents Microsoft Excel FillFormat object. More...

Inheritance diagram for wxAutoExcel::wxExcelFillFormat:

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)
	Fills the specified shape with an image. More...

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

wxExcelColorFormat	GetBackColor ()
	Returns a ColorFormat Represents the specified fill background color. More...

wxExcelColorFormat	GetForeColor ()
	Returns a ColorFormat 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 ()
	Since Excel 2007. 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...

MsoTriState	GetRotateWithObject ()
	Returns if the fill style should rotate with the object. More...

void	SetRotateWithObject (MsoTriState rotateWithObject)
	Sets if the fill style should rotate with the object. More...

MsoTextureAlignment	GetTextureAlignment ()
	Returns the texture alignment. More...

double	GetTextureHorizontalScale ()
	Returns the value for horizontally scaling the text. More...

void	SetTextureHorizontalScale (double textureHorizontalScale)
	Sets the value for horizontally scaling the text. More...

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

double	GetTextureOffsetX ()
	Returns the offset X value. More...

void	SetTextureOffsetX (double textureOffsetX)
	Returns the offset X value. More...

double	GetTextureOffsetY ()
	Returns the offset Y value. More...

void	SetTextureOffsetY (double textureOffsetY)
	Returns the offset Y value. More...

MsoTriState	GetTextureTile ()
	The texture tile. More...

void	SetTextureTile (MsoTriState textureTile)
	The texture tile. More...

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

double	GetTextureVerticalScale ()
	The texture vertical scale. More...

void	SetTextureVerticalScale (double textureVerticalScale)
	The texture vertical scale. More...

double	GetTransparency ()
	Returns the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). More...

void	SetTransparency (double transparency)
	Sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). 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 "FillFormat". 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 FillFormat object.

Member Function Documentation

◆ OneColorGradient()

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

Sets the specified fill to a one-color gradient.

MSDN documentation for FillFormat.OneColorGradient.

◆ Patterned()

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

Sets the specified fill to a pattern.

MSDN documentation for FillFormat.Patterned.

◆ PresetGradient()

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

Sets the specified fill to a preset gradient.

MSDN documentation for FillFormat.PresetGradient.

◆ PresetTextured()

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

Sets the specified fill format to a preset texture.

MSDN documentation for FillFormat.PresetTextured.

◆ Solid()

void wxAutoExcel::wxExcelFillFormat::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 FillFormat.Solid.

◆ TwoColorGradient()

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

Sets the specified fill to a two-color gradient.

MSDN documentation for FillFormat.TwoColorGradient.

◆ UserPicture()

void wxAutoExcel::wxExcelFillFormat::UserPicture ( const wxString & pictureFile )

Fills the specified shape with an image.

MSDN documentation for FillFormat.UserPicture.

◆ UserTextured()

void wxAutoExcel::wxExcelFillFormat::UserTextured ( const wxString & pictureFile )

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 FillFormat.UserTextured.

◆ GetBackColor()

wxExcelColorFormat wxAutoExcel::wxExcelFillFormat::GetBackColor ( )

Returns a ColorFormat Represents the specified fill background color.

MSDN documentation for FillFormat.BackColor.

◆ GetForeColor()

wxExcelColorFormat wxAutoExcel::wxExcelFillFormat::GetForeColor ( )

Returns a ColorFormat Represents the specified foreground fill or solid color.

MSDN documentation for FillFormat.ForeColor.

◆ GetGradientColorType()

MsoGradientColorType wxAutoExcel::wxExcelFillFormat::GetGradientColorType ( )

Returns the gradient color type for the specified fill.

Read-only MsoGradientColorType.

MSDN documentation for FillFormat.GradientColorType.

◆ GetGradientDegree()

double wxAutoExcel::wxExcelFillFormat::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 FillFormat.GradientDegree.

◆ GetGradientStyle()

MsoGradientStyle wxAutoExcel::wxExcelFillFormat::GetGradientStyle ( )

Since Excel 2007.

MSDN documentation for FillFormat.GradientStops. Returns the gradient style for the specified fill. Read-only MsoGradientStyle.

MSDN documentation for FillFormat.GradientStyle.

◆ GetGradientVariant()

long wxAutoExcel::wxExcelFillFormat::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 FillFormat.GradientVariant.

◆ GetPattern()

MsoPatternType wxAutoExcel::wxExcelFillFormat::GetPattern ( )

Returns an MsoPatternType value that represents the fill pattern.

MSDN documentation for FillFormat.Pattern.

◆ SetPattern()

void wxAutoExcel::wxExcelFillFormat::SetPattern ( MsoPatternType pattern )

Sets an MsoPatternType value that represents the fill pattern.

MSDN documentation for FillFormat.Pattern.

◆ GetPresetGradientType()

MsoPresetGradientType wxAutoExcel::wxExcelFillFormat::GetPresetGradientType ( )

Returns the preset gradient type for the specified fill.

Read-only MsoPresetGradientType.

MSDN documentation for FillFormat.PresetGradientType.

◆ GetPresetTexture()

MsoPresetTexture wxAutoExcel::wxExcelFillFormat::GetPresetTexture ( )

Returns the preset texture for the specified fill.

Read-only MsoPresetTexture.

MSDN documentation for FillFormat.PresetTexture.

◆ GetRotateWithObject()

MsoTriState wxAutoExcel::wxExcelFillFormat::GetRotateWithObject ( )

Returns if the fill style should rotate with the object.

Since Excel 2007.

MSDN documentation for FillFormat.RotateWithObject.

◆ SetRotateWithObject()

void wxAutoExcel::wxExcelFillFormat::SetRotateWithObject ( MsoTriState rotateWithObject )

Sets if the fill style should rotate with the object.

Since Excel 2007.

MSDN documentation for FillFormat.RotateWithObject.

◆ GetTextureAlignment()

MsoTextureAlignment wxAutoExcel::wxExcelFillFormat::GetTextureAlignment ( )

Returns the texture alignment.

Since Excel 2007.

MSDN documentation for FillFormat.TextureAlignment.

◆ GetTextureHorizontalScale()

double wxAutoExcel::wxExcelFillFormat::GetTextureHorizontalScale ( )

Returns the value for horizontally scaling the text.

Since Excel 2007.

MSDN documentation for FillFormat.TextureHorizontalScale.

◆ SetTextureHorizontalScale()

void wxAutoExcel::wxExcelFillFormat::SetTextureHorizontalScale ( double textureHorizontalScale )

Sets the value for horizontally scaling the text.

Since Excel 2007.

MSDN documentation for FillFormat.TextureHorizontalScale.

◆ GetTextureName()

wxString wxAutoExcel::wxExcelFillFormat::GetTextureName ( )

Returns the name of the custom texture file for the specified fill.

MSDN documentation for FillFormat.TextureName.

◆ GetTextureOffsetX()

double wxAutoExcel::wxExcelFillFormat::GetTextureOffsetX ( )

Returns the offset X value.

Since Excel 2007.

MSDN documentation for FillFormat.TextureOffsetX.

◆ SetTextureOffsetX()

void wxAutoExcel::wxExcelFillFormat::SetTextureOffsetX ( double textureOffsetX )

Returns the offset X value.

Since Excel 2007.

MSDN documentation for FillFormat.TextureOffsetX.

◆ GetTextureOffsetY()

double wxAutoExcel::wxExcelFillFormat::GetTextureOffsetY ( )

Returns the offset Y value.

Since Excel 2007.

MSDN documentation for FillFormat.TextureOffsetY.

◆ SetTextureOffsetY()

void wxAutoExcel::wxExcelFillFormat::SetTextureOffsetY ( double textureOffsetY )

Returns the offset Y value.

Since Excel 2007.

MSDN documentation for FillFormat.TextureOffsetY.

◆ GetTextureTile()

MsoTriState wxAutoExcel::wxExcelFillFormat::GetTextureTile ( )

The texture tile.

Since Excel 2007.

MSDN documentation for FillFormat.TextureTile.

◆ SetTextureTile()

void wxAutoExcel::wxExcelFillFormat::SetTextureTile ( MsoTriState textureTile )

The texture tile.

Since Excel 2007.

MSDN documentation for FillFormat.TextureTile.

◆ GetTextureType()

MsoTextureType wxAutoExcel::wxExcelFillFormat::GetTextureType ( )

Returns the texture type for the specified fill.

Read-only MsoTextureType.

MSDN documentation for FillFormat.TextureType.

◆ GetTextureVerticalScale()

double wxAutoExcel::wxExcelFillFormat::GetTextureVerticalScale ( )

The texture vertical scale.

Since Excel 2007.

MSDN documentation for FillFormat.TextureVerticalScale.

◆ SetTextureVerticalScale()

void wxAutoExcel::wxExcelFillFormat::SetTextureVerticalScale ( double textureVerticalScale )

The texture vertical scale.

Since Excel 2007.

MSDN documentation for FillFormat.TextureVerticalScale.

◆ GetTransparency()

double wxAutoExcel::wxExcelFillFormat::GetTransparency ( )

Returns the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).

MSDN documentation for FillFormat.Transparency.

◆ SetTransparency()

void wxAutoExcel::wxExcelFillFormat::SetTransparency ( double transparency )

Sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).

MSDN documentation for FillFormat.Transparency.

◆ GetType()

MsoFillType wxAutoExcel::wxExcelFillFormat::GetType ( )

Returns a MsoFillType value that represents the the fill type.

MSDN documentation for FillFormat.Type.

◆ GetVisible()

MsoTriState wxAutoExcel::wxExcelFillFormat::GetVisible ( )

Returns a MsoTriState value that determines whether the object is visible.

MSDN documentation for FillFormat.Visible.

◆ SetVisible()

void wxAutoExcel::wxExcelFillFormat::SetVisible ( MsoTriState visible )

Sets a MsoTriState value that determines whether the object is visible.

MSDN documentation for FillFormat.Visible.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "FillFormat".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ OneColorGradient()

◆ Patterned()

◆ PresetGradient()

◆ PresetTextured()

◆ Solid()

◆ TwoColorGradient()

◆ UserPicture()

◆ UserTextured()

◆ GetBackColor()

◆ GetForeColor()

◆ GetGradientColorType()

◆ GetGradientDegree()

◆ GetGradientStyle()

◆ GetGradientVariant()

◆ GetPattern()

◆ SetPattern()

◆ GetPresetGradientType()

◆ GetPresetTexture()

◆ GetRotateWithObject()

◆ SetRotateWithObject()

◆ GetTextureAlignment()

◆ GetTextureHorizontalScale()

◆ SetTextureHorizontalScale()

◆ GetTextureName()

◆ GetTextureOffsetX()

◆ SetTextureOffsetX()

◆ GetTextureOffsetY()

◆ SetTextureOffsetY()

◆ GetTextureTile()

◆ SetTextureTile()

◆ GetTextureType()

◆ GetTextureVerticalScale()

◆ SetTextureVerticalScale()

◆ GetTransparency()

◆ SetTransparency()

◆ GetType()

◆ GetVisible()

◆ SetVisible()

◆ GetAutoExcelObjectName_()