Represents a list object in ListObjects collection. More...

#include <wxAutoExcelListObject.h>

Inheritance diagram for wxAutoExcel::wxExcelListObject:

Public Member Functions
void	Delete ()
	Deletes the ListObject object and clears the cell data from the worksheet.

void	ExportToVisio ()
	Exports a ListObject object to Visio.

wxString	Publish (const wxArrayString &target, bool linkSource)
	Publishes the ListObject object to a server that is running Microsoft SharePoint Foundation.

void	Refresh ()
	Retrieves the current data and schema for the list from the server that is running Microsoft SharePoint Foundation.

void	Resize (wxExcelRange range)
	The Resize method allows a ListObject object to be resized over a new range.

void	Unlink ()
	Removes the link to a Microsoft SharePoint Foundation site from a list.

void	Unlist ()
	Removes the list functionality.

bool	GetActive ()
	Returns a Boolean value indicating whether a ListObject object in a worksheet is active�that is, whether the active cell is inside the range of the ListObject object.

wxString	GetAlternativeText ()
	Returns the descriptive (alternative) text string for the specified table.

void	SetAlternativeText (const wxString &alternativeText)
	Sets the descriptive (alternative) text string for the specified table.

wxExcelAutoFilter	GetAutoFilter ()
	Filters a table using the AutoFilter feature.

wxString	GetComment ()
	Returns the associated comment.

void	SetComment (const wxString &comment)
	Sets the associated comment.

wxExcelRange	GetDataBodyRange ()
	Returns a Range that represents the range of values, excluding the header row, in a table.

wxString	GetDisplayName ()
	Returns the display name.

void	SetDisplayName (const wxString &displayName)
	Sets the display name.

bool	GetDisplayRightToLeft ()
	True if it is displayed from right to left instead of from left to right, false otherwise.

wxExcelRange	GetHeaderRowRange ()
	Returns a Range object that represents the range of the header row for a list.

wxExcelRange	GetInsertRowRange ()
	Returns a Range object representing the Insert row, if any.

wxExcelListColumns	GetListColumns ()
	Returns a ListColumns collection that represents all the columns.

wxExcelListRows	GetListRows ()
	Returns a ListRows object that represents all the rows of data.

wxString	GetName ()
	Returns a String value that represents the name of the ListObject object.

void	SetName (const wxString &name)
	Sets a String value that represents the name of the ListObject object.

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

wxString	GetSharePointURL ()
	Returns a String representing the URL of the SharePoint list for a given ListObject object.

bool	GetShowAutoFilter ()
	Returns Boolean to indicate whether the AutoFilter will be displayed.

void	SetShowAutoFilter (bool showAutoFilter)
	Returns Boolean to indicate whether the AutoFilter will be displayed.

bool	GetShowAutoFilterDropDown ()
	True when the AutoFilter drop down for the ListObject object is displayed.

void	SetShowAutoFilterDropDown (bool showAutoFilterDropDown)
	True when the AutoFilter drop down for the ListObject object is displayed.

bool	GetShowHeaders ()
	Returns if the header information should be displayed.

void	SetShowHeaders (bool showHeaders)
	Sets if the header information should be displayed.

bool	GetShowTableStyleColumnStripes ()
	Returns if the Column Stripes table style is used.

void	SetShowTableStyleColumnStripes (bool showTableStyleColumnStripes)
	Sets if the Column Stripes table style is used.

bool	GetShowTableStyleFirstColumn ()
	Returns if the first column is formatted.

void	SetShowTableStyleFirstColumn (bool showTableStyleFirstColumn)
	Sets if the first column is formatted.

bool	GetShowTableStyleLastColumn ()
	Returns if the last column is displayed.

void	SetShowTableStyleLastColumn (bool showTableStyleLastColumn)
	Sets if the last column is displayed.

bool	GetShowTableStyleRowStripes ()
	Returns if the Row Stripes table style is used.

void	SetShowTableStyleRowStripes (bool showTableStyleRowStripes)
	Sets if the Row Stripes table style is used.

bool	GetShowTotals ()
	Gets or sets a Boolean to indicate whether the Total row is visible.

void	SetShowTotals (bool showTotals)
	Gets or sets a Boolean to indicate whether the Total row is visible.

wxExcelSort	GetSort ()
	Gets or sets the sort column or columns, and sort order for the ListObject collection.

void	SetSort (wxExcelSort sort)
	Gets or sets the sort column or columns, and sort order for the ListObject collection.

XlListObjectSourceType	GetSourceType ()
	Returns a XlListObjectSourceType value that represents the current source of the list.

wxString	GetSummary ()
	Returns the description associated with the alternative text string for the specified table.

void	SetSummary (const wxString &summary)
	Sets the description associated with the alternative text string for the specified table.

wxExcelTableObject	GetTableObject ()
	Returns a TableObject object.

wxExcelTableStyle	GetTableStyle ()
	Gets the table style.

void	SetTableStyle (wxExcelTableStyle tableStyle)
	Sets the table style.

wxExcelRange	GetTotalsRowRange ()
	Returns a Range representing the Total row, if any.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "ListObject".

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 list object in ListObjects collection.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelListObject::Delete ( )

Deletes the ListObject object and clears the cell data from the worksheet.

MSDN documentation for ListObject.Delete

◆ ExportToVisio()

void wxAutoExcel::wxExcelListObject::ExportToVisio ( )

Exports a ListObject object to Visio.

MSDN documentation for ListObject.ExportToVisio

◆ Publish()

wxString wxAutoExcel::wxExcelListObject::Publish	(	const wxArrayString &	target,
		bool	linkSource
	)

Publishes the ListObject object to a server that is running Microsoft SharePoint Foundation.

MSDN documentation for ListObject.Publish

◆ Refresh()

void wxAutoExcel::wxExcelListObject::Refresh ( )

Retrieves the current data and schema for the list from the server that is running Microsoft SharePoint Foundation.

This method can be used only with lists that are linked to a SharePoint site. If the SharePoint site is not available, calling this method will return an error.

MSDN documentation for ListObject.Refresh

◆ Resize()

void wxAutoExcel::wxExcelListObject::Resize ( wxExcelRange range )

The Resize method allows a ListObject object to be resized over a new range.

No cells are inserted or moved.

MSDN documentation for ListObject.Resize

◆ Unlink()

void wxAutoExcel::wxExcelListObject::Unlink ( )

Removes the link to a Microsoft SharePoint Foundation site from a list.

Returns Nothing.

MSDN documentation for ListObject.Unlink

◆ Unlist()

void wxAutoExcel::wxExcelListObject::Unlist ( )

Removes the list functionality.

After you use this method, the range of cells that made up the the list will be a regular range of data.

MSDN documentation for ListObject.Unlist

◆ GetActive()

bool wxAutoExcel::wxExcelListObject::GetActive ( )

Returns a Boolean value indicating whether a ListObject object in a worksheet is active�that is, whether the active cell is inside the range of the ListObject object.

MSDN documentation for ListObject.Active

◆ GetAlternativeText()

wxString wxAutoExcel::wxExcelListObject::GetAlternativeText ( )

Returns the descriptive (alternative) text string for the specified table.

MSDN documentation for ListObject.AlternativeText

◆ SetAlternativeText()

void wxAutoExcel::wxExcelListObject::SetAlternativeText ( const wxString & alternativeText )

Sets the descriptive (alternative) text string for the specified table.

MSDN documentation for ListObject.AlternativeText.

◆ GetAutoFilter()

wxExcelAutoFilter wxAutoExcel::wxExcelListObject::GetAutoFilter ( )

Filters a table using the AutoFilter feature.

MSDN documentation for ListObject.AutoFilter

◆ GetComment()

wxString wxAutoExcel::wxExcelListObject::GetComment ( )

Returns the associated comment.

MSDN documentation for ListObject.Comment

◆ SetComment()

void wxAutoExcel::wxExcelListObject::SetComment ( const wxString & comment )

Sets the associated comment.

MSDN documentation for ListObject.Comment.

◆ GetDataBodyRange()

wxExcelRange wxAutoExcel::wxExcelListObject::GetDataBodyRange ( )

Returns a Range that represents the range of values, excluding the header row, in a table.

MSDN documentation for ListObject.DataBodyRange

◆ GetDisplayName()

wxString wxAutoExcel::wxExcelListObject::GetDisplayName ( )

Returns the display name.

MSDN documentation for ListObject.DisplayName

◆ SetDisplayName()

void wxAutoExcel::wxExcelListObject::SetDisplayName ( const wxString & displayName )

Sets the display name.

MSDN documentation for ListObject.DisplayName.

◆ GetDisplayRightToLeft()

bool wxAutoExcel::wxExcelListObject::GetDisplayRightToLeft ( )

True if it is displayed from right to left instead of from left to right, false otherwise.

MSDN documentation for ListObject.DisplayRightToLeft

◆ GetHeaderRowRange()

wxExcelRange wxAutoExcel::wxExcelListObject::GetHeaderRowRange ( )

Returns a Range object that represents the range of the header row for a list.

MSDN documentation for ListObject.HeaderRowRange

◆ GetInsertRowRange()

wxExcelRange wxAutoExcel::wxExcelListObject::GetInsertRowRange ( )

Returns a Range object representing the Insert row, if any.

MSDN documentation for ListObject.InsertRowRange

◆ GetListColumns()

wxExcelListColumns wxAutoExcel::wxExcelListObject::GetListColumns ( )

Returns a ListColumns collection that represents all the columns.

MSDN documentation for ListObject.ListColumns

◆ GetListRows()

wxExcelListRows wxAutoExcel::wxExcelListObject::GetListRows ( )

Returns a ListRows object that represents all the rows of data.

MSDN documentation for ListObject.ListRows

◆ GetName()

wxString wxAutoExcel::wxExcelListObject::GetName ( )

Returns a String value that represents the name of the ListObject object.

MSDN documentation for ListObject.Name

◆ SetName()

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

Sets a String value that represents the name of the ListObject object.

MSDN documentation for ListObject.Name.

◆ GetRange()

wxExcelRange wxAutoExcel::wxExcelListObject::GetRange ( )

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

MSDN documentation for ListObject.Range

◆ GetSharePointURL()

wxString wxAutoExcel::wxExcelListObject::GetSharePointURL ( )

Returns a String representing the URL of the SharePoint list for a given ListObject object.

MSDN documentation for ListObject.SharePointURL

◆ GetShowAutoFilter()

bool wxAutoExcel::wxExcelListObject::GetShowAutoFilter ( )

Returns Boolean to indicate whether the AutoFilter will be displayed.

MSDN documentation for ListObject.ShowAutoFilter

◆ SetShowAutoFilter()

void wxAutoExcel::wxExcelListObject::SetShowAutoFilter ( bool showAutoFilter )

Returns Boolean to indicate whether the AutoFilter will be displayed.

MSDN documentation for ListObject.ShowAutoFilter.

◆ GetShowAutoFilterDropDown()

bool wxAutoExcel::wxExcelListObject::GetShowAutoFilterDropDown ( )

True when the AutoFilter drop down for the ListObject object is displayed.

MSDN documentation for ListObject.ShowAutoFilterDropDown

◆ SetShowAutoFilterDropDown()

void wxAutoExcel::wxExcelListObject::SetShowAutoFilterDropDown ( bool showAutoFilterDropDown )

True when the AutoFilter drop down for the ListObject object is displayed.

MSDN documentation for ListObject.ShowAutoFilterDropDown.

◆ GetShowHeaders()

bool wxAutoExcel::wxExcelListObject::GetShowHeaders ( )

Returns if the header information should be displayed.

MSDN documentation for ListObject.ShowHeaders

◆ SetShowHeaders()

void wxAutoExcel::wxExcelListObject::SetShowHeaders ( bool showHeaders )

Sets if the header information should be displayed.

MSDN documentation for ListObject.ShowHeaders.

◆ GetShowTableStyleColumnStripes()

bool wxAutoExcel::wxExcelListObject::GetShowTableStyleColumnStripes ( )

Returns if the Column Stripes table style is used.

MSDN documentation for ListObject.ShowTableStyleColumnStripes

◆ SetShowTableStyleColumnStripes()

void wxAutoExcel::wxExcelListObject::SetShowTableStyleColumnStripes ( bool showTableStyleColumnStripes )

Sets if the Column Stripes table style is used.

MSDN documentation for ListObject.ShowTableStyleColumnStripes.

◆ GetShowTableStyleFirstColumn()

bool wxAutoExcel::wxExcelListObject::GetShowTableStyleFirstColumn ( )

Returns if the first column is formatted.

MSDN documentation for ListObject.ShowTableStyleFirstColumn

◆ SetShowTableStyleFirstColumn()

void wxAutoExcel::wxExcelListObject::SetShowTableStyleFirstColumn ( bool showTableStyleFirstColumn )

Sets if the first column is formatted.

MSDN documentation for ListObject.ShowTableStyleFirstColumn.

◆ GetShowTableStyleLastColumn()

bool wxAutoExcel::wxExcelListObject::GetShowTableStyleLastColumn ( )

Returns if the last column is displayed.

MSDN documentation for ListObject.ShowTableStyleLastColumn

◆ SetShowTableStyleLastColumn()

void wxAutoExcel::wxExcelListObject::SetShowTableStyleLastColumn ( bool showTableStyleLastColumn )

Sets if the last column is displayed.

MSDN documentation for ListObject.ShowTableStyleLastColumn.

◆ GetShowTableStyleRowStripes()

bool wxAutoExcel::wxExcelListObject::GetShowTableStyleRowStripes ( )

Returns if the Row Stripes table style is used.

MSDN documentation for ListObject.ShowTableStyleRowStripes

◆ SetShowTableStyleRowStripes()

void wxAutoExcel::wxExcelListObject::SetShowTableStyleRowStripes ( bool showTableStyleRowStripes )

Sets if the Row Stripes table style is used.

MSDN documentation for ListObject.ShowTableStyleRowStripes.

◆ GetShowTotals()

bool wxAutoExcel::wxExcelListObject::GetShowTotals ( )

Gets or sets a Boolean to indicate whether the Total row is visible.

MSDN documentation for ListObject.ShowTotals

◆ SetShowTotals()

void wxAutoExcel::wxExcelListObject::SetShowTotals ( bool showTotals )

Gets or sets a Boolean to indicate whether the Total row is visible.

MSDN documentation for ListObject.ShowTotals.

◆ GetSort()

wxExcelSort wxAutoExcel::wxExcelListObject::GetSort ( )

Gets or sets the sort column or columns, and sort order for the ListObject collection.

MSDN documentation for ListObject.Sort

◆ SetSort()

void wxAutoExcel::wxExcelListObject::SetSort ( wxExcelSort sort )

Gets or sets the sort column or columns, and sort order for the ListObject collection.

MSDN documentation for ListObject.Sort.

◆ GetSourceType()

XlListObjectSourceType wxAutoExcel::wxExcelListObject::GetSourceType ( )

Returns a XlListObjectSourceType value that represents the current source of the list.

MSDN documentation for ListObject.SourceType

◆ GetSummary()

wxString wxAutoExcel::wxExcelListObject::GetSummary ( )

Returns the description associated with the alternative text string for the specified table.

MSDN documentation for ListObject.Summary

◆ SetSummary()

void wxAutoExcel::wxExcelListObject::SetSummary ( const wxString & summary )

Sets the description associated with the alternative text string for the specified table.

MSDN documentation for ListObject.Summary.

◆ GetTableObject()

wxExcelTableObject wxAutoExcel::wxExcelListObject::GetTableObject ( )

Returns a TableObject object.

MSDN documentation for ListObject.TableObject

◆ GetTableStyle()

wxExcelTableStyle wxAutoExcel::wxExcelListObject::GetTableStyle ( )

Gets the table style.

MSDN documentation for ListObject.TableStyle

◆ SetTableStyle()

void wxAutoExcel::wxExcelListObject::SetTableStyle ( wxExcelTableStyle tableStyle )

Sets the table style.

MSDN documentation for ListObject.TableStyle.

◆ GetTotalsRowRange()

wxExcelRange wxAutoExcel::wxExcelListObject::GetTotalsRowRange ( )

Returns a Range representing the Total row, if any.

MSDN documentation for ListObject.TotalsRowRange

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "ListObject".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members