Represents a single style that can be applied to a table or slicer. More...

#include <wxAutoExcelTableStyle.h>

Inheritance diagram for wxAutoExcel::wxExcelTableStyle:

Public Member Functions
void	Delete ()
	Deletes the TableStyle object.

wxExcelTableStyle	Duplicate (const wxString &newTableStyleName=wxEmptyString)
	Duplicates the TableStyle object and returns the copy.

bool	GetBuiltIn ()
	True if the style is a built-in style.

wxString	GetName ()
	Returns the name of the object.

wxString	GetNameLocal ()
	Returns the name of the object, in the language of the user.

bool	GetShowAsAvailablePivotTableStyle ()
	Returns if a style is shown in the gallery for PivotTable styles or not.

void	SetShowAsAvailablePivotTableStyle (bool showAsAvailablePivotTableStyle)
	Sets if a style is shown in the gallery for PivotTable styles or not.

bool	GetShowAsAvailableSlicerStyle ()
	Returns if the specified table style is shown as available in the slicer styles gallery.

void	SetShowAsAvailableSlicerStyle (bool showAsAvailableSlicerStyle)
	Sets if the specified table style is shown as available in the slicer styles gallery.

bool	GetShowAsAvailableTableStyle ()
	Returns a table style shown as available in the table styles gallery.

void	SetShowAsAvailableTableStyle (bool showAsAvailableTableStyle)
	Sets a table style shown as available in the table styles gallery.

bool	GetShowAsAvailableTimelineStyle ()
	Returns whether the specified table style is shown as available in the timeline styles gallery.

void	SetShowAsAvailableTimelineStyle (bool showAsAvailableTimelineStyle)
	Sets whether the specified table style is shown as available in the timeline styles gallery.

wxExcelTableStyleElements	GetTableStyleElements ()
	Returns the TableStyleElements object.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "TableStyle".

Public Member Functions inherited from wxAutoExcel::wxExcelObject
bool	IsOk_ () const
	Returns true if the object has a valid dispatch.

wxString	GetAutomationObjectName_ (bool stripUnderscores=false) const
	Returns object name as provided by IDispatch->GetTypeInfo()->GetDocumentation(MEMBERID_NIL, &name, NULL, NULL, NULL).

wxSharedPtr< wxAutomationObject >	GetAutomationObject_ ()
	Returns the underlying wxAutomationObject.

	operator bool () const
	Returns true if the object has a valid dispatch and its last automation call (if any), i.e.

WXLCID	GetAutomationLCID_ () const
	Returns the locale identifier used in automation calls.

bool	SetAutomationLCID_ (WXLCID lcid)
	Sets the locale identifier to be used in automation calls.

bool	GetPropertyAndMethodNames_ (wxArrayString &propertyNames, wxArrayString &methodNames, bool includeHidden=false)
	Returns lists of property and method names the automation interface exposes.

bool	GetUnimplementedObject_ (const wxString &name, wxAutomationObject &object)
	Helper function for receiving an automation object not implemented in wxAutoExcel, see FAQ on how to use.

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.

static void	SetErrorMode_ (unsigned mode)
	Sets the error mode as the combination of wxExcelObject::ErrorFlags.

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.

Detailed Description

Represents a single style that can be applied to a table or slicer.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelTableStyle::Delete ( )

Deletes the TableStyle object.

MSDN documentation for TableStyle.Delete

◆ Duplicate()

wxExcelTableStyle wxAutoExcel::wxExcelTableStyle::Duplicate ( const wxString & newTableStyleName = wxEmptyString )

Duplicates the TableStyle object and returns the copy.

MSDN documentation for TableStyle.Duplicate

◆ GetBuiltIn()

bool wxAutoExcel::wxExcelTableStyle::GetBuiltIn ( )

True if the style is a built-in style.

MSDN documentation for TableStyle.BuiltIn

◆ GetName()

wxString wxAutoExcel::wxExcelTableStyle::GetName ( )

Returns the name of the object.

MSDN documentation for TableStyle.Name

◆ GetNameLocal()

wxString wxAutoExcel::wxExcelTableStyle::GetNameLocal ( )

Returns the name of the object, in the language of the user.

MSDN documentation for TableStyle.NameLocal

◆ GetShowAsAvailablePivotTableStyle()

bool wxAutoExcel::wxExcelTableStyle::GetShowAsAvailablePivotTableStyle ( )

Returns if a style is shown in the gallery for PivotTable styles or not.

MSDN documentation for TableStyle.ShowAsAvailablePivotTableStyle

◆ SetShowAsAvailablePivotTableStyle()

void wxAutoExcel::wxExcelTableStyle::SetShowAsAvailablePivotTableStyle ( bool showAsAvailablePivotTableStyle )

Sets if a style is shown in the gallery for PivotTable styles or not.

MSDN documentation for TableStyle.ShowAsAvailablePivotTableStyle.

◆ GetShowAsAvailableSlicerStyle()

bool wxAutoExcel::wxExcelTableStyle::GetShowAsAvailableSlicerStyle ( )

Returns if the specified table style is shown as available in the slicer styles gallery.

MSDN documentation for TableStyle.ShowAsAvailableSlicerStyle

◆ SetShowAsAvailableSlicerStyle()

void wxAutoExcel::wxExcelTableStyle::SetShowAsAvailableSlicerStyle ( bool showAsAvailableSlicerStyle )

Sets if the specified table style is shown as available in the slicer styles gallery.

MSDN documentation for TableStyle.ShowAsAvailableSlicerStyle.

◆ GetShowAsAvailableTableStyle()

bool wxAutoExcel::wxExcelTableStyle::GetShowAsAvailableTableStyle ( )

Returns a table style shown as available in the table styles gallery.

MSDN documentation for TableStyle.ShowAsAvailableTableStyle

◆ SetShowAsAvailableTableStyle()

void wxAutoExcel::wxExcelTableStyle::SetShowAsAvailableTableStyle ( bool showAsAvailableTableStyle )

Sets a table style shown as available in the table styles gallery.

MSDN documentation for TableStyle.ShowAsAvailableTableStyle.

◆ GetShowAsAvailableTimelineStyle()

bool wxAutoExcel::wxExcelTableStyle::GetShowAsAvailableTimelineStyle ( )

Returns whether the specified table style is shown as available in the timeline styles gallery.

MSDN documentation for TableStyle.ShowAsAvailableTimelineStyle

◆ SetShowAsAvailableTimelineStyle()

void wxAutoExcel::wxExcelTableStyle::SetShowAsAvailableTimelineStyle ( bool showAsAvailableTimelineStyle )

Sets whether the specified table style is shown as available in the timeline styles gallery.

MSDN documentation for TableStyle.ShowAsAvailableTimelineStyle.

◆ GetTableStyleElements()

wxExcelTableStyleElements wxAutoExcel::wxExcelTableStyle::GetTableStyleElements ( )

Returns the TableStyleElements object.

MSDN documentation for TableStyle.TableStyleElements

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelTableStyle::GetAutoExcelObjectName_ ( ) const

inlinevirtual

Returns "TableStyle".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members