wxAutoExcel  2.0.0
wxAutoExcel::wxExcelGraphic Class Reference

Represents Microsoft Excel Graphic object. More...

Inheritance diagram for wxAutoExcel::wxExcelGraphic:
wxAutoExcel::wxExcelObject

Public Member Functions

double GetBrightness ()
 Returns the brightness of the specified picture or OLE object. More...
 
void SetBrightness (double brightness)
 Sets the brightness of the specified picture or OLE object. More...
 
MsoPictureColorType GetColorType ()
 Returns the type of color transformation applied to the specified picture or OLE object. More...
 
void SetColorType (MsoPictureColorType colorType)
 Sets the type of color transformation applied to the specified picture or OLE object. More...
 
double GetContrast ()
 Returns the contrast for the specified picture or OLE object. More...
 
void SetContrast (double contrast)
 Sets the contrast for the specified picture or OLE object. More...
 
double GetCropBottom ()
 Returns the number of points that are cropped off the bottom of the specified picture or OLE object. More...
 
void SetCropBottom (double cropBottom)
 Sets the number of points that are cropped off the bottom of the specified picture or OLE object. More...
 
double GetCropLeft ()
 Returns the number of points that are cropped off the left side of the specified picture or OLE object. More...
 
void SetCropLeft (double cropLeft)
 Sets the number of points that are cropped off the left side of the specified picture or OLE object. More...
 
double GetCropRight ()
 Returns the number of points that are cropped off the right side of the specified picture or OLE object. More...
 
void SetCropRight (double cropRight)
 Sets the number of points that are cropped off the right side of the specified picture or OLE object. More...
 
double GetCropTop ()
 Returns the number of points that are cropped off the top of the specified picture or OLE object. More...
 
void SetCropTop (double cropTop)
 Sets the number of points that are cropped off the top of the specified picture or OLE object. More...
 
wxString GetFilename ()
 Returns the URL (on the intranet or the Web) or path (local or network) to the location where the specified source object was saved. More...
 
void SetFilename (const wxString &filename)
 Sets the URL (on the intranet or the Web) or path (local or network) to the location where the specified source object was saved. More...
 
double GetHeight ()
 Returns a Single value that represents the height, in points, of the object. More...
 
void SetHeight (double height)
 Sets a Single value that represents the height, in points, of the object. More...
 
MsoTriState GetLockAspectRatio ()
 True if the specified shape retains its original proportions when you resize it. More...
 
void SetLockAspectRatio (MsoTriState lockAspectRatio)
 True if the specified shape retains its original proportions when you resize it. More...
 
double GetWidth ()
 Returns a Single value that represents the width, in points, of the object. More...
 
void SetWidth (double width)
 Sets a Single value that represents the width, in points, of the object. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "Graphic". 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 Graphic object.

Member Function Documentation

◆ GetBrightness()

double wxAutoExcel::wxExcelGraphic::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 Graphic.Brightness.

◆ SetBrightness()

void wxAutoExcel::wxExcelGraphic::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 Graphic.Brightness.

◆ GetColorType()

MsoPictureColorType wxAutoExcel::wxExcelGraphic::GetColorType ( )

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

Read/write MsoPictureColorType.

MSDN documentation for Graphic.ColorType.

◆ SetColorType()

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

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

Read/write MsoPictureColorType.

MSDN documentation for Graphic.ColorType.

◆ GetContrast()

double wxAutoExcel::wxExcelGraphic::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 Graphic.Contrast.

◆ SetContrast()

void wxAutoExcel::wxExcelGraphic::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 Graphic.Contrast.

◆ GetCropBottom()

double wxAutoExcel::wxExcelGraphic::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 Graphic.CropBottom.

◆ SetCropBottom()

void wxAutoExcel::wxExcelGraphic::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 Graphic.CropBottom.

◆ GetCropLeft()

double wxAutoExcel::wxExcelGraphic::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 Graphic.CropLeft.

◆ SetCropLeft()

void wxAutoExcel::wxExcelGraphic::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 Graphic.CropLeft.

◆ GetCropRight()

double wxAutoExcel::wxExcelGraphic::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 Graphic.CropRight.

◆ SetCropRight()

void wxAutoExcel::wxExcelGraphic::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 Graphic.CropRight.

◆ GetCropTop()

double wxAutoExcel::wxExcelGraphic::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 Graphic.CropTop.

◆ SetCropTop()

void wxAutoExcel::wxExcelGraphic::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 Graphic.CropTop.

◆ GetFilename()

wxString wxAutoExcel::wxExcelGraphic::GetFilename ( )

Returns the URL (on the intranet or the Web) or path (local or network) to the location where the specified source object was saved.

MSDN documentation for Graphic.Filename.

◆ SetFilename()

void wxAutoExcel::wxExcelGraphic::SetFilename ( const wxString &  filename)

Sets the URL (on the intranet or the Web) or path (local or network) to the location where the specified source object was saved.

MSDN documentation for Graphic.Filename.

◆ GetHeight()

double wxAutoExcel::wxExcelGraphic::GetHeight ( )

Returns a Single value that represents the height, in points, of the object.

MSDN documentation for Graphic.Height.

◆ SetHeight()

void wxAutoExcel::wxExcelGraphic::SetHeight ( double  height)

Sets a Single value that represents the height, in points, of the object.

MSDN documentation for Graphic.Height.

◆ GetLockAspectRatio()

MsoTriState wxAutoExcel::wxExcelGraphic::GetLockAspectRatio ( )

True if the specified shape retains its original proportions when you resize it.

False if you can change the height and width of the shape independently of one another when you resize it. Read/write MsoTriState.

MSDN documentation for Graphic.LockAspectRatio.

◆ SetLockAspectRatio()

void wxAutoExcel::wxExcelGraphic::SetLockAspectRatio ( MsoTriState  lockAspectRatio)

True if the specified shape retains its original proportions when you resize it.

False if you can change the height and width of the shape independently of one another when you resize it. Read/write MsoTriState.

MSDN documentation for Graphic.LockAspectRatio.

◆ GetWidth()

double wxAutoExcel::wxExcelGraphic::GetWidth ( )

Returns a Single value that represents the width, in points, of the object.

MSDN documentation for Graphic.Width.

◆ SetWidth()

void wxAutoExcel::wxExcelGraphic::SetWidth ( double  width)

Sets a Single value that represents the width, in points, of the object.

MSDN documentation for Graphic.Width.

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelGraphic::GetAutoExcelObjectName_ ( ) const
inlinevirtual

Returns "Graphic".

Reimplemented from wxAutoExcel::wxExcelObject.