Represents Microsoft Excel ErrorCheckingOptions object. More...

Inheritance diagram for wxAutoExcel::wxExcelErrorCheckingOptions:

Public Member Functions
bool	GetBackgroundChecking ()
	Alerts the user for all cells that violate enabled error-checking rules. More...

void	SetBackgroundChecking (bool backgroundChecking)
	Alerts the user for all cells that violate enabled error-checking rules. More...

bool	GetEmptyCellReferences ()
	When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, selected cells containing formulas that refer to empty cells. More...

void	SetEmptyCellReferences (bool emptyCellReferences)
	When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, selected cells containing formulas that refer to empty cells. More...

bool	GetEvaluateToError ()
	When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, selected cells that contain formulas evaluating to an error. More...

void	SetEvaluateToError (bool evaluateToError)
	When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, selected cells that contain formulas evaluating to an error. More...

bool	GetInconsistentFormula ()
	When set to True (default), Microsoft Excel identifies cells containing an inconsistent formula in a region. More...

void	SetInconsistentFormula (bool inconsistentFormula)
	When set to True (default), Microsoft Excel identifies cells containing an inconsistent formula in a region. More...

bool	GetInconsistentTableFormula ()
	When set to True (default), Microsoft Excel identifies cells containing an inconsistent table formula . More...

void	SetInconsistentTableFormula (bool inconsistentTableFormula)
	When set to True (default), Microsoft Excel identifies cells containing an inconsistent table formula . More...

XlColorIndex	GetIndicatorColorIndex ()
	Returns the color of the indicator for error checking options. More...

void	SetIndicatorColorIndex (XlColorIndex indicatorColorIndex)
	Sets the color of the indicator for error checking options. More...

bool	GetListDataValidation ()
	A Boolean value that is True if data validation is enabled in a list. More...

void	SetListDataValidation (bool listDataValidation)
	A Boolean value that is True if data validation is enabled in a list. More...

bool	GetNumberAsText ()
	When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, selected cells that contain numbers written as text. More...

void	SetNumberAsText (bool numberAsText)
	When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, selected cells that contain numbers written as text. More...

bool	GetOmittedCells ()
	When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, the selected cells that contain formulas referring to a range that omits adjacent cells that could be included. More...

void	SetOmittedCells (bool omittedCells)
	When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, the selected cells that contain formulas referring to a range that omits adjacent cells that could be included. More...

bool	GetTextDate ()
	When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, cells that contain a text date with a two-digit year. More...

void	SetTextDate (bool textDate)
	When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, cells that contain a text date with a two-digit year. More...

bool	GetUnlockedFormulaCells ()
	When set to True (default), Microsoft Excel identifies selected cells that are unlocked and contain a formula. More...

void	SetUnlockedFormulaCells (bool unlockedFormulaCells)
	When set to True (default), Microsoft Excel identifies selected cells that are unlocked and contain a formula. More...

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

Member Function Documentation

◆ GetBackgroundChecking()

bool wxAutoExcel::wxExcelErrorCheckingOptions::GetBackgroundChecking ( )

Alerts the user for all cells that violate enabled error-checking rules.

When this property is set to True (default), the AutoCorrect Options button appears next to all cells that violate enabled errors. False disables background checking for errors.

MSDN documentation for ErrorCheckingOptions.BackgroundChecking.

◆ SetBackgroundChecking()

void wxAutoExcel::wxExcelErrorCheckingOptions::SetBackgroundChecking ( bool backgroundChecking )

Alerts the user for all cells that violate enabled error-checking rules.

When this property is set to True (default), the AutoCorrect Options button appears next to all cells that violate enabled errors. False disables background checking for errors.

MSDN documentation for ErrorCheckingOptions.BackgroundChecking.

◆ GetEmptyCellReferences()

bool wxAutoExcel::wxExcelErrorCheckingOptions::GetEmptyCellReferences ( )

When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, selected cells containing formulas that refer to empty cells.

False disables empty cell reference checking.

MSDN documentation for ErrorCheckingOptions.EmptyCellReferences.

◆ SetEmptyCellReferences()

void wxAutoExcel::wxExcelErrorCheckingOptions::SetEmptyCellReferences ( bool emptyCellReferences )

When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, selected cells containing formulas that refer to empty cells.

False disables empty cell reference checking.

MSDN documentation for ErrorCheckingOptions.EmptyCellReferences.

◆ GetEvaluateToError()

bool wxAutoExcel::wxExcelErrorCheckingOptions::GetEvaluateToError ( )

When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, selected cells that contain formulas evaluating to an error.

False disables error checking for cells that evaluate to an error value.

MSDN documentation for ErrorCheckingOptions.EvaluateToError.

◆ SetEvaluateToError()

void wxAutoExcel::wxExcelErrorCheckingOptions::SetEvaluateToError ( bool evaluateToError )

When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, selected cells that contain formulas evaluating to an error.

False disables error checking for cells that evaluate to an error value.

MSDN documentation for ErrorCheckingOptions.EvaluateToError.

◆ GetInconsistentFormula()

bool wxAutoExcel::wxExcelErrorCheckingOptions::GetInconsistentFormula ( )

When set to True (default), Microsoft Excel identifies cells containing an inconsistent formula in a region.

False disables the inconsistent formula check.

MSDN documentation for ErrorCheckingOptions.InconsistentFormula.

◆ SetInconsistentFormula()

void wxAutoExcel::wxExcelErrorCheckingOptions::SetInconsistentFormula ( bool inconsistentFormula )

When set to True (default), Microsoft Excel identifies cells containing an inconsistent formula in a region.

False disables the inconsistent formula check.

MSDN documentation for ErrorCheckingOptions.InconsistentFormula.

◆ GetInconsistentTableFormula()

bool wxAutoExcel::wxExcelErrorCheckingOptions::GetInconsistentTableFormula ( )

When set to True (default), Microsoft Excel identifies cells containing an inconsistent table formula .

False disables the inconsistent formula check.

MSDN documentation for ErrorCheckingOptions.InconsistentTableFormula.

◆ SetInconsistentTableFormula()

void wxAutoExcel::wxExcelErrorCheckingOptions::SetInconsistentTableFormula ( bool inconsistentTableFormula )

When set to True (default), Microsoft Excel identifies cells containing an inconsistent table formula .

False disables the inconsistent formula check.

MSDN documentation for ErrorCheckingOptions.InconsistentTableFormula.

◆ GetIndicatorColorIndex()

XlColorIndex wxAutoExcel::wxExcelErrorCheckingOptions::GetIndicatorColorIndex ( )

Returns the color of the indicator for error checking options.

Read/write XlColorIndex.

MSDN documentation for ErrorCheckingOptions.IndicatorColorIndex.

◆ SetIndicatorColorIndex()

void wxAutoExcel::wxExcelErrorCheckingOptions::SetIndicatorColorIndex ( XlColorIndex indicatorColorIndex )

Sets the color of the indicator for error checking options.

Read/write XlColorIndex.

MSDN documentation for ErrorCheckingOptions.IndicatorColorIndex.

◆ GetListDataValidation()

bool wxAutoExcel::wxExcelErrorCheckingOptions::GetListDataValidation ( )

A Boolean value that is True if data validation is enabled in a list.

MSDN documentation for ErrorCheckingOptions.ListDataValidation.

◆ SetListDataValidation()

void wxAutoExcel::wxExcelErrorCheckingOptions::SetListDataValidation ( bool listDataValidation )

A Boolean value that is True if data validation is enabled in a list.

MSDN documentation for ErrorCheckingOptions.ListDataValidation.

◆ GetNumberAsText()

bool wxAutoExcel::wxExcelErrorCheckingOptions::GetNumberAsText ( )

When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, selected cells that contain numbers written as text.

False disables error checking for numbers written as text.

MSDN documentation for ErrorCheckingOptions.NumberAsText.

◆ SetNumberAsText()

void wxAutoExcel::wxExcelErrorCheckingOptions::SetNumberAsText ( bool numberAsText )

When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, selected cells that contain numbers written as text.

False disables error checking for numbers written as text.

MSDN documentation for ErrorCheckingOptions.NumberAsText.

◆ GetOmittedCells()

bool wxAutoExcel::wxExcelErrorCheckingOptions::GetOmittedCells ( )

When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, the selected cells that contain formulas referring to a range that omits adjacent cells that could be included.

False disables error checking for omitted cells.

MSDN documentation for ErrorCheckingOptions.OmittedCells.

◆ SetOmittedCells()

void wxAutoExcel::wxExcelErrorCheckingOptions::SetOmittedCells ( bool omittedCells )

When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, the selected cells that contain formulas referring to a range that omits adjacent cells that could be included.

False disables error checking for omitted cells.

MSDN documentation for ErrorCheckingOptions.OmittedCells.

◆ GetTextDate()

bool wxAutoExcel::wxExcelErrorCheckingOptions::GetTextDate ( )

When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, cells that contain a text date with a two-digit year.

False disables error checking for cells containing a text date with a two-digit year.

MSDN documentation for ErrorCheckingOptions.TextDate.

◆ SetTextDate()

void wxAutoExcel::wxExcelErrorCheckingOptions::SetTextDate ( bool textDate )

When set to True (default), Microsoft Excel identifies, with an AutoCorrect Options button, cells that contain a text date with a two-digit year.

False disables error checking for cells containing a text date with a two-digit year.

MSDN documentation for ErrorCheckingOptions.TextDate.

◆ GetUnlockedFormulaCells()

bool wxAutoExcel::wxExcelErrorCheckingOptions::GetUnlockedFormulaCells ( )

When set to True (default), Microsoft Excel identifies selected cells that are unlocked and contain a formula.

False disables error checking for unlocked cells that contain formulas.

MSDN documentation for ErrorCheckingOptions.UnlockedFormulaCells.

◆ SetUnlockedFormulaCells()

void wxAutoExcel::wxExcelErrorCheckingOptions::SetUnlockedFormulaCells ( bool unlockedFormulaCells )

When set to True (default), Microsoft Excel identifies selected cells that are unlocked and contain a formula.

False disables error checking for unlocked cells that contain formulas.

MSDN documentation for ErrorCheckingOptions.UnlockedFormulaCells.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "ErrorCheckingOptions".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetBackgroundChecking()

◆ SetBackgroundChecking()

◆ GetEmptyCellReferences()

◆ SetEmptyCellReferences()

◆ GetEvaluateToError()

◆ SetEvaluateToError()

◆ GetInconsistentFormula()

◆ SetInconsistentFormula()

◆ GetInconsistentTableFormula()

◆ SetInconsistentTableFormula()

◆ GetIndicatorColorIndex()

◆ SetIndicatorColorIndex()

◆ GetListDataValidation()

◆ SetListDataValidation()

◆ GetNumberAsText()

◆ SetNumberAsText()

◆ GetOmittedCells()

◆ SetOmittedCells()

◆ GetTextDate()

◆ SetTextDate()

◆ GetUnlockedFormulaCells()

◆ SetUnlockedFormulaCells()

◆ GetAutoExcelObjectName_()