wxAutoExcel  2.0.0
wxAutoExcel::wxExcelAxisTitle Class Reference

Represents Microsoft Excel AxisTitle object. More...

Inheritance diagram for wxAutoExcel::wxExcelAxisTitle:
wxAutoExcel::wxExcelObject

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...
 
wxString GetCaption ()
 Returns a String value that represents the axis title text. More...
 
void SetCaption (const wxString &caption)
 Sets a String value that represents the axis title text. More...
 
wxExcelCharacters GetCharacters (long start=1, long *length=NULL)
 Returns a Characters object that represents a range of characters within the object text. More...
 
wxExcelChartFormat GetFormat ()
 Returns the ChartFormat object. More...
 
wxString GetFormula ()
 Returns a String value that represents the object's formula in A1-style notation and in the language of the macro. More...
 
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. More...
 
wxString GetFormulaLocal ()
 Returns the formula for the object, using A1-style references in the language of the user. More...
 
void SetFormulaLocal (const wxString &formulaLocal)
 Sets the formula for the object, using A1-style references in the language of the user. More...
 
wxString GetFormulaR1C1 ()
 Returns the formula for the object, using R1C1-style notation in the language of the macro. More...
 
void SetFormulaR1C1 (const wxString &formulaR1C1)
 Sets the formula for the object, using R1C1-style notation in the language of the macro. More...
 
wxString GetFormulaR1C1Local ()
 Returns the formula for the object, using R1C1-style notation in the language of the user. More...
 
void SetFormulaR1C1Local (const wxString &formulaR1C1Local)
 Sets the formula for the object, using R1C1-style notation in the language of the user. More...
 
long GetHorizontalAlignment ()
 Returns a Variant value that represents the horizontal alignment for the specified object. More...
 
void SetHorizontalAlignment (long horizontalAlignment)
 Sets a Variant value that represents the horizontal alignment for the specified object. More...
 
bool GetIncludeInLayout ()
 True if an axis title will occupy the chart layout space when a chart layout is being determined. More...
 
void SetIncludeInLayout (bool includeInLayout)
 True if an axis title will occupy the chart layout space when a chart layout is being determined. 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 column A (on a worksheet) or the left edge of the chart area (on a chart). More...
 
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). More...
 
wxString GetName ()
 Returns a String value that represents the name of the object. More...
 
long GetOrientation ()
 Returns a Variant value that represents the text orientation. More...
 
void SetOrientation (long orientation)
 Sets a Variant value that represents the text orientation. More...
 
XlChartElementPosition GetPosition ()
 Returns the position of the axis title on the chart. More...
 
void SetPosition (XlChartElementPosition position)
 Sets the position of the axis title on the chart. More...
 
long GetReadingOrder ()
 Returns the reading order for the specified object. More...
 
void SetReadingOrder (long readingOrder)
 Sets the reading order for the specified object. More...
 
bool GetShadow ()
 Returns a Boolean value that determines if the object has a shadow. More...
 
void SetShadow (bool shadow)
 Sets a Boolean value that determines if the object has a shadow. More...
 
wxString GetText ()
 Returns the text for the specified object. More...
 
void SetText (const wxString &text)
 Sets the text for the specified object. 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...
 
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). More...
 
long GetVerticalAlignment ()
 Returns a Variant value that represents the vertical alignment of the specified object. More...
 
void SetVerticalAlignment (long verticalAlignment)
 Sets a Variant value that represents the vertical alignment of the specified object. More...
 
double GetWidth ()
 Returns the width, in points, of the object. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "AxisTitle". 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 AxisTitle object.

Member Function Documentation

◆ Delete()

bool wxAutoExcel::wxExcelAxisTitle::Delete ( )

◆ Select()

bool wxAutoExcel::wxExcelAxisTitle::Select ( )

◆ GetAutoScaleFont()

bool wxAutoExcel::wxExcelAxisTitle::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 AxisTitle.AutoScaleFont.

◆ SetAutoScaleFont()

void wxAutoExcel::wxExcelAxisTitle::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 AxisTitle.AutoScaleFont.

◆ GetCaption()

wxString wxAutoExcel::wxExcelAxisTitle::GetCaption ( )

Returns a String value that represents the axis title text.

MSDN documentation for AxisTitle.Caption.

◆ SetCaption()

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

Sets a String value that represents the axis title text.

MSDN documentation for AxisTitle.Caption.

◆ GetCharacters()

wxExcelCharacters wxAutoExcel::wxExcelAxisTitle::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 AxisTitle.Characters.

◆ GetFormat()

wxExcelChartFormat wxAutoExcel::wxExcelAxisTitle::GetFormat ( )

Returns the ChartFormat object.

Since Excel 2007.

MSDN documentation for AxisTitle.Format.

◆ GetFormula()

wxString wxAutoExcel::wxExcelAxisTitle::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 AxisTitle.Formula.

◆ SetFormula()

void wxAutoExcel::wxExcelAxisTitle::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 AxisTitle.Formula.

◆ GetFormulaLocal()

wxString wxAutoExcel::wxExcelAxisTitle::GetFormulaLocal ( )

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

Since Excel 2010.

MSDN documentation for AxisTitle.FormulaLocal.

◆ SetFormulaLocal()

void wxAutoExcel::wxExcelAxisTitle::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 AxisTitle.FormulaLocal.

◆ GetFormulaR1C1()

wxString wxAutoExcel::wxExcelAxisTitle::GetFormulaR1C1 ( )

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

Since Excel 2010.

MSDN documentation for AxisTitle.FormulaR1C1.

◆ SetFormulaR1C1()

void wxAutoExcel::wxExcelAxisTitle::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 AxisTitle.FormulaR1C1.

◆ GetFormulaR1C1Local()

wxString wxAutoExcel::wxExcelAxisTitle::GetFormulaR1C1Local ( )

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

Since Excel 2010.

MSDN documentation for AxisTitle.FormulaR1C1Local.

◆ SetFormulaR1C1Local()

void wxAutoExcel::wxExcelAxisTitle::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 AxisTitle.FormulaR1C1Local.

◆ GetHorizontalAlignment()

long wxAutoExcel::wxExcelAxisTitle::GetHorizontalAlignment ( )

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

MSDN documentation for AxisTitle.HorizontalAlignment.

◆ SetHorizontalAlignment()

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

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

MSDN documentation for AxisTitle.HorizontalAlignment.

◆ GetIncludeInLayout()

bool wxAutoExcel::wxExcelAxisTitle::GetIncludeInLayout ( )

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

Since Excel 2007.

MSDN documentation for AxisTitle.IncludeInLayout.

◆ SetIncludeInLayout()

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

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

Since Excel 2007.

MSDN documentation for AxisTitle.IncludeInLayout.

◆ GetLeft()

double wxAutoExcel::wxExcelAxisTitle::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 AxisTitle.Left.

◆ SetLeft()

void wxAutoExcel::wxExcelAxisTitle::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 AxisTitle.Left.

◆ GetName()

wxString wxAutoExcel::wxExcelAxisTitle::GetName ( )

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

MSDN documentation for AxisTitle.Name.

◆ GetOrientation()

long wxAutoExcel::wxExcelAxisTitle::GetOrientation ( )

Returns a Variant value that represents the text orientation.

MSDN documentation for AxisTitle.Orientation.

◆ SetOrientation()

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

Sets a Variant value that represents the text orientation.

MSDN documentation for AxisTitle.Orientation.

◆ GetPosition()

XlChartElementPosition wxAutoExcel::wxExcelAxisTitle::GetPosition ( )

Returns the position of the axis title on the chart.

Since Excel 2007.

MSDN documentation for AxisTitle.Position.

◆ SetPosition()

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

Sets the position of the axis title on the chart.

Since Excel 2007.

MSDN documentation for AxisTitle.Position.

◆ GetReadingOrder()

long wxAutoExcel::wxExcelAxisTitle::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 AxisTitle.ReadingOrder.

◆ SetReadingOrder()

void wxAutoExcel::wxExcelAxisTitle::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 AxisTitle.ReadingOrder.

◆ GetShadow()

bool wxAutoExcel::wxExcelAxisTitle::GetShadow ( )

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

MSDN documentation for AxisTitle.Shadow.

◆ SetShadow()

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

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

MSDN documentation for AxisTitle.Shadow.

◆ GetText()

wxString wxAutoExcel::wxExcelAxisTitle::GetText ( )

Returns the text for the specified object.

MSDN documentation for AxisTitle.Text.

◆ SetText()

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

Sets the text for the specified object.

MSDN documentation for AxisTitle.Text.

◆ GetTop()

double wxAutoExcel::wxExcelAxisTitle::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 AxisTitle.Top.

◆ SetTop()

void wxAutoExcel::wxExcelAxisTitle::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 AxisTitle.Top.

◆ GetVerticalAlignment()

long wxAutoExcel::wxExcelAxisTitle::GetVerticalAlignment ( )

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

MSDN documentation for AxisTitle.VerticalAlignment.

◆ SetVerticalAlignment()

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

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

MSDN documentation for AxisTitle.VerticalAlignment.

◆ GetWidth()

double wxAutoExcel::wxExcelAxisTitle::GetWidth ( )

Returns the width, in points, of the object.

Since Excel 2010.

MSDN documentation for AxisTitle.Width.

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelAxisTitle::GetAutoExcelObjectName_ ( ) const
inlinevirtual

Returns "AxisTitle".

Reimplemented from wxAutoExcel::wxExcelObject.