wxAutoExcel  2.0.0
wxAutoExcel::wxExcelChartObjects Class Reference

Represents Microsoft Excel ChartObjects collection. More...

Inheritance diagram for wxAutoExcel::wxExcelChartObjects:
wxAutoExcel::wxExcelObject

Public Member Functions

wxExcelChartObject Add (double left, double top, double width, double height)
 Creates a new embedded chart. More...
 
bool Copy ()
 Copies the object to the Clipboard. More...
 
bool CopyPicture (XlPictureAppearance *appearance, XlCopyPictureFormat *format)
 Copies the selected object to the Clipboard as a picture. More...
 
bool Cut ()
 Cuts the object to the Clipboard. More...
 
bool Delete ()
 Deletes the object. More...
 
wxExcelChartObjects Duplicate ()
 Duplicates the object and returns a reference to the new copy. More...
 
wxExcelChartObject Item (long index)
 Returns a single object from a collection. More...
 
bool Select (wxXlTribool replace)
 Selects the object. More...
 
long GetCount ()
 Returns a Long value that represents the number of objects in the collection. More...
 
bool GetEnabled ()
 True if the object is enabled. More...
 
void SetEnabled (bool enabled)
 True if the object is enabled. More...
 
double GetHeight ()
 Returns a Double value that represents the height, in points, of the object. More...
 
void SetHeight (double height)
 Sets a Double value that represents the height, in points, of the object. More...
 
double GetLeft ()
 Returns a Double value that represents the distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart). More...
 
void SetLeft (double left)
 Sets a Double value that represents the distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart). More...
 
bool GetProtectChartObject ()
 True if the embedded chart frame cannot be moved, resized, or deleted through the user interface. More...
 
void SetProtectChartObject (bool protectChartObject)
 True if the embedded chart frame cannot be moved, resized, or deleted through the user interface. More...
 
wxExcelShapeRange GetShapeRange ()
 Returns a ShapeRange object that represents the specified object or objects. More...
 
double GetTop ()
 Returns a Double value that represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart). More...
 
void SetTop (double top)
 Sets a Double value that represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart). More...
 
bool GetVisible ()
 Returns a Boolean value that determines whether the object is visible. More...
 
void SetVisible (bool visible)
 Sets a Boolean value that determines whether the object is visible. More...
 
double GetWidth ()
 Returns a Double value that represents the width, in points, of the object. More...
 
void SetWidth (double width)
 Sets a Double value that represents the width, in points, of the object. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "ChartObjects". 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 ChartObjects collection.

Member Function Documentation

◆ Add()

wxExcelChartObject wxAutoExcel::wxExcelChartObjects::Add ( double  left,
double  top,
double  width,
double  height 
)

Creates a new embedded chart.

MSDN documentation for ChartObjects.Add.

◆ Copy()

bool wxAutoExcel::wxExcelChartObjects::Copy ( )

Copies the object to the Clipboard.

MSDN documentation for ChartObjects.Copy.

◆ CopyPicture()

bool wxAutoExcel::wxExcelChartObjects::CopyPicture ( XlPictureAppearance appearance,
XlCopyPictureFormat format 
)

Copies the selected object to the Clipboard as a picture.

Variant.

MSDN documentation for ChartObjects.CopyPicture.

◆ Cut()

bool wxAutoExcel::wxExcelChartObjects::Cut ( )

Cuts the object to the Clipboard.

MSDN documentation for ChartObjects.Cut.

◆ Delete()

bool wxAutoExcel::wxExcelChartObjects::Delete ( )

◆ Duplicate()

wxExcelChartObjects wxAutoExcel::wxExcelChartObjects::Duplicate ( )

Duplicates the object and returns a reference to the new copy.

MSDN documentation for ChartObjects.Duplicate.

◆ Item()

wxExcelChartObject wxAutoExcel::wxExcelChartObjects::Item ( long  index)

Returns a single object from a collection.

MSDN documentation for ChartObjects.Item.

◆ Select()

bool wxAutoExcel::wxExcelChartObjects::Select ( wxXlTribool  replace)

◆ GetCount()

long wxAutoExcel::wxExcelChartObjects::GetCount ( )

Returns a Long value that represents the number of objects in the collection.

MSDN documentation for ChartObjects.Count.

◆ GetEnabled()

bool wxAutoExcel::wxExcelChartObjects::GetEnabled ( )

True if the object is enabled.

MSDN documentation for ChartObjects.Enabled.

◆ SetEnabled()

void wxAutoExcel::wxExcelChartObjects::SetEnabled ( bool  enabled)

True if the object is enabled.

MSDN documentation for ChartObjects.Enabled.

◆ GetHeight()

double wxAutoExcel::wxExcelChartObjects::GetHeight ( )

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

MSDN documentation for ChartObjects.Height.

◆ SetHeight()

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

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

MSDN documentation for ChartObjects.Height.

◆ GetLeft()

double wxAutoExcel::wxExcelChartObjects::GetLeft ( )

Returns a Double value that represents the distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

MSDN documentation for ChartObjects.Left.

◆ SetLeft()

void wxAutoExcel::wxExcelChartObjects::SetLeft ( double  left)

Sets a Double value that represents the distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

MSDN documentation for ChartObjects.Left.

◆ GetProtectChartObject()

bool wxAutoExcel::wxExcelChartObjects::GetProtectChartObject ( )

True if the embedded chart frame cannot be moved, resized, or deleted through the user interface.

Since Excel 2007.

MSDN documentation for ChartObjects.ProtectChartObject.

◆ SetProtectChartObject()

void wxAutoExcel::wxExcelChartObjects::SetProtectChartObject ( bool  protectChartObject)

True if the embedded chart frame cannot be moved, resized, or deleted through the user interface.

Since Excel 2007.

MSDN documentation for ChartObjects.ProtectChartObject.

◆ GetShapeRange()

wxExcelShapeRange wxAutoExcel::wxExcelChartObjects::GetShapeRange ( )

Returns a ShapeRange object that represents the specified object or objects.

MSDN documentation for ChartObjects.ShapeRange.

◆ GetTop()

double wxAutoExcel::wxExcelChartObjects::GetTop ( )

Returns a Double value that represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

MSDN documentation for ChartObjects.Top.

◆ SetTop()

void wxAutoExcel::wxExcelChartObjects::SetTop ( double  top)

Sets a Double value that represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

MSDN documentation for ChartObjects.Top.

◆ GetVisible()

bool wxAutoExcel::wxExcelChartObjects::GetVisible ( )

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

MSDN documentation for ChartObjects.Visible.

◆ SetVisible()

void wxAutoExcel::wxExcelChartObjects::SetVisible ( bool  visible)

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

MSDN documentation for ChartObjects.Visible.

◆ GetWidth()

double wxAutoExcel::wxExcelChartObjects::GetWidth ( )

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

MSDN documentation for ChartObjects.Width.

◆ SetWidth()

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

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

MSDN documentation for ChartObjects.Width.

◆ GetAutoExcelObjectName_()

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

Returns "ChartObjects".

Reimplemented from wxAutoExcel::wxExcelObject.