wxAutoExcel  2.0.0
wxAutoExcel::wxExcelIconSets Class Reference

Represents a Microsoft Excel IconSets collection. More...

Inheritance diagram for wxAutoExcel::wxExcelIconSets:
wxAutoExcel::wxExcelObject

Public Member Functions

void Delete ()
 Deletes the specified conditional formatting rule object. More...
 
void ModifyAppliesToRange (wxExcelRange range)
 Sets the cell range to which this formatting rule applies. More...
 
void SetFirstPriority ()
 Sets the priority value for this conditional formatting rule to "1" so that it will be evaluated before all other rules on the worksheet. More...
 
void SetLastPriority ()
 Sets the evaluation order for this conditional formatting rule so it is evaluated after all other rules on the worksheet. More...
 
long GetCount ()
 Returns a Long value which specifies the number of icon sets available in the workbook. More...
 
wxExcelIconSet GetItem (long index)
 Returns a single IconSet object from the IconSets collection. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "IconSets". 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 a Microsoft Excel IconSets collection.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelIconSets::Delete ( )

Deletes the specified conditional formatting rule object.

[MSDN documentation for IconSets.Delete]().

◆ ModifyAppliesToRange()

void wxAutoExcel::wxExcelIconSets::ModifyAppliesToRange ( wxExcelRange  range)

Sets the cell range to which this formatting rule applies.

[MSDN documentation for IconSets.ModifyAppliesToRange]().

◆ SetFirstPriority()

void wxAutoExcel::wxExcelIconSets::SetFirstPriority ( )

Sets the priority value for this conditional formatting rule to "1" so that it will be evaluated before all other rules on the worksheet.

[MSDN documentation for IconSets.SetFirstPriority]().

◆ SetLastPriority()

void wxAutoExcel::wxExcelIconSets::SetLastPriority ( )

Sets the evaluation order for this conditional formatting rule so it is evaluated after all other rules on the worksheet.

[MSDN documentation for IconSets.SetLastPriority]().

◆ GetCount()

long wxAutoExcel::wxExcelIconSets::GetCount ( )

Returns a Long value which specifies the number of icon sets available in the workbook.

Since Excel 2007.

MSDN documentation for IconSets.Count.

◆ GetItem()

wxExcelIconSet wxAutoExcel::wxExcelIconSets::GetItem ( long  index)

Returns a single IconSet object from the IconSets collection.

Since Excel 2007.

MSDN documentation for IconSets.Item.

◆ GetAutoExcelObjectName_()

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

Returns "IconSets".

Reimplemented from wxAutoExcel::wxExcelObject.