Represents Microsoft Excel LegendKey object. More...

#include <wxAutoExcelLegendKey.h>

Inheritance diagram for wxAutoExcel::wxExcelLegendKey:

Public Member Functions
bool	ClearFormats ()
	Clears the formatting of the object.

bool	Delete ()
	Deletes the object.

wxExcelChartFormat	GetFormat ()
	Returns the ChartFormat object.

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

bool	GetInvertIfNegative ()
	True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

void	SetInvertIfNegative (bool invertIfNegative)
	True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

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.

wxColour	GetMarkerBackgroundColor ()
	Sets the marker background color as an RGB value or returns the corresponding color index value.

void	SetMarkerBackgroundColor (const wxColour &markerBackgroundColor)
	Sets the marker background color as an RGB value or returns the corresponding color index value.

long	GetMarkerBackgroundColorIndex ()
	Returns the marker background color as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone.

void	SetMarkerBackgroundColorIndex (long markerBackgroundColorIndex)
	Sets the marker background color as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone.

wxColour	GetMarkerForegroundColor ()
	Sets the marker background color as an RGB value or returns the corresponding color index value.

void	SetMarkerForegroundColor (const wxColour &markerForegroundColor)
	Sets the marker background color as an RGB value or returns the corresponding color index value.

long	GetMarkerForegroundColorIndex ()
	Returns the marker foreground color as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone.

void	SetMarkerForegroundColorIndex (long markerForegroundColorIndex)
	Sets the marker foreground color as an index into the current color palette, or as one of the following XlColorIndex constants: xlColorIndexAutomatic or xlColorIndexNone.

long	GetMarkerSize ()
	Returns the data-marker size, in points.

void	SetMarkerSize (long markerSize)
	Sets the data-marker size, in points.

XlMarkerStyle	GetMarkerStyle ()
	Returns the marker style for a point or series in a line chart, scatter chart, or radar chart.

void	SetMarkerStyle (XlMarkerStyle markerStyle)
	Sets the marker style for a point or series in a line chart, scatter chart, or radar chart.

XlChartPictureType	GetPictureType ()
	Returns a XlChartPictureType value that represents the way pictures are displayed on a legend key.

void	SetPictureType (XlChartPictureType pictureType)
	Sets a XlChartPictureType value that represents the way pictures are displayed on a legend key.

long	GetPictureUnit ()
	Returns the unit for each picture on the chart if the PictureType property is set to xlStackScale (if not, this property is ignored).

void	SetPictureUnit (long pictureUnit)
	Sets the unit for each picture on the chart if the PictureType property is set to xlStackScale (if not, this property is ignored).

double	GetPictureUnit2 ()
	Returns the unit for each picture on the chart if the PictureType property is set to xlStackScale (if not, this property is ignored).

void	SetPictureUnit2 (double pictureUnit2)
	Sets the unit for each picture on the chart if the PictureType property is set to xlStackScale (if not, this property is ignored).

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.

bool	GetSmooth ()
	True if curve smoothing is turned on for the legend key.

void	SetSmooth (bool smooth)
	True if curve smoothing is turned on for the legend key.

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

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

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "LegendKey".

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 LegendKey object.

Member Function Documentation

◆ ClearFormats()

bool wxAutoExcel::wxExcelLegendKey::ClearFormats ( )

Clears the formatting of the object.

MSDN documentation for LegendKey.ClearFormats.

◆ Delete()

bool wxAutoExcel::wxExcelLegendKey::Delete ( )

Deletes the object.

MSDN documentation for LegendKey.Delete.

◆ GetFormat()

wxExcelChartFormat wxAutoExcel::wxExcelLegendKey::GetFormat ( )

Returns the ChartFormat object.

Since Excel 2007.

MSDN documentation for LegendKey.Format.

◆ GetHeight()

double wxAutoExcel::wxExcelLegendKey::GetHeight ( )

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

MSDN documentation for LegendKey.Height.

◆ GetInvertIfNegative()

bool wxAutoExcel::wxExcelLegendKey::GetInvertIfNegative ( )

True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

MSDN documentation for LegendKey.InvertIfNegative.

◆ SetInvertIfNegative()

void wxAutoExcel::wxExcelLegendKey::SetInvertIfNegative ( bool invertIfNegative )

True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.

MSDN documentation for LegendKey.InvertIfNegative.

◆ GetLeft()

double wxAutoExcel::wxExcelLegendKey::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 LegendKey.Left.