wxAutoExcel  2.0.0
wxAutoExcel::wxExcelSparklineGroups Class Reference

Represents Microsoft Excel SparklineGroups collection. More...

Inheritance diagram for wxAutoExcel::wxExcelSparklineGroups:
wxAutoExcel::wxExcelObject

Public Member Functions

wxExcelSparklineGroup Add (XlSparkType sparkType, const wxString &sourceData)
 Creates a new sparkline group and returns a SparklineGroup object. More...
 
void Clear ()
 Clears the selected sparklines. More...
 
void ClearGroups ()
 Clears the selected sparkline groups. More...
 
void Group (wxExcelRange location)
 Groups the selected sparklines. More...
 
void Ungroup ()
 Ungroups the sparklines in the selected sparkline group. More...
 
long GetCount ()
 Returns the count of sparkline groups in the associated Range object. More...
 
wxExcelSparklineGroup GetItem (long index)
 Returns a SparklineGroup object from a collection. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "SparklineGroups". 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 SparklineGroups collection.

Since Excel 2010.

Member Function Documentation

◆ Add()

wxExcelSparklineGroup wxAutoExcel::wxExcelSparklineGroups::Add ( XlSparkType  sparkType,
const wxString &  sourceData 
)

Creates a new sparkline group and returns a SparklineGroup object.

MSDN documentation for SparklineGroups.Add.

◆ Clear()

void wxAutoExcel::wxExcelSparklineGroups::Clear ( )

Clears the selected sparklines.

MSDN documentation for SparklineGroups.Clear.

◆ ClearGroups()

void wxAutoExcel::wxExcelSparklineGroups::ClearGroups ( )

Clears the selected sparkline groups.

MSDN documentation for SparklineGroups.ClearGroups.

◆ Group()

void wxAutoExcel::wxExcelSparklineGroups::Group ( wxExcelRange  location)

Groups the selected sparklines.

MSDN documentation for SparklineGroups.Group.

◆ Ungroup()

void wxAutoExcel::wxExcelSparklineGroups::Ungroup ( )

Ungroups the sparklines in the selected sparkline group.

MSDN documentation for SparklineGroups.Ungroup.

◆ GetCount()

long wxAutoExcel::wxExcelSparklineGroups::GetCount ( )

Returns the count of sparkline groups in the associated Range object.

MSDN documentation for SparklineGroups.Count.

◆ GetItem()

wxExcelSparklineGroup wxAutoExcel::wxExcelSparklineGroups::GetItem ( long  index)

Returns a SparklineGroup object from a collection.

MSDN documentation for SparklineGroups.Item.

◆ GetAutoExcelObjectName_()

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

Returns "SparklineGroups".

Reimplemented from wxAutoExcel::wxExcelObject.