wxAutoExcel  2.0.0
wxAutoExcel::wxExcelDataTable Class Reference

Represents Microsoft Excel DataTable object. More...

Inheritance diagram for wxAutoExcel::wxExcelDataTable:
wxAutoExcel::wxExcelObject

Public Member Functions

void Delete ()
 Deletes the object. More...
 
void Select ()
 Selects the object. More...
 
wxExcelBorder GetBorder ()
 Returns a Border object that represents the border of the object. More...
 
wxExcelFont GetFont ()
 Returns a Font object that represents the font of the specified object. More...
 
wxExcelChartFormat GetFormat ()
 Returns the ChartFormat object. More...
 
bool GetHasBorderHorizontal ()
 True if the chart data table has horizontal cell borders. More...
 
void SetHasBorderHorizontal (bool hasBorderHorizontal)
 True if the chart data table has horizontal cell borders. More...
 
bool GetHasBorderOutline ()
 True if the chart data table has outline borders. More...
 
void SetHasBorderOutline (bool hasBorderOutline)
 True if the chart data table has outline borders. More...
 
bool GetHasBorderVertical ()
 True if the chart data table has vertical cell borders. More...
 
void SetHasBorderVertical (bool hasBorderVertical)
 True if the chart data table has vertical cell borders. More...
 
bool GetShowLegendKey ()
 True if the data label legend key is visible. More...
 
void SetShowLegendKey (bool showLegendKey)
 True if the data label legend key is visible. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "DataTable". 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 DataTable object.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelDataTable::Delete ( )

◆ Select()

void wxAutoExcel::wxExcelDataTable::Select ( )

◆ GetBorder()

wxExcelBorder wxAutoExcel::wxExcelDataTable::GetBorder ( )

Returns a Border object that represents the border of the object.

[MSDN documentation for DataTable.Border]().

◆ GetFont()

wxExcelFont wxAutoExcel::wxExcelDataTable::GetFont ( )

Returns a Font object that represents the font of the specified object.

MSDN documentation for DataTable.Font.

◆ GetFormat()

wxExcelChartFormat wxAutoExcel::wxExcelDataTable::GetFormat ( )

Returns the ChartFormat object.

Since Excel 2007.

MSDN documentation for DataTable.Format.

◆ GetHasBorderHorizontal()

bool wxAutoExcel::wxExcelDataTable::GetHasBorderHorizontal ( )

True if the chart data table has horizontal cell borders.

MSDN documentation for DataTable.HasBorderHorizontal.

◆ SetHasBorderHorizontal()

void wxAutoExcel::wxExcelDataTable::SetHasBorderHorizontal ( bool  hasBorderHorizontal)

True if the chart data table has horizontal cell borders.

MSDN documentation for DataTable.HasBorderHorizontal.

◆ GetHasBorderOutline()

bool wxAutoExcel::wxExcelDataTable::GetHasBorderOutline ( )

True if the chart data table has outline borders.

MSDN documentation for DataTable.HasBorderOutline.

◆ SetHasBorderOutline()

void wxAutoExcel::wxExcelDataTable::SetHasBorderOutline ( bool  hasBorderOutline)

True if the chart data table has outline borders.

MSDN documentation for DataTable.HasBorderOutline.

◆ GetHasBorderVertical()

bool wxAutoExcel::wxExcelDataTable::GetHasBorderVertical ( )

True if the chart data table has vertical cell borders.

MSDN documentation for DataTable.HasBorderVertical.

◆ SetHasBorderVertical()

void wxAutoExcel::wxExcelDataTable::SetHasBorderVertical ( bool  hasBorderVertical)

True if the chart data table has vertical cell borders.

MSDN documentation for DataTable.HasBorderVertical.

◆ GetShowLegendKey()

bool wxAutoExcel::wxExcelDataTable::GetShowLegendKey ( )

True if the data label legend key is visible.

MSDN documentation for DataTable.ShowLegendKey.

◆ SetShowLegendKey()

void wxAutoExcel::wxExcelDataTable::SetShowLegendKey ( bool  showLegendKey)

True if the data label legend key is visible.

MSDN documentation for DataTable.ShowLegendKey.

◆ GetAutoExcelObjectName_()

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

Returns "DataTable".

Reimplemented from wxAutoExcel::wxExcelObject.