wxAutoExcel  2.0.0
wxAutoExcel::wxExcelListColumn Class Reference

Represents a column in a table, a member of ListColumns collection. More...

Inheritance diagram for wxAutoExcel::wxExcelListColumn:
wxAutoExcel::wxExcelObject

Public Member Functions

void Delete ()
 Deletes the column of data in the list. More...
 
wxExcelRange GetDataBodyRange ()
 Returns a Range object that is the size of the data portion of a column. More...
 
long GetIndex ()
 Returns a Long value that represents the index number of the ListColumn object within the ListColumns collection. More...
 
wxString GetName ()
 Returns a String value that represents the name of the list column. More...
 
void SetName (const wxString &name)
 Sets a String value that represents the name of the list column. More...
 
wxExcelRange GetRange ()
 Returns a Range object that represents the range to which the specified list object in the above list applies. More...
 
wxExcelRange GetTotal ()
 Returns the Total row for a ListColumn object. More...
 
XlTotalsCalculation GetTotalsCalculation ()
 Determines the type of calculation in the Totals row of the list column based on the value of the XlTotalsCalculation enumeration. More...
 
void SetTotalsCalculation (XlTotalsCalculation totalsCalculation)
 Determines the type of calculation in the Totals row of the list column based on the value of the XlTotalsCalculation enumeration. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "ListColumn". 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 column in a table, a member of ListColumns collection.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelListColumn::Delete ( )

Deletes the column of data in the list.

MSDN documentation for ListColumn.Delete

◆ GetDataBodyRange()

wxExcelRange wxAutoExcel::wxExcelListColumn::GetDataBodyRange ( )

Returns a Range object that is the size of the data portion of a column.

MSDN documentation for ListColumn.DataBodyRange

◆ GetIndex()

long wxAutoExcel::wxExcelListColumn::GetIndex ( )

Returns a Long value that represents the index number of the ListColumn object within the ListColumns collection.

MSDN documentation for ListColumn.Index

◆ GetName()

wxString wxAutoExcel::wxExcelListColumn::GetName ( )

Returns a String value that represents the name of the list column.

MSDN documentation for ListColumn.Name

◆ SetName()

void wxAutoExcel::wxExcelListColumn::SetName ( const wxString &  name)

Sets a String value that represents the name of the list column.

MSDN documentation for ListColumn.Name

◆ GetRange()

wxExcelRange wxAutoExcel::wxExcelListColumn::GetRange ( )

Returns a Range object that represents the range to which the specified list object in the above list applies.

MSDN documentation for ListColumn.Range

◆ GetTotal()

wxExcelRange wxAutoExcel::wxExcelListColumn::GetTotal ( )

Returns the Total row for a ListColumn object.

MSDN documentation for ListColumn.Total

◆ GetTotalsCalculation()

XlTotalsCalculation wxAutoExcel::wxExcelListColumn::GetTotalsCalculation ( )

Determines the type of calculation in the Totals row of the list column based on the value of the XlTotalsCalculation enumeration.

MSDN documentation for ListColumn.TotalsCalculation

◆ SetTotalsCalculation()

void wxAutoExcel::wxExcelListColumn::SetTotalsCalculation ( XlTotalsCalculation  totalsCalculation)

Determines the type of calculation in the Totals row of the list column based on the value of the XlTotalsCalculation enumeration.

MSDN documentation for ListColumn.TotalsCalculation.

◆ GetAutoExcelObjectName_()

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

Returns "ListColumn".

Reimplemented from wxAutoExcel::wxExcelObject.