Represents Microsoft Excel Legend object. More...

#include <wxAutoExcelLegend.h>

Inheritance diagram for wxAutoExcel::wxExcelLegend:

Public Member Functions
bool	Clear ()
	Clears the entire object.

bool	Delete ()
	Deletes the object.

wxExcelLegendEntries	LegendEntries ()
	Returns an object that represents either a collection of legend entries (a LegendEntries object) for the legend.

bool	Select ()
	Selects the object.

bool	GetAutoScaleFont ()
	True if the text in the object changes font size when the object size changes.

void	SetAutoScaleFont (bool autoScaleFont)
	True if the text in the object changes font size when the object size changes.

wxExcelChartFormat	GetFormat ()
	Returns the ChartFormat object.

double	GetHeight ()
	Returns a Double value that represents the height, in points, of the object.

void	SetHeight (double height)
	Sets a Double value that represents the height, in points, of the object.

bool	GetIncludeInLayout ()
	True if a legend will occupy the chart layout space when a chart layout is being determined.

void	SetIncludeInLayout (bool includeInLayout)
	True if a legend will occupy the chart layout space when a chart layout is being determined.

double	GetLeft ()
	Returns a Double value that represents the distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

void	SetLeft (double left)
	Sets a Double value that represents the distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

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

XlLegendPosition	GetPosition ()
	Returns a XlLegendPosition value that represents the position of the legend on the chart.

void	SetPosition (XlLegendPosition position)
	Sets a XlLegendPosition value that represents the position of the legend on the chart.

bool	GetShadow ()
	Returns a Boolean value that determines if the object has a shadow.

void	SetShadow (bool shadow)
	Sets a Boolean value that determines if the object has a shadow.

double	GetTop ()
	Returns a Double value that represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

void	SetTop (double top)
	Sets a Double value that represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

double	GetWidth ()
	Returns a Double value that represents the width, in points, of the object.

void	SetWidth (double width)
	Sets a Double value that represents the width, in points, of the object.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Legend".

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 Microsoft Excel Legend object.

Member Function Documentation

◆ Clear()

bool wxAutoExcel::wxExcelLegend::Clear ( )

Clears the entire object.

MSDN documentation for Legend.Clear.

◆ Delete()

bool wxAutoExcel::wxExcelLegend::Delete ( )

Deletes the object.

MSDN documentation for Legend.Delete.

◆ LegendEntries()

wxExcelLegendEntries wxAutoExcel::wxExcelLegend::LegendEntries ( )

Returns an object that represents either a collection of legend entries (a LegendEntries object) for the legend.

MSDN documentation for Legend.LegendEntries.

◆ Select()

bool wxAutoExcel::wxExcelLegend::Select ( )

Selects the object.

MSDN documentation for Legend.Select.

◆ GetAutoScaleFont()

bool wxAutoExcel::wxExcelLegend::GetAutoScaleFont ( )

True if the text in the object changes font size when the object size changes.

The default value is True. Read/write Variant.

MSDN documentation for Legend.AutoScaleFont.

◆ SetAutoScaleFont()

void wxAutoExcel::wxExcelLegend::SetAutoScaleFont ( bool autoScaleFont )

True if the text in the object changes font size when the object size changes.

The default value is True. Read/write Variant.

MSDN documentation for Legend.AutoScaleFont.

◆ GetFormat()

wxExcelChartFormat wxAutoExcel::wxExcelLegend::GetFormat ( )

Returns the ChartFormat object.

Since Excel 2007.

MSDN documentation for Legend.Format.

◆ GetHeight()

double wxAutoExcel::wxExcelLegend::GetHeight ( )

Returns a Double value that represents the height, in points, of the object.

MSDN documentation for Legend.Height.

◆ SetHeight()

void wxAutoExcel::wxExcelLegend::SetHeight ( double height )

Sets a Double value that represents the height, in points, of the object.

MSDN documentation for Legend.Height.

◆ GetIncludeInLayout()

bool wxAutoExcel::wxExcelLegend::GetIncludeInLayout ( )

True if a legend will occupy the chart layout space when a chart layout is being determined.

Since Excel 2007.

MSDN documentation for Legend.IncludeInLayout.

◆ SetIncludeInLayout()

void wxAutoExcel::wxExcelLegend::SetIncludeInLayout ( bool includeInLayout )

True if a legend will occupy the chart layout space when a chart layout is being determined.

Since Excel 2007.

MSDN documentation for Legend.IncludeInLayout.

◆ GetLeft()

double wxAutoExcel::wxExcelLegend::GetLeft ( )

Returns a Double value that represents the distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

MSDN documentation for Legend.Left.

◆ SetLeft()

void wxAutoExcel::wxExcelLegend::SetLeft ( double left )

Sets a Double value that represents the distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

MSDN documentation for Legend.Left.

◆ GetName()

wxString wxAutoExcel::wxExcelLegend::GetName ( )

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

MSDN documentation for Legend.Name.

◆ GetPosition()

XlLegendPosition wxAutoExcel::wxExcelLegend::GetPosition ( )

Returns a XlLegendPosition value that represents the position of the legend on the chart.

MSDN documentation for Legend.Position.

◆ SetPosition()

void wxAutoExcel::wxExcelLegend::SetPosition ( XlLegendPosition position )

Sets a XlLegendPosition value that represents the position of the legend on the chart.

MSDN documentation for Legend.Position.

◆ GetShadow()

bool wxAutoExcel::wxExcelLegend::GetShadow ( )

Returns a Boolean value that determines if the object has a shadow.

MSDN documentation for Legend.Shadow.

◆ SetShadow()

void wxAutoExcel::wxExcelLegend::SetShadow ( bool shadow )

Sets a Boolean value that determines if the object has a shadow.

MSDN documentation for Legend.Shadow.

◆ GetTop()

double wxAutoExcel::wxExcelLegend::GetTop ( )

Returns a Double value that represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

MSDN documentation for Legend.Top.

◆ SetTop()

void wxAutoExcel::wxExcelLegend::SetTop ( double top )

Sets a Double value that represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

MSDN documentation for Legend.Top.

◆ GetWidth()

double wxAutoExcel::wxExcelLegend::GetWidth ( )

Returns a Double value that represents the width, in points, of the object.

MSDN documentation for Legend.Width.

◆ SetWidth()

void wxAutoExcel::wxExcelLegend::SetWidth ( double width )

Sets a Double value that represents the width, in points, of the object.

MSDN documentation for Legend.Width.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "Legend".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Clear()

◆ Delete()

◆ LegendEntries()

◆ Select()

◆ GetAutoScaleFont()

◆ SetAutoScaleFont()

◆ GetFormat()

◆ GetHeight()

◆ SetHeight()

◆ GetIncludeInLayout()

◆ SetIncludeInLayout()

◆ GetLeft()

◆ SetLeft()

◆ GetName()

◆ GetPosition()

◆ SetPosition()

◆ GetShadow()

◆ SetShadow()

◆ GetTop()

◆ SetTop()

◆ GetWidth()

◆ SetWidth()

◆ GetAutoExcelObjectName_()