Represents Microsoft Excel LegendEntry object. More...

Inheritance diagram for wxAutoExcel::wxExcelLegendEntry:

Public Member Functions
bool	Delete ()
	Deletes the object. More...

bool	Select ()
	Selects the object. More...

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

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

wxExcelFont	GetFont ()
	Returns a Font object that represents the font of the specified object. More...

wxExcelChartFormat	GetFormat ()
	Returns the ChartFormat object. More...

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

long	GetIndex ()
	Returns a Long value that represents the index number of the object within the collection of similar objects. More...

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

wxExcelLegendKey	GetLegendKey ()
	Returns a LegendKey object that represents the legend key associated with the entry. More...

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). More...

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

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "LegendEntry". 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 LegendEntry object.

Member Function Documentation

◆ Delete()

bool wxAutoExcel::wxExcelLegendEntry::Delete ( )

Deletes the object.

MSDN documentation for LegendEntry.Delete.

◆ Select()

bool wxAutoExcel::wxExcelLegendEntry::Select ( )

Selects the object.

MSDN documentation for LegendEntry.Select.

◆ GetAutoScaleFont()

bool wxAutoExcel::wxExcelLegendEntry::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 LegendEntry.AutoScaleFont.

◆ SetAutoScaleFont()

void wxAutoExcel::wxExcelLegendEntry::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 LegendEntry.AutoScaleFont.

◆ GetFont()

wxExcelFont wxAutoExcel::wxExcelLegendEntry::GetFont ( )

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

MSDN documentation for LegendEntry.Font.

◆ GetFormat()

wxExcelChartFormat wxAutoExcel::wxExcelLegendEntry::GetFormat ( )

Returns the ChartFormat object.

Since Excel 2007.

MSDN documentation for LegendEntry.Format.

◆ GetHeight()

double wxAutoExcel::wxExcelLegendEntry::GetHeight ( )

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

MSDN documentation for LegendEntry.Height.

◆ GetIndex()

long wxAutoExcel::wxExcelLegendEntry::GetIndex ( )

Returns a Long value that represents the index number of the object within the collection of similar objects.

MSDN documentation for LegendEntry.Index.

◆ GetLeft()

double wxAutoExcel::wxExcelLegendEntry::GetLeft ( )

Returns a Double value that represents the distance, in points, from the left edge of the object to the left edge of the chart area.

MSDN documentation for LegendEntry.Left.

◆ GetLegendKey()

wxExcelLegendKey wxAutoExcel::wxExcelLegendEntry::GetLegendKey ( )

Returns a LegendKey object that represents the legend key associated with the entry.

MSDN documentation for LegendEntry.LegendKey.

◆ GetTop()

double wxAutoExcel::wxExcelLegendEntry::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 LegendEntry.Top.

◆ GetWidth()

double wxAutoExcel::wxExcelLegendEntry::GetWidth ( )

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

MSDN documentation for LegendEntry.Width.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "LegendEntry".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members