Represents Microsoft Excel DataLabel object. More...

#include <wxAutoExcelDataLabels.h>

Inheritance diagram for wxAutoExcel::wxExcelDataLabel:

Public Member Functions
bool	Delete ()
	Deletes the object.

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.

bool	GetAutoText ()
	True if the object automatically generates appropriate text based on context.

void	SetAutoText (bool autoText)
	True if the object automatically generates appropriate text based on context.

wxString	GetCaption ()
	Returns a String value that represents the data label text.

void	SetCaption (const wxString &caption)
	Sets a String value that represents the data label text.

wxExcelCharacters	GetCharacters (long start=1, long *length=NULL)
	Returns a Characters object that represents a range of characters within the object text.

wxExcelChartFormat	GetFormat ()
	Returns the ChartFormat object.

long	GetHorizontalAlignment ()
	Returns a Variant value that represents the horizontal alignment for the specified object.

void	SetHorizontalAlignment (long horizontalAlignment)
	Sets a Variant value that represents the horizontal alignment for the specified object.

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.

wxString	GetNumberFormat ()
	Returns a String value that represents the format code for the object.

void	SetNumberFormat (const wxString &numberFormat)
	Sets a String value that represents the format code for the object.

bool	GetNumberFormatLinked ()
	True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

void	SetNumberFormatLinked (bool numberFormatLinked)
	True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

wxString	GetNumberFormatLocal ()
	Returns a Variant value that represents the format code for the object as a string in the language of the user.

void	SetNumberFormatLocal (const wxString &numberFormatLocal)
	Sets a Variant value that represents the format code for the object as a string in the language of the user.

long	GetOrientation ()
	Returns a Variant value that represents the text orientation.

void	SetOrientation (long orientation)
	Sets a Variant value that represents the text orientation.

XlDataLabelPosition	GetPosition ()
	Returns a XlDataLabelPosition value that represents the position of the data label.

void	SetPosition (XlDataLabelPosition position)
	Sets a XlDataLabelPosition value that represents the position of the data label.

long	GetReadingOrder ()
	Returns the reading order for the specified object.

void	SetReadingOrder (long readingOrder)
	Sets the reading order for the specified object.

wxString	GetSeparator ()
	Returns a Variant representing the separator used for the data labels on a chart.

void	SetSeparator (const wxString &separator)
	Sets a Variant representing the separator used for the data labels on a 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.

bool	GetShowBubbleSize ()
	True to show the bubble size for the data labels on a chart.

void	SetShowBubbleSize (bool showBubbleSize)
	True to show the bubble size for the data labels on a chart.

bool	GetShowCategoryName ()
	True to display the category name for the data labels on a chart.

void	SetShowCategoryName (bool showCategoryName)
	True to display the category name for the data labels on a chart.

bool	GetShowLegendKey ()
	True if the data label legend key is visible.

void	SetShowLegendKey (bool showLegendKey)
	True if the data label legend key is visible.

bool	GetShowPercentage ()
	True to display the percentage value for the data labels on a chart.

void	SetShowPercentage (bool showPercentage)
	True to display the percentage value for the data labels on a chart.

bool	GetShowRange ()
	Toggles the Range field if it exists on the data label range.

void	SetShowRange (bool showRange)
	Toggles the Range field if it exists on the data label range.

bool	GetShowSeriesName ()
	Returns a Boolean to indicate the series name display behavior for the data labels on a chart.

void	SetShowSeriesName (bool showSeriesName)
	Sets a Boolean to indicate the series name display behavior for the data labels on a chart.

bool	GetShowValue ()
	Returns a Boolean corresponding to a specified chart's data label values display behavior.

void	SetShowValue (bool showValue)
	Sets a Boolean corresponding to a specified chart's data label values display behavior.

wxString	GetText ()
	Returns the text for the specified object.

void	SetText (const wxString &text)
	Sets the text for the specified object.

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

long	GetVerticalAlignment ()
	Returns a Variant value that represents the vertical alignment of the specified object.

void	SetVerticalAlignment (long verticalAlignment)
	Sets a Variant value that represents the vertical alignment of the specified object.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "DataLabel".

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

Member Function Documentation

◆ Delete()

bool wxAutoExcel::wxExcelDataLabel::Delete ( )

Deletes the object.

MSDN documentation for DataLabel.Delete.

◆ Select()

bool wxAutoExcel::wxExcelDataLabel::Select ( )

Selects the object.

MSDN documentation for DataLabel.Select.

◆ GetAutoScaleFont()

bool wxAutoExcel::wxExcelDataLabel::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 DataLabel.AutoScaleFont.

◆ SetAutoScaleFont()

void wxAutoExcel::wxExcelDataLabel::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 DataLabel.AutoScaleFont.

◆ GetAutoText()

bool wxAutoExcel::wxExcelDataLabel::GetAutoText ( )

True if the object automatically generates appropriate text based on context.

MSDN documentation for DataLabel.AutoText.

◆ SetAutoText()

void wxAutoExcel::wxExcelDataLabel::SetAutoText ( bool autoText )

True if the object automatically generates appropriate text based on context.

MSDN documentation for DataLabel.AutoText.

◆ GetCaption()

wxString wxAutoExcel::wxExcelDataLabel::GetCaption ( )

Returns a String value that represents the data label text.

MSDN documentation for DataLabel.Caption.

◆ SetCaption()

void wxAutoExcel::wxExcelDataLabel::SetCaption ( const wxString & caption )

Sets a String value that represents the data label text.

MSDN documentation for DataLabel.Caption.

◆ GetCharacters()

wxExcelCharacters wxAutoExcel::wxExcelDataLabel::GetCharacters	(	long	start = `1`,
		long *	length = `NULL`
	)

Returns a Characters object that represents a range of characters within the object text.

You can use the Characters object to format characters within a text string.

MSDN documentation for DataLabel.Characters.

◆ GetFormat()

wxExcelChartFormat wxAutoExcel::wxExcelDataLabel::GetFormat ( )

Returns the ChartFormat object.

Since Excel 2007.

MSDN documentation for DataLabel.Format.

◆ GetHorizontalAlignment()

long wxAutoExcel::wxExcelDataLabel::GetHorizontalAlignment ( )

Returns a Variant value that represents the horizontal alignment for the specified object.

MSDN documentation for DataLabel.HorizontalAlignment.

◆ SetHorizontalAlignment()

void wxAutoExcel::wxExcelDataLabel::SetHorizontalAlignment ( long horizontalAlignment )

Sets a Variant value that represents the horizontal alignment for the specified object.

MSDN documentation for DataLabel.HorizontalAlignment.

◆ GetLeft()

double wxAutoExcel::wxExcelDataLabel::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 DataLabel.Left.

◆ SetLeft()

void wxAutoExcel::wxExcelDataLabel::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 DataLabel.Left.

◆ GetName()

wxString wxAutoExcel::wxExcelDataLabel::GetName ( )

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

MSDN documentation for DataLabel.Name.

◆ GetNumberFormat()

wxString wxAutoExcel::wxExcelDataLabel::GetNumberFormat ( )

Returns a String value that represents the format code for the object.

MSDN documentation for DataLabel.NumberFormat.

◆ SetNumberFormat()

void wxAutoExcel::wxExcelDataLabel::SetNumberFormat ( const wxString & numberFormat )

Sets a String value that represents the format code for the object.

MSDN documentation for DataLabel.NumberFormat.

◆ GetNumberFormatLinked()

bool wxAutoExcel::wxExcelDataLabel::GetNumberFormatLinked ( )

True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

MSDN documentation for DataLabel.NumberFormatLinked.

◆ SetNumberFormatLinked()

void wxAutoExcel::wxExcelDataLabel::SetNumberFormatLinked ( bool numberFormatLinked )

True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

MSDN documentation for DataLabel.NumberFormatLinked.

◆ GetNumberFormatLocal()

wxString wxAutoExcel::wxExcelDataLabel::GetNumberFormatLocal ( )

Returns a Variant value that represents the format code for the object as a string in the language of the user.

MSDN documentation for DataLabel.NumberFormatLocal.

◆ SetNumberFormatLocal()

void wxAutoExcel::wxExcelDataLabel::SetNumberFormatLocal ( const wxString & numberFormatLocal )

Sets a Variant value that represents the format code for the object as a string in the language of the user.

MSDN documentation for DataLabel.NumberFormatLocal.

◆ GetOrientation()

long wxAutoExcel::wxExcelDataLabel::GetOrientation ( )

Returns a Variant value that represents the text orientation.

MSDN documentation for DataLabel.Orientation.

◆ SetOrientation()

void wxAutoExcel::wxExcelDataLabel::SetOrientation ( long orientation )

Sets a Variant value that represents the text orientation.

MSDN documentation for DataLabel.Orientation.

◆ GetPosition()

XlDataLabelPosition wxAutoExcel::wxExcelDataLabel::GetPosition ( )

Returns a XlDataLabelPosition value that represents the position of the data label.

MSDN documentation for DataLabel.Position.

◆ SetPosition()

void wxAutoExcel::wxExcelDataLabel::SetPosition ( XlDataLabelPosition position )

Sets a XlDataLabelPosition value that represents the position of the data label.

MSDN documentation for DataLabel.Position.

◆ GetReadingOrder()

long wxAutoExcel::wxExcelDataLabel::GetReadingOrder ( )

Returns the reading order for the specified object.

Can be one of the following constants: xlRTL (right-to-left), xlLTR (left-to-right), or xlContext.

MSDN documentation for DataLabel.ReadingOrder.

◆ SetReadingOrder()

void wxAutoExcel::wxExcelDataLabel::SetReadingOrder ( long readingOrder )

Sets the reading order for the specified object.

Can be one of the following constants: xlRTL (right-to-left), xlLTR (left-to-right), or xlContext.

MSDN documentation for DataLabel.ReadingOrder.

◆ GetSeparator()

wxString wxAutoExcel::wxExcelDataLabel::GetSeparator ( )

Returns a Variant representing the separator used for the data labels on a chart.

MSDN documentation for DataLabel.Separator.

◆ SetSeparator()

void wxAutoExcel::wxExcelDataLabel::SetSeparator ( const wxString & separator )

Sets a Variant representing the separator used for the data labels on a chart.

MSDN documentation for DataLabel.Separator.

◆ GetShadow()

bool wxAutoExcel::wxExcelDataLabel::GetShadow ( )

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

MSDN documentation for DataLabel.Shadow.

◆ SetShadow()

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

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

MSDN documentation for DataLabel.Shadow.

◆ GetShowBubbleSize()

bool wxAutoExcel::wxExcelDataLabel::GetShowBubbleSize ( )

True to show the bubble size for the data labels on a chart.

False to hide.

MSDN documentation for DataLabel.ShowBubbleSize.

◆ SetShowBubbleSize()

void wxAutoExcel::wxExcelDataLabel::SetShowBubbleSize ( bool showBubbleSize )

True to show the bubble size for the data labels on a chart.

False to hide.

MSDN documentation for DataLabel.ShowBubbleSize.

◆ GetShowCategoryName()

bool wxAutoExcel::wxExcelDataLabel::GetShowCategoryName ( )

True to display the category name for the data labels on a chart.

False to hide.

MSDN documentation for DataLabel.ShowCategoryName.

◆ SetShowCategoryName()

void wxAutoExcel::wxExcelDataLabel::SetShowCategoryName ( bool showCategoryName )

True to display the category name for the data labels on a chart.

False to hide.

MSDN documentation for DataLabel.ShowCategoryName.

◆ GetShowLegendKey()

bool wxAutoExcel::wxExcelDataLabel::GetShowLegendKey ( )

True if the data label legend key is visible.

MSDN documentation for DataLabel.ShowLegendKey.

◆ SetShowLegendKey()

void wxAutoExcel::wxExcelDataLabel::SetShowLegendKey ( bool showLegendKey )

True if the data label legend key is visible.

MSDN documentation for DataLabel.ShowLegendKey.

◆ GetShowPercentage()

bool wxAutoExcel::wxExcelDataLabel::GetShowPercentage ( )

True to display the percentage value for the data labels on a chart.

False to hide.

MSDN documentation for DataLabel.ShowPercentage.

◆ SetShowPercentage()

void wxAutoExcel::wxExcelDataLabel::SetShowPercentage ( bool showPercentage )

True to display the percentage value for the data labels on a chart.

False to hide.

MSDN documentation for DataLabel.ShowPercentage.

◆ GetShowRange()

bool wxAutoExcel::wxExcelDataLabel::GetShowRange ( )

Toggles the Range field if it exists on the data label range.

Excel VBA documentation for DataLabel.ShowRange

◆ SetShowRange()

void wxAutoExcel::wxExcelDataLabel::SetShowRange ( bool showRange )

Toggles the Range field if it exists on the data label range.

Excel VBA documentation for DataLabel.ShowRange

◆ GetShowSeriesName()

bool wxAutoExcel::wxExcelDataLabel::GetShowSeriesName ( )

Returns a Boolean to indicate the series name display behavior for the data labels on a chart.

True to show the series name. False to hide.

MSDN documentation for DataLabel.ShowSeriesName.

◆ SetShowSeriesName()

void wxAutoExcel::wxExcelDataLabel::SetShowSeriesName ( bool showSeriesName )

Sets a Boolean to indicate the series name display behavior for the data labels on a chart.

True to show the series name. False to hide.

MSDN documentation for DataLabel.ShowSeriesName.

◆ GetShowValue()

bool wxAutoExcel::wxExcelDataLabel::GetShowValue ( )

Returns a Boolean corresponding to a specified chart's data label values display behavior.

True displays the values. False to hide.

MSDN documentation for DataLabel.ShowValue.

◆ SetShowValue()

void wxAutoExcel::wxExcelDataLabel::SetShowValue ( bool showValue )

Sets a Boolean corresponding to a specified chart's data label values display behavior.

True displays the values. False to hide.

MSDN documentation for DataLabel.ShowValue.

◆ GetText()

wxString wxAutoExcel::wxExcelDataLabel::GetText ( )

Returns the text for the specified object.

MSDN documentation for DataLabel.Text.

◆ SetText()

void wxAutoExcel::wxExcelDataLabel::SetText ( const wxString & text )

Sets the text for the specified object.

MSDN documentation for DataLabel.Text.

◆ GetTop()

double wxAutoExcel::wxExcelDataLabel::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 DataLabel.Top.

◆ SetTop()

void wxAutoExcel::wxExcelDataLabel::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 DataLabel.Top.

◆ GetVerticalAlignment()

long wxAutoExcel::wxExcelDataLabel::GetVerticalAlignment ( )

Returns a Variant value that represents the vertical alignment of the specified object.

MSDN documentation for DataLabel.VerticalAlignment.

◆ SetVerticalAlignment()

void wxAutoExcel::wxExcelDataLabel::SetVerticalAlignment ( long verticalAlignment )

Sets a Variant value that represents the vertical alignment of the specified object.

MSDN documentation for DataLabel.VerticalAlignment.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "DataLabel".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Delete()

◆ Select()

◆ GetAutoScaleFont()

◆ SetAutoScaleFont()

◆ GetAutoText()

◆ SetAutoText()

◆ GetCaption()

◆ SetCaption()

◆ GetCharacters()

◆ GetFormat()

◆ GetHorizontalAlignment()

◆ SetHorizontalAlignment()

◆ GetLeft()

◆ SetLeft()

◆ GetName()

◆ GetNumberFormat()

◆ SetNumberFormat()

◆ GetNumberFormatLinked()

◆ SetNumberFormatLinked()

◆ GetNumberFormatLocal()

◆ SetNumberFormatLocal()

◆ GetOrientation()

◆ SetOrientation()

◆ GetPosition()

◆ SetPosition()

◆ GetReadingOrder()

◆ SetReadingOrder()

◆ GetSeparator()

◆ SetSeparator()

◆ GetShadow()

◆ SetShadow()

◆ GetShowBubbleSize()

◆ SetShowBubbleSize()

◆ GetShowCategoryName()

◆ SetShowCategoryName()

◆ GetShowLegendKey()

◆ SetShowLegendKey()

◆ GetShowPercentage()

◆ SetShowPercentage()

◆ GetShowRange()

◆ SetShowRange()

◆ GetShowSeriesName()

◆ SetShowSeriesName()

◆ GetShowValue()

◆ SetShowValue()

◆ GetText()

◆ SetText()

◆ GetTop()

◆ SetTop()

◆ GetVerticalAlignment()

◆ SetVerticalAlignment()

◆ GetAutoExcelObjectName_()