ByRef Object

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Contains the value of an event parameter.

Using the ByRef object

Some events return or set values through parameters that are typed as ByRef objects. When an event parameter is typed as a ByRef object, use the Value property of the parameter to return or set the parameter.

The following event parameters return or set values through a ByRef object:

• The BeforeContextMenu event's Menu and Cancel parameters
• The BeforeKeyDown event's Cancel parameter
• The BeforeKeyPress event's Cancel parameter
• The BeforeKeyUp event's Cancel parameter
• The BeforeRender event's Cancel parameter
• The CommandBeforeExecute event's Cancel parameter
• The CommandChecked event's Checked parameter
• The CommandEnabled event's Enabled parameter
• The CommandTipText event's Caption parameter
• The EndEdit event's FinalValue, Cancel, and ErrorDescription parameters
• The StartEdit event's InitialValue, Cancel, and ErrorDescription parameters (Spreadsheet)
• The StartEdit event's InitialValue, ArrowMode, CaretPosition, Cancel, and ErrorDescription parameters (PivotTable)

<pre IsFakePre="true" xmlns="http://www.w3.org/1999/xhtml" />