Represents Microsoft Excel TickLabels object. More...

#include <wxAutoExcelTickLabels.h>

Inheritance diagram for wxAutoExcel::wxExcelTickLabels:

Public Member Functions
bool	Delete ()
	Deletes the object.

bool	Select ()
	Selects the object.

long	GetAlignment ()
	Returns a Long value that represents the alignment for the specified phonetic text or tick label.

void	SetAlignment (long alignment)
	Sets a Long value that represents the alignment for the specified phonetic text or tick label.

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.

long	GetDepth ()
	Returns a Long value that represents the number of levels of category tick labels.

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

wxExcelChartFormat	GetFormat ()
	Returns the ChartFormat object.

bool	GetMultiLevel ()
	Sets whether an axis is multilevel or not.

void	SetMultiLevel (bool multiLevel)
	Sets whether an axis is multilevel or not.

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	GetOffset ()
	Returns a Long value that represents the distance between the levels of labels, and the distance between the first level and the axis line.

void	SetOffset (long offset)
	Sets a Long value that represents the distance between the levels of labels, and the distance between the first level and the axis line.

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

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

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

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

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "TickLabels".

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

Member Function Documentation

◆ Delete()

bool wxAutoExcel::wxExcelTickLabels::Delete ( )

Deletes the object.

MSDN documentation for TickLabels.Delete.

◆ Select()

bool wxAutoExcel::wxExcelTickLabels::Select ( )

Selects the object.

MSDN documentation for TickLabels.Select.

◆ GetAlignment()

long wxAutoExcel::wxExcelTickLabels::GetAlignment ( )

Returns a Long value that represents the alignment for the specified phonetic text or tick label.

MSDN documentation for TickLabels.Alignment.

◆ SetAlignment()

void wxAutoExcel::wxExcelTickLabels::SetAlignment ( long alignment )

Sets a Long value that represents the alignment for the specified phonetic text or tick label.

MSDN documentation for TickLabels.Alignment.

◆ GetAutoScaleFont()

bool wxAutoExcel::wxExcelTickLabels::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 TickLabels.AutoScaleFont.

◆ SetAutoScaleFont()

void wxAutoExcel::wxExcelTickLabels::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 TickLabels.AutoScaleFont.

◆ GetDepth()

long wxAutoExcel::wxExcelTickLabels::GetDepth ( )

Returns a Long value that represents the number of levels of category tick labels.

MSDN documentation for TickLabels.Depth.

◆ GetFont()

wxExcelFont wxAutoExcel::wxExcelTickLabels::GetFont ( )

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

MSDN documentation for TickLabels.Font.

◆ GetFormat()

wxExcelChartFormat wxAutoExcel::wxExcelTickLabels::GetFormat ( )

Returns the ChartFormat object.

Since Excel 2007.

MSDN documentation for TickLabels.Format.

◆ GetMultiLevel()

bool wxAutoExcel::wxExcelTickLabels::GetMultiLevel ( )

Sets whether an axis is multilevel or not.

Since Excel 2007.

MSDN documentation for TickLabels.MultiLevel.

◆ SetMultiLevel()

void wxAutoExcel::wxExcelTickLabels::SetMultiLevel ( bool multiLevel )

Sets whether an axis is multilevel or not.

Since Excel 2007.

MSDN documentation for TickLabels.MultiLevel.

◆ GetName()

wxString wxAutoExcel::wxExcelTickLabels::GetName ( )

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

MSDN documentation for TickLabels.Name.

◆ GetNumberFormat()

wxString wxAutoExcel::wxExcelTickLabels::GetNumberFormat ( )

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

MSDN documentation for TickLabels.NumberFormat.

◆ SetNumberFormat()

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

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

MSDN documentation for TickLabels.NumberFormat.

◆ GetNumberFormatLinked()

bool wxAutoExcel::wxExcelTickLabels::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 TickLabels.NumberFormatLinked.

◆ SetNumberFormatLinked()

void wxAutoExcel::wxExcelTickLabels::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 TickLabels.NumberFormatLinked.

◆ GetNumberFormatLocal()

wxString wxAutoExcel::wxExcelTickLabels::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 TickLabels.NumberFormatLocal.

◆ SetNumberFormatLocal()

void wxAutoExcel::wxExcelTickLabels::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 TickLabels.NumberFormatLocal.

◆ GetOffset()

long wxAutoExcel::wxExcelTickLabels::GetOffset ( )

Returns a Long value that represents the distance between the levels of labels, and the distance between the first level and the axis line.

MSDN documentation for TickLabels.Offset.

◆ SetOffset()

void wxAutoExcel::wxExcelTickLabels::SetOffset ( long offset )

Sets a Long value that represents the distance between the levels of labels, and the distance between the first level and the axis line.

MSDN documentation for TickLabels.Offset.

◆ GetOrientation()

long wxAutoExcel::wxExcelTickLabels::GetOrientation ( )

Returns a Long value that represents the text orientation.

MSDN documentation for TickLabels.Orientation.

◆ SetOrientation()

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

Sets a Long value that represents the text orientation.

MSDN documentation for TickLabels.Orientation.

◆ GetReadingOrder()

long wxAutoExcel::wxExcelTickLabels::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 TickLabels.ReadingOrder.

◆ SetReadingOrder()

void wxAutoExcel::wxExcelTickLabels::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 TickLabels.ReadingOrder.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "TickLabels".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Delete()

◆ Select()

◆ GetAlignment()

◆ SetAlignment()

◆ GetAutoScaleFont()

◆ SetAutoScaleFont()

◆ GetDepth()

◆ GetFont()

◆ GetFormat()

◆ GetMultiLevel()

◆ SetMultiLevel()

◆ GetName()

◆ GetNumberFormat()

◆ SetNumberFormat()

◆ GetNumberFormatLinked()

◆ SetNumberFormatLinked()

◆ GetNumberFormatLocal()

◆ SetNumberFormatLocal()

◆ GetOffset()

◆ SetOffset()

◆ GetOrientation()

◆ SetOrientation()

◆ GetReadingOrder()

◆ SetReadingOrder()

◆ GetAutoExcelObjectName_()