wxAutoExcel  2.0.0
wxAutoExcel::wxExcelSparkPoints Class Reference

Represents Microsoft Excel SparkPoints object. More...

Inheritance diagram for wxAutoExcel::wxExcelSparkPoints:
wxAutoExcel::wxExcelObject

Public Member Functions

wxExcelSparkColor GetFirstpoint ()
 Returns a SparkColor object that represents the color and visibility of the marker for the first point of data on a sparkline. More...
 
wxExcelSparkColor GetHighpoint ()
 Returns a SparkColor object that represents the color and visibility of the marker for the highest point of data on a sparkline. More...
 
wxExcelSparkColor GetLastpoint ()
 Returns a SparkColor object that represents the color and visibility of the marker for the last point of data on a sparkline. More...
 
wxExcelSparkColor GetLowpoint ()
 Returns a SparkColor object that represents the color and visibility of the marker for the lowest point of data on a sparkline. More...
 
wxExcelSparkColor GetMarkers ()
 Returns a SparkColor object that represents the color and visibility of markers for positive points of data on a sparkline. More...
 
wxExcelSparkColor GetNegative ()
 Returns a SparkColor object that represents the color and visibility of markers for negative points of data on a sparkline. More...
 
wxExcelSparklineGroup GetParent ()
 Returns the parent SparklineGroup object for the specified object. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "SparkPoints". 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 SparkPoints object.

Since Excel 2010.

Member Function Documentation

◆ GetFirstpoint()

wxExcelSparkColor wxAutoExcel::wxExcelSparkPoints::GetFirstpoint ( )

Returns a SparkColor object that represents the color and visibility of the marker for the first point of data on a sparkline.

Read-only Since Excel 2007.

MSDN documentation for SparkPoints.Firstpoint.

◆ GetHighpoint()

wxExcelSparkColor wxAutoExcel::wxExcelSparkPoints::GetHighpoint ( )

Returns a SparkColor object that represents the color and visibility of the marker for the highest point of data on a sparkline.

Read-only Since Excel 2007.

MSDN documentation for SparkPoints.Highpoint.

◆ GetLastpoint()

wxExcelSparkColor wxAutoExcel::wxExcelSparkPoints::GetLastpoint ( )

Returns a SparkColor object that represents the color and visibility of the marker for the last point of data on a sparkline.

Read-only Since Excel 2007.

MSDN documentation for SparkPoints.Lastpoint.

◆ GetLowpoint()

wxExcelSparkColor wxAutoExcel::wxExcelSparkPoints::GetLowpoint ( )

Returns a SparkColor object that represents the color and visibility of the marker for the lowest point of data on a sparkline.

Read-only Since Excel 2007.

MSDN documentation for SparkPoints.Lowpoint.

◆ GetMarkers()

wxExcelSparkColor wxAutoExcel::wxExcelSparkPoints::GetMarkers ( )

Returns a SparkColor object that represents the color and visibility of markers for positive points of data on a sparkline.

Read-only Since Excel 2007.

MSDN documentation for SparkPoints.Markers.

◆ GetNegative()

wxExcelSparkColor wxAutoExcel::wxExcelSparkPoints::GetNegative ( )

Returns a SparkColor object that represents the color and visibility of markers for negative points of data on a sparkline.

Read-only Since Excel 2007.

MSDN documentation for SparkPoints.Negative.

◆ GetParent()

wxExcelSparklineGroup wxAutoExcel::wxExcelSparkPoints::GetParent ( )

Returns the parent SparklineGroup object for the specified object.

Since Excel 2007.

MSDN documentation for SparkPoints.Parent.

◆ GetAutoExcelObjectName_()

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

Returns "SparkPoints".

Reimplemented from wxAutoExcel::wxExcelObject.