Represents Microsoft Excel ChartTitle object. More...

#include <wxAutoExcelChartTitle.h>

Inheritance diagram for wxAutoExcel::wxExcelChartTitle:

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.

wxString	GetCaption ()
	Returns a String value that represents the chart title text.

void	SetCaption (const wxString &caption)
	Sets a String value that represents the chart title 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.

wxString	GetFormula ()
	Returns a String value that represents the object's formula in A1-style notation and in the language of the macro.

void	SetFormula (const wxString &formula)
	Sets a String value that represents the object's formula in A1-style notation and in the language of the macro.

wxString	GetFormulaLocal ()
	Returns the formula for the object, using A1-style references in the language of the user.

void	SetFormulaLocal (const wxString &formulaLocal)
	Sets the formula for the object, using A1-style references in the language of the user.

wxString	GetFormulaR1C1 ()
	Returns the formula for the object, using R1C1-style notation in the language of the macro.

void	SetFormulaR1C1 (const wxString &formulaR1C1)
	Sets the formula for the object, using R1C1-style notation in the language of the macro.

wxString	GetFormulaR1C1Local ()
	Returns the formula for the object, using R1C1-style notation in the language of the user.

void	SetFormulaR1C1Local (const wxString &formulaR1C1Local)
	Sets the formula for the object, using R1C1-style notation in the language of the user.

double	GetHeight ()
	Returns the height, in points, of the 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.

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

void	SetIncludeInLayout (bool includeInLayout)
	True if a chart title 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.

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

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

XlChartElementPosition	GetPosition ()
	Returns the position of the chart title on the chart.

void	SetPosition (XlChartElementPosition position)
	Sets the position of the chart title on the chart.

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

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

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.

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.

double	GetWidth ()
	Returns the width, in points, of the object.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "ChartTitle".

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

Member Function Documentation

◆ Delete()

bool wxAutoExcel::wxExcelChartTitle::Delete ( )

Deletes the object.

MSDN documentation for ChartTitle.Delete.

◆ Select()

bool wxAutoExcel::wxExcelChartTitle::Select ( )

Selects the object.

MSDN documentation for ChartTitle.Select.

◆ GetAutoScaleFont()

bool wxAutoExcel::wxExcelChartTitle::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 ChartTitle.AutoScaleFont.

◆ SetAutoScaleFont()

void wxAutoExcel::wxExcelChartTitle::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 ChartTitle.AutoScaleFont.

◆ GetCaption()

wxString wxAutoExcel::wxExcelChartTitle::GetCaption ( )

Returns a String value that represents the chart title text.

MSDN documentation for ChartTitle.Caption.

◆ SetCaption()

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

Sets a String value that represents the chart title text.

MSDN documentation for ChartTitle.Caption.

◆ GetCharacters()

wxExcelCharacters wxAutoExcel::wxExcelChartTitle::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 ChartTitle.Characters.

◆ GetFormat()

wxExcelChartFormat wxAutoExcel::wxExcelChartTitle::GetFormat ( )

Returns the ChartFormat object.

Since Excel 2007.

MSDN documentation for ChartTitle.Format.

◆ GetFormula()

wxString wxAutoExcel::wxExcelChartTitle::GetFormula ( )

Returns a String value that represents the object's formula in A1-style notation and in the language of the macro.

Since Excel 2010.

MSDN documentation for ChartTitle.Formula.

◆ SetFormula()

void wxAutoExcel::wxExcelChartTitle::SetFormula ( const wxString & formula )

Sets a String value that represents the object's formula in A1-style notation and in the language of the macro.

Since Excel 2010.

MSDN documentation for ChartTitle.Formula.

◆ GetFormulaLocal()

wxString wxAutoExcel::wxExcelChartTitle::GetFormulaLocal ( )

Returns the formula for the object, using A1-style references in the language of the user.

Since Excel 2010.

MSDN documentation for ChartTitle.FormulaLocal.

◆ SetFormulaLocal()

void wxAutoExcel::wxExcelChartTitle::SetFormulaLocal ( const wxString & formulaLocal )

Sets the formula for the object, using A1-style references in the language of the user.

Since Excel 2010.

MSDN documentation for ChartTitle.FormulaLocal.

◆ GetFormulaR1C1()

wxString wxAutoExcel::wxExcelChartTitle::GetFormulaR1C1 ( )

Returns the formula for the object, using R1C1-style notation in the language of the macro.

Since Excel 2010.

MSDN documentation for ChartTitle.FormulaR1C1.

◆ SetFormulaR1C1()

void wxAutoExcel::wxExcelChartTitle::SetFormulaR1C1 ( const wxString & formulaR1C1 )

Sets the formula for the object, using R1C1-style notation in the language of the macro.

Since Excel 2010.

MSDN documentation for ChartTitle.FormulaR1C1.

◆ GetFormulaR1C1Local()

wxString wxAutoExcel::wxExcelChartTitle::GetFormulaR1C1Local ( )

Returns the formula for the object, using R1C1-style notation in the language of the user.

Since Excel 2010.

MSDN documentation for ChartTitle.FormulaR1C1Local.

◆ SetFormulaR1C1Local()

void wxAutoExcel::wxExcelChartTitle::SetFormulaR1C1Local ( const wxString & formulaR1C1Local )

Sets the formula for the object, using R1C1-style notation in the language of the user.

Since Excel 2010.

MSDN documentation for ChartTitle.FormulaR1C1Local.

◆ GetHeight()

double wxAutoExcel::wxExcelChartTitle::GetHeight ( )

Returns the height, in points, of the object.

Since Excel 2010.

MSDN documentation for ChartTitle.Height.

◆ GetHorizontalAlignment()

long wxAutoExcel::wxExcelChartTitle::GetHorizontalAlignment ( )

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

MSDN documentation for ChartTitle.HorizontalAlignment.

◆ SetHorizontalAlignment()

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

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

MSDN documentation for ChartTitle.HorizontalAlignment.

◆ GetIncludeInLayout()

bool wxAutoExcel::wxExcelChartTitle::GetIncludeInLayout ( )

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

Since Excel 2007.

MSDN documentation for ChartTitle.IncludeInLayout.

◆ SetIncludeInLayout()

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

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

Since Excel 2007.

MSDN documentation for ChartTitle.IncludeInLayout.

◆ GetLeft()

double wxAutoExcel::wxExcelChartTitle::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 ChartTitle.Left.

◆ SetLeft()

void wxAutoExcel::wxExcelChartTitle::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 ChartTitle.Left.

◆ GetName()

wxString wxAutoExcel::wxExcelChartTitle::GetName ( )

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

MSDN documentation for ChartTitle.Name.

◆ GetOrientation()

long wxAutoExcel::wxExcelChartTitle::GetOrientation ( )

Returns a Variant value that represents the text orientation.

MSDN documentation for ChartTitle.Orientation.

◆ SetOrientation()

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

Sets a Variant value that represents the text orientation.

MSDN documentation for ChartTitle.Orientation.

◆ GetPosition()

XlChartElementPosition wxAutoExcel::wxExcelChartTitle::GetPosition ( )

Returns the position of the chart title on the chart.

Since Excel 2007.

MSDN documentation for ChartTitle.Position.

◆ SetPosition()

void wxAutoExcel::wxExcelChartTitle::SetPosition ( XlChartElementPosition position )

Sets the position of the chart title on the chart.

Since Excel 2007.

MSDN documentation for ChartTitle.Position.

◆ GetReadingOrder()

long wxAutoExcel::wxExcelChartTitle::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 ChartTitle.ReadingOrder.

◆ SetReadingOrder()

void wxAutoExcel::wxExcelChartTitle::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 ChartTitle.ReadingOrder.

◆ GetShadow()

bool wxAutoExcel::wxExcelChartTitle::GetShadow ( )

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

MSDN documentation for ChartTitle.Shadow.

◆ SetShadow()

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

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

MSDN documentation for ChartTitle.Shadow.

◆ GetText()

wxString wxAutoExcel::wxExcelChartTitle::GetText ( )

Returns the text for the specified object.

MSDN documentation for ChartTitle.Text.

◆ SetText()

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

Sets the text for the specified object.

MSDN documentation for ChartTitle.Text.

◆ GetTop()

double wxAutoExcel::wxExcelChartTitle::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 ChartTitle.Top.

◆ SetTop()

void wxAutoExcel::wxExcelChartTitle::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 ChartTitle.Top.

◆ GetVerticalAlignment()

long wxAutoExcel::wxExcelChartTitle::GetVerticalAlignment ( )

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

MSDN documentation for ChartTitle.VerticalAlignment.

◆ SetVerticalAlignment()

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

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

MSDN documentation for ChartTitle.VerticalAlignment.

◆ GetWidth()

double wxAutoExcel::wxExcelChartTitle::GetWidth ( )

Returns the width, in points, of the object.

Since Excel 2010.

MSDN documentation for ChartTitle.Width.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "ChartTitle".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Delete()

◆ Select()

◆ GetAutoScaleFont()

◆ SetAutoScaleFont()

◆ GetCaption()

◆ SetCaption()

◆ GetCharacters()

◆ GetFormat()

◆ GetFormula()

◆ SetFormula()

◆ GetFormulaLocal()

◆ SetFormulaLocal()

◆ GetFormulaR1C1()

◆ SetFormulaR1C1()

◆ GetFormulaR1C1Local()

◆ SetFormulaR1C1Local()

◆ GetHeight()

◆ GetHorizontalAlignment()

◆ SetHorizontalAlignment()

◆ GetIncludeInLayout()

◆ SetIncludeInLayout()

◆ GetLeft()

◆ SetLeft()

◆ GetName()

◆ GetOrientation()

◆ SetOrientation()

◆ GetPosition()

◆ SetPosition()

◆ GetReadingOrder()

◆ SetReadingOrder()

◆ GetShadow()

◆ SetShadow()

◆ GetText()

◆ SetText()

◆ GetTop()

◆ SetTop()

◆ GetVerticalAlignment()

◆ SetVerticalAlignment()

◆ GetWidth()

◆ GetAutoExcelObjectName_()