XL2000: Function That Uses the ActiveCell Property Returns Incorrect Result

ID: Q213684

The information in this article applies to:

Microsoft Excel 2000

SYMPTOMS

When you enter a formula that calls a custom function, the formula may return an incorrect result when you recalculate the worksheet. The formula returns the correct result only when you select the cell that contains the formula and then recalculate the worksheet. When you do this, other formulas that call the same custom function return the same result.

CAUSE

This behavior occurs when the following conditions are true:

The custom function uses the ActiveCell property.

-and-

The custom function uses the Volatile method to force the function to recalculate values each time that the worksheet is recalculated.

To see an example of this behavior, see the "More Information" section later in this article.

WORKAROUND

Microsoft provides programming examples for illustration only, without warranty either expressed or implied, including, but not limited to, the implied warranties of merchantability and/or fitness for a particular purpose. This article assumes that you are familiar with the programming language being demonstrated and the tools used to create and debug procedures. Microsoft support professionals can help explain the functionality of a particular procedure, but they will not modify these examples to provide added functionality or construct procedures to meet your specific needs. If you have limited programming experience, you may want to contact a Microsoft Certified Solution Provider or the Microsoft fee-based consulting line at (800) 936-5200. For more information about Microsoft Certified Solution Providers, please see the following page on the World Wide Web:

http://www.microsoft.com/mcsp/

For more information about the support options available from Microsoft, please see the following page on the World Wide Web:

http://www.microsoft.com/support/supportnet/overview/overview.asp

To work around this behavior, substitute Application.Caller for the ActiveCell property wherever it is used in the custom function. For example, if the custom function is the following


Function Test()
   Application.Volatile
   ' Returns the cell one column to the left of the active cell. Note
   ' that the active cell is not necessarily the cell that is calling
   ' the function.
   Test = ActiveCell.Offset(0, -1).Value
End Function

you should change it to the following:


Function Test()
   Application.Volatile
   ' Returns the cell one column to the left of the cell that is
   ' actually calling the function.
   Test = Application.Caller.Offset(0, -1).Value
End Function

When you do this, the function correctly uses the cell that is calling the function instead of using the currently active cell.

MORE INFORMATION

When you use the ActiveCell property in a custom function in Microsoft Excel, the property returns the cell that is currently active. This is true even if the custom function is called by a formula in a worksheet cell.

The Caller property of the Application object returns the object that calls the function, regardless of the cell or worksheet that is active.

To demonstrate the behavior described in this article, follow these steps:

Create a new workbook.

In Sheet1 of the new workbook, enter the following values:

Start the Visual Basic Editor by pressing ALT=F11, insert a new Visual Basic module, and then type the following code into the new module:


Function Test()
   Application.Volatile
   Test = ActiveCell.Offset(0, -1).Value
End Function

Switch to Sheet1. Enter the following formula into cell B1:
=Test()
NOTE: The formula returns the value 1. This is the correct value because the cell that is one column to the left of the active cell (B1) contains the value 1.

Select cell B1. On the Edit menu, click Copy. Select cells B2:B5. On the Edit menu, click Paste, and then press ESC.

NOTE: All five formulas in B1:B5 return the value 2. This is true because the cell that is one column to the left of the active cell (B2) contains the value 2.

Select cell D10, and then press F9.

All five formulas in B1:B5 return the value 0, because the cell that is one column to the left of the active cell (D10) contains no value, which is equivalent to having a value of 0.

If you want the function to always return the value of the cell that is one column to the left of the cell that is calling the function, change the function to the following:
```
Function Test()
    Application.Volatile
    Test = Application.Caller.Offset(0, -1).Value
End Function 
```
When you change the function, and then recalculate the worksheet, the formulas in B1:B5 return the values 1 through 5 no matter which cell or worksheet is active.

REFERENCES

For additional information about getting help with Visual Basic for Applications, click the article number below to view the article in the Microsoft Knowledge Base:

Q226118 OFF2000: Programming Resources for Visual Basic for Applications

Additional query words: XL2000

Keywords : kbprg kbdta kbdtacode xlformula KbVBA
Version : WINDOWS:2000
Platform : WINDOWS
Issue type : kbprb