Represents Microsoft Excel PictureFormat object. More...

#include <wxAutoExcelPictureFormat.h>

Inheritance diagram for wxAutoExcel::wxExcelPictureFormat:

Public Member Functions
void	IncrementBrightness (double increment)
	Changes the brightness of the picture by the specified amount.

void	IncrementContrast (double increment)
	Changes the contrast of the picture by the specified amount.

double	GetBrightness ()
	Returns the brightness of the specified picture or OLE object.

void	SetBrightness (double brightness)
	Sets the brightness of the specified picture or OLE object.

MsoPictureColorType	GetColorType ()
	Returns the type of color transformation applied to the specified picture or OLE object.

void	SetColorType (MsoPictureColorType colorType)
	Sets the type of color transformation applied to the specified picture or OLE object.

double	GetContrast ()
	Returns the contrast for the specified picture or OLE object.

void	SetContrast (double contrast)
	Sets the contrast for the specified picture or OLE object.

double	GetCropBottom ()
	Returns the number of points that are cropped off the bottom of the specified picture or OLE object.

void	SetCropBottom (double cropBottom)
	Sets the number of points that are cropped off the bottom of the specified picture or OLE object.

double	GetCropLeft ()
	Returns the number of points that are cropped off the left side of the specified picture or OLE object.

void	SetCropLeft (double cropLeft)
	Sets the number of points that are cropped off the left side of the specified picture or OLE object.

double	GetCropRight ()
	Returns the number of points that are cropped off the right side of the specified picture or OLE object.

void	SetCropRight (double cropRight)
	Sets the number of points that are cropped off the right side of the specified picture or OLE object.

double	GetCropTop ()
	Returns the number of points that are cropped off the top of the specified picture or OLE object.

void	SetCropTop (double cropTop)
	Sets the number of points that are cropped off the top of the specified picture or OLE object.

wxColour	GetTransparencyColor ()
	Returns the transparent color for the specified picture as a red-green-blue (RGB) value.

void	SetTransparencyColor (const wxColour &transparencyColor)
	Sets the transparent color for the specified picture as a red-green-blue (RGB) value.

MsoTriState	GetTransparentBackground ()
	Use the TransparencyColor property to set the transparent color.

void	SetTransparentBackground (MsoTriState transparentBackground)
	Use the TransparencyColor property to set the transparent color.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "PictureFormat".

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

Member Function Documentation

◆ IncrementBrightness()

void wxAutoExcel::wxExcelPictureFormat::IncrementBrightness ( double increment )

Changes the brightness of the picture by the specified amount.

Use the Brightness property to set the absolute brightness of the picture.

MSDN documentation for PictureFormat.IncrementBrightness.

◆ IncrementContrast()

void wxAutoExcel::wxExcelPictureFormat::IncrementContrast ( double increment )

Changes the contrast of the picture by the specified amount.

Use the Contrast property to set the absolute contrast for the picture.

MSDN documentation for PictureFormat.IncrementContrast.

◆ GetBrightness()

double wxAutoExcel::wxExcelPictureFormat::GetBrightness ( )

Returns the brightness of the specified picture or OLE object.

The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest). Read/write Single.

MSDN documentation for PictureFormat.Brightness.

◆ SetBrightness()

void wxAutoExcel::wxExcelPictureFormat::SetBrightness ( double brightness )

Sets the brightness of the specified picture or OLE object.

The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest). Read/write Single.

MSDN documentation for PictureFormat.Brightness.

◆ GetColorType()

MsoPictureColorType wxAutoExcel::wxExcelPictureFormat::GetColorType ( )

Returns the type of color transformation applied to the specified picture or OLE object.

Read/write MsoPictureColorType.

MSDN documentation for PictureFormat.ColorType.

◆ SetColorType()

void wxAutoExcel::wxExcelPictureFormat::SetColorType ( MsoPictureColorType colorType )

Sets the type of color transformation applied to the specified picture or OLE object.

Read/write MsoPictureColorType.

MSDN documentation for PictureFormat.ColorType.

◆ GetContrast()

double wxAutoExcel::wxExcelPictureFormat::GetContrast ( )

Returns the contrast for the specified picture or OLE object.

The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast). Read/write Single.

MSDN documentation for PictureFormat.Contrast.

◆ SetContrast()

void wxAutoExcel::wxExcelPictureFormat::SetContrast ( double contrast )

Sets the contrast for the specified picture or OLE object.

The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast). Read/write Single.

MSDN documentation for PictureFormat.Contrast.

◆ GetCropBottom()

double wxAutoExcel::wxExcelPictureFormat::GetCropBottom ( )

Returns the number of points that are cropped off the bottom of the specified picture or OLE object.

Read/write Single.

MSDN documentation for PictureFormat.CropBottom.

◆ SetCropBottom()

void wxAutoExcel::wxExcelPictureFormat::SetCropBottom ( double cropBottom )

Sets the number of points that are cropped off the bottom of the specified picture or OLE object.

Read/write Single.

MSDN documentation for PictureFormat.CropBottom.

◆ GetCropLeft()

double wxAutoExcel::wxExcelPictureFormat::GetCropLeft ( )

Returns the number of points that are cropped off the left side of the specified picture or OLE object.

Read/write Single.

MSDN documentation for PictureFormat.CropLeft.

◆ SetCropLeft()

void wxAutoExcel::wxExcelPictureFormat::SetCropLeft ( double cropLeft )

Sets the number of points that are cropped off the left side of the specified picture or OLE object.

Read/write Single.

MSDN documentation for PictureFormat.CropLeft.

◆ GetCropRight()

double wxAutoExcel::wxExcelPictureFormat::GetCropRight ( )

Returns the number of points that are cropped off the right side of the specified picture or OLE object.

Read/write Single.

MSDN documentation for PictureFormat.CropRight.

◆ SetCropRight()

void wxAutoExcel::wxExcelPictureFormat::SetCropRight ( double cropRight )

Sets the number of points that are cropped off the right side of the specified picture or OLE object.

Read/write Single.

MSDN documentation for PictureFormat.CropRight.

◆ GetCropTop()

double wxAutoExcel::wxExcelPictureFormat::GetCropTop ( )

Returns the number of points that are cropped off the top of the specified picture or OLE object.

Read/write Single.

MSDN documentation for PictureFormat.CropTop.

◆ SetCropTop()

void wxAutoExcel::wxExcelPictureFormat::SetCropTop ( double cropTop )

Sets the number of points that are cropped off the top of the specified picture or OLE object.

Read/write Single.

MSDN documentation for PictureFormat.CropTop.

◆ GetTransparencyColor()

wxColour wxAutoExcel::wxExcelPictureFormat::GetTransparencyColor ( )

Returns the transparent color for the specified picture as a red-green-blue (RGB) value.

For this property to take effect, the TransparentBackground property must be set to True. Applies to bitmaps only.

MSDN documentation for PictureFormat.TransparencyColor.

◆ SetTransparencyColor()

void wxAutoExcel::wxExcelPictureFormat::SetTransparencyColor ( const wxColour & transparencyColor )

Sets the transparent color for the specified picture as a red-green-blue (RGB) value.

For this property to take effect, the TransparentBackground property must be set to True. Applies to bitmaps only.

MSDN documentation for PictureFormat.TransparencyColor.

◆ GetTransparentBackground()

MsoTriState wxAutoExcel::wxExcelPictureFormat::GetTransparentBackground ( )

Use the TransparencyColor property to set the transparent color.

Applies to bitmaps only. Read/write MsoTriState.

MSDN documentation for PictureFormat.TransparentBackground.

◆ SetTransparentBackground()

void wxAutoExcel::wxExcelPictureFormat::SetTransparentBackground ( MsoTriState transparentBackground )

Use the TransparencyColor property to set the transparent color.

Applies to bitmaps only. Read/write MsoTriState.

MSDN documentation for PictureFormat.TransparentBackground.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "PictureFormat".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ IncrementBrightness()

◆ IncrementContrast()

◆ GetBrightness()

◆ SetBrightness()

◆ GetColorType()

◆ SetColorType()

◆ GetContrast()

◆ SetContrast()

◆ GetCropBottom()

◆ SetCropBottom()

◆ GetCropLeft()

◆ SetCropLeft()

◆ GetCropRight()

◆ SetCropRight()

◆ GetCropTop()

◆ SetCropTop()

◆ GetTransparencyColor()

◆ SetTransparencyColor()

◆ GetTransparentBackground()

◆ SetTransparentBackground()

◆ GetAutoExcelObjectName_()