Represents Microsoft Excel Trendline object. More...

Inheritance diagram for wxAutoExcel::wxExcelTrendline:

Public Member Functions
bool	ClearFormats ()
	Clears the formatting of the object. More...

bool	Delete ()
	Deletes the object. More...

bool	Select ()
	Selects the object. More...

long	GetBackward ()
	Returns the number of periods (or units on a scatter chart) that the trendline extends backward. More...

void	SetBackward (long backward)
	Sets the number of periods (or units on a scatter chart) that the trendline extends backward. More...

double	GetBackward2 ()
	Returns the number of periods (or units on a scatter chart) that the trendline extends backward. More...

void	SetBackward2 (double backward2)
	Sets the number of periods (or units on a scatter chart) that the trendline extends backward. More...

wxExcelBorder	GetBorder ()
	Returns a Border object that represents the border of the object. More...

wxExcelDataLabel	GetDataLabel ()
	Returns a DataLabel object that represents the data label associated with the trendline. More...

bool	GetDisplayEquation ()
	True if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value). More...

void	SetDisplayEquation (bool displayEquation)
	True if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value). More...

bool	GetDisplayRSquared ()
	True if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation). More...

void	SetDisplayRSquared (bool displayRSquared)
	True if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation). More...

wxExcelChartFormat	GetFormat ()
	Read-only Since Excel 2007. More...

long	GetForward ()
	Returns the number of periods (or units on a scatter chart) that the trendline extends forward. More...

void	SetForward (long forward)
	Sets the number of periods (or units on a scatter chart) that the trendline extends forward. More...

double	GetForward2 ()
	Returns the ChartFormat object. More...

void	SetForward2 (double forward2)
	Returns the ChartFormat object. More...

long	GetIndex ()
	Returns a Long value that represents the index number of the object within the collection of similar objects. More...

double	GetIntercept ()
	Returns the point where the trendline crosses the value axis. More...

void	SetIntercept (double intercept)
	Sets the point where the trendline crosses the value axis. More...

bool	GetInterceptIsAuto ()
	True if the point where the trendline crosses the value axis is automatically determined by the regression. More...

void	SetInterceptIsAuto (bool interceptIsAuto)
	True if the point where the trendline crosses the value axis is automatically determined by the regression. More...

wxString	GetName ()
	Returns a String value representing the name of the object. More...

void	SetName (const wxString &name)
	Sets a String value representing the name of the object. More...

bool	GetNameIsAuto ()
	True if Microsoft Excel automatically determines the name of the trendline. More...

void	SetNameIsAuto (bool nameIsAuto)
	True if Microsoft Excel automatically determines the name of the trendline. More...

long	GetOrder ()
	Returns a Long value that represents the trendline order (an integer greater than 1) when the trendline type is xlPolynomial. More...

void	SetOrder (long order)
	Sets a Long value that represents the trendline order (an integer greater than 1) when the trendline type is xlPolynomial. More...

long	GetPeriod ()
	Returns the period for the moving-average trendline. More...

void	SetPeriod (long period)
	Sets the period for the moving-average trendline. More...

XlTrendlineType	GetType ()
	Returns a XlTrendlineType value that represents the trendline type. More...

void	SetType (XlTrendlineType type)
	Sets a XlTrendlineType value that represents the trendline type. More...

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Trendline". 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 Trendline object.

Member Function Documentation

◆ ClearFormats()

bool wxAutoExcel::wxExcelTrendline::ClearFormats ( )

Clears the formatting of the object.

[MSDN documentation for Trendline.ClearFormats]().

◆ Delete()

bool wxAutoExcel::wxExcelTrendline::Delete ( )

Deletes the object.

MSDN documentation for Trendline.Delete.

◆ Select()

bool wxAutoExcel::wxExcelTrendline::Select ( )

Selects the object.

MSDN documentation for Trendline.Select.

◆ GetBackward()

long wxAutoExcel::wxExcelTrendline::GetBackward ( )

Returns the number of periods (or units on a scatter chart) that the trendline extends backward.

Read/write Long

MSDN documentation for Trendline.Backward.

◆ SetBackward()

void wxAutoExcel::wxExcelTrendline::SetBackward ( long backward )

Sets the number of periods (or units on a scatter chart) that the trendline extends backward.

Read/write Long

MSDN documentation for Trendline.Backward.

◆ GetBackward2()

double wxAutoExcel::wxExcelTrendline::GetBackward2 ( )

Returns the number of periods (or units on a scatter chart) that the trendline extends backward.

Since Excel 2007.

MSDN documentation for Trendline.Backward2.

◆ SetBackward2()

void wxAutoExcel::wxExcelTrendline::SetBackward2 ( double backward2 )

Sets the number of periods (or units on a scatter chart) that the trendline extends backward.

Since Excel 2007.

MSDN documentation for Trendline.Backward2.

◆ GetBorder()

wxExcelBorder wxAutoExcel::wxExcelTrendline::GetBorder ( )

Returns a Border object that represents the border of the object.

MSDN documentation for Trendline.Border.

◆ GetDataLabel()

wxExcelDataLabel wxAutoExcel::wxExcelTrendline::GetDataLabel ( )

Returns a DataLabel object that represents the data label associated with the trendline.

MSDN documentation for Trendline.DataLabel.

◆ GetDisplayEquation()

bool wxAutoExcel::wxExcelTrendline::GetDisplayEquation ( )

True if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value).

Setting this property to True automatically turns on data labels.

MSDN documentation for Trendline.DisplayEquation.

◆ SetDisplayEquation()

void wxAutoExcel::wxExcelTrendline::SetDisplayEquation ( bool displayEquation )

True if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value).

Setting this property to True automatically turns on data labels.

MSDN documentation for Trendline.DisplayEquation.

◆ GetDisplayRSquared()

bool wxAutoExcel::wxExcelTrendline::GetDisplayRSquared ( )

True if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation).

Setting this property to True automatically turns on data labels.

MSDN documentation for Trendline.DisplayRSquared.

◆ SetDisplayRSquared()

void wxAutoExcel::wxExcelTrendline::SetDisplayRSquared ( bool displayRSquared )

True if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation).

Setting this property to True automatically turns on data labels.

MSDN documentation for Trendline.DisplayRSquared.

◆ GetFormat()

wxExcelChartFormat wxAutoExcel::wxExcelTrendline::GetFormat ( )

Read-only Since Excel 2007.

MSDN documentation for Trendline.Format.

◆ GetForward()

long wxAutoExcel::wxExcelTrendline::GetForward ( )

Returns the number of periods (or units on a scatter chart) that the trendline extends forward.

[MSDN documentation for Trendline.Forward]().

◆ SetForward()

void wxAutoExcel::wxExcelTrendline::SetForward ( long forward )

Sets the number of periods (or units on a scatter chart) that the trendline extends forward.

[MSDN documentation for Trendline.Forward]().

◆ GetForward2()

double wxAutoExcel::wxExcelTrendline::GetForward2 ( )

Returns the ChartFormat object.

Since Excel 2007.

MSDN documentation for Trendline.Forward2.

◆ SetForward2()

void wxAutoExcel::wxExcelTrendline::SetForward2 ( double forward2 )

Returns the ChartFormat object.

Since Excel 2007.

MSDN documentation for Trendline.Forward2.

◆ GetIndex()

long wxAutoExcel::wxExcelTrendline::GetIndex ( )

Returns a Long value that represents the index number of the object within the collection of similar objects.

MSDN documentation for Trendline.Index.

◆ GetIntercept()

double wxAutoExcel::wxExcelTrendline::GetIntercept ( )

Returns the point where the trendline crosses the value axis.

Read/write Double.

MSDN documentation for Trendline.Intercept.

◆ SetIntercept()

void wxAutoExcel::wxExcelTrendline::SetIntercept ( double intercept )

Sets the point where the trendline crosses the value axis.

Read/write Double.

MSDN documentation for Trendline.Intercept.

◆ GetInterceptIsAuto()

bool wxAutoExcel::wxExcelTrendline::GetInterceptIsAuto ( )

True if the point where the trendline crosses the value axis is automatically determined by the regression.

MSDN documentation for Trendline.InterceptIsAuto.

◆ SetInterceptIsAuto()

void wxAutoExcel::wxExcelTrendline::SetInterceptIsAuto ( bool interceptIsAuto )

True if the point where the trendline crosses the value axis is automatically determined by the regression.

MSDN documentation for Trendline.InterceptIsAuto.

◆ GetName()

wxString wxAutoExcel::wxExcelTrendline::GetName ( )

Returns a String value representing the name of the object.

MSDN documentation for Trendline.Name.

◆ SetName()

void wxAutoExcel::wxExcelTrendline::SetName ( const wxString & name )

Sets a String value representing the name of the object.

MSDN documentation for Trendline.Name.

◆ GetNameIsAuto()

bool wxAutoExcel::wxExcelTrendline::GetNameIsAuto ( )

True if Microsoft Excel automatically determines the name of the trendline.

MSDN documentation for Trendline.NameIsAuto.

◆ SetNameIsAuto()

void wxAutoExcel::wxExcelTrendline::SetNameIsAuto ( bool nameIsAuto )

True if Microsoft Excel automatically determines the name of the trendline.

MSDN documentation for Trendline.NameIsAuto.

◆ GetOrder()

long wxAutoExcel::wxExcelTrendline::GetOrder ( )

Returns a Long value that represents the trendline order (an integer greater than 1) when the trendline type is xlPolynomial.

MSDN documentation for Trendline.Order.

◆ SetOrder()

void wxAutoExcel::wxExcelTrendline::SetOrder ( long order )

Sets a Long value that represents the trendline order (an integer greater than 1) when the trendline type is xlPolynomial.

MSDN documentation for Trendline.Order.

◆ GetPeriod()

long wxAutoExcel::wxExcelTrendline::GetPeriod ( )

Returns the period for the moving-average trendline.

Can be a value from 2 through 255.

MSDN documentation for Trendline.Period.

◆ SetPeriod()

void wxAutoExcel::wxExcelTrendline::SetPeriod ( long period )

Sets the period for the moving-average trendline.

Can be a value from 2 through 255.

MSDN documentation for Trendline.Period.

◆ GetType()

XlTrendlineType wxAutoExcel::wxExcelTrendline::GetType ( )

Returns a XlTrendlineType value that represents the trendline type.

MSDN documentation for Trendline.Type.

◆ SetType()

void wxAutoExcel::wxExcelTrendline::SetType ( XlTrendlineType type )

Sets a XlTrendlineType value that represents the trendline type.

MSDN documentation for Trendline.Type.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "Trendline".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ClearFormats()

◆ Delete()

◆ Select()

◆ GetBackward()

◆ SetBackward()

◆ GetBackward2()

◆ SetBackward2()

◆ GetBorder()

◆ GetDataLabel()

◆ GetDisplayEquation()

◆ SetDisplayEquation()

◆ GetDisplayRSquared()

◆ SetDisplayRSquared()

◆ GetFormat()

◆ GetForward()

◆ SetForward()

◆ GetForward2()

◆ SetForward2()

◆ GetIndex()

◆ GetIntercept()

◆ SetIntercept()

◆ GetInterceptIsAuto()

◆ SetInterceptIsAuto()

◆ GetName()

◆ SetName()

◆ GetNameIsAuto()

◆ SetNameIsAuto()

◆ GetOrder()

◆ SetOrder()

◆ GetPeriod()

◆ SetPeriod()

◆ GetType()

◆ SetType()

◆ GetAutoExcelObjectName_()