wxAutoExcel  2.0.0
wxAutoExcel::wxExcelSparkVerticalAxis Class Reference

Represents Microsoft Excel SparkVerticalAxis object. More...

Inheritance diagram for wxAutoExcel::wxExcelSparkVerticalAxis:
wxAutoExcel::wxExcelObject

Public Member Functions

double GetCustomMaxScaleValue ()
 Returns the custom maximum value for the vertical axis of a sparkline. More...
 
void SetCustomMaxScaleValue (double customMaxScaleValue)
 Sets the custom maximum value for the vertical axis of a sparkline. More...
 
double GetCustomMinScaleValue ()
 Returns the custom minimum value for the vertical axis of a sparkline. More...
 
void SetCustomMinScaleValue (double customMinScaleValue)
 Sets the custom minimum value for the vertical axis of a sparkline. More...
 
XlSparkScale GetMaxScaleType ()
 Returns how the maximum value of the vertical axis of the sparkline is scaled relative to other sparklines in the group. More...
 
void SetMaxScaleType (XlSparkScale maxScaleType)
 Sets how the maximum value of the vertical axis of the sparkline is scaled relative to other sparklines in the group. More...
 
XlSparkScale GetMinScaleType ()
 Returns how the minimum value of the vertical axis of the sparkline is scaled relative to other sparklines in the group. More...
 
void SetMinScaleType (XlSparkScale minScaleType)
 Sets how the minimum value of the vertical axis of the sparkline is scaled relative to other sparklines in the group. More...
 
wxExcelSparklineGroup GetParent ()
 Returns the parent SparklineGroup object for the specified object. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "SparkVerticalAxis". 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 SparkVerticalAxis object.

Since Excel 2010.

Member Function Documentation

◆ GetCustomMaxScaleValue()

double wxAutoExcel::wxExcelSparkVerticalAxis::GetCustomMaxScaleValue ( )

Returns the custom maximum value for the vertical axis of a sparkline.

MSDN documentation for SparkVerticalAxis.CustomMaxScaleValue.

◆ SetCustomMaxScaleValue()

void wxAutoExcel::wxExcelSparkVerticalAxis::SetCustomMaxScaleValue ( double  customMaxScaleValue)

Sets the custom maximum value for the vertical axis of a sparkline.

MSDN documentation for SparkVerticalAxis.CustomMaxScaleValue.

◆ GetCustomMinScaleValue()

double wxAutoExcel::wxExcelSparkVerticalAxis::GetCustomMinScaleValue ( )

Returns the custom minimum value for the vertical axis of a sparkline.

MSDN documentation for SparkVerticalAxis.CustomMinScaleValue.

◆ SetCustomMinScaleValue()

void wxAutoExcel::wxExcelSparkVerticalAxis::SetCustomMinScaleValue ( double  customMinScaleValue)

Sets the custom minimum value for the vertical axis of a sparkline.

MSDN documentation for SparkVerticalAxis.CustomMinScaleValue.

◆ GetMaxScaleType()

XlSparkScale wxAutoExcel::wxExcelSparkVerticalAxis::GetMaxScaleType ( )

Returns how the maximum value of the vertical axis of the sparkline is scaled relative to other sparklines in the group.

MSDN documentation for SparkVerticalAxis.MaxScaleType.

◆ SetMaxScaleType()

void wxAutoExcel::wxExcelSparkVerticalAxis::SetMaxScaleType ( XlSparkScale  maxScaleType)

Sets how the maximum value of the vertical axis of the sparkline is scaled relative to other sparklines in the group.

MSDN documentation for SparkVerticalAxis.MaxScaleType.

◆ GetMinScaleType()

XlSparkScale wxAutoExcel::wxExcelSparkVerticalAxis::GetMinScaleType ( )

Returns how the minimum value of the vertical axis of the sparkline is scaled relative to other sparklines in the group.

MSDN documentation for SparkVerticalAxis.MinScaleType.

◆ SetMinScaleType()

void wxAutoExcel::wxExcelSparkVerticalAxis::SetMinScaleType ( XlSparkScale  minScaleType)

Sets how the minimum value of the vertical axis of the sparkline is scaled relative to other sparklines in the group.

MSDN documentation for SparkVerticalAxis.MinScaleType.

◆ GetParent()

wxExcelSparklineGroup wxAutoExcel::wxExcelSparkVerticalAxis::GetParent ( )

Returns the parent SparklineGroup object for the specified object.

MSDN documentation for SparkVerticalAxis.Parent.

◆ GetAutoExcelObjectName_()

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

Returns "SparkVerticalAxis".

Reimplemented from wxAutoExcel::wxExcelObject.