GetFilterSRC method

   Example   

Returns an array of cell ranges and a True or False value indicating whether you are filtering events for that range.

Version added

2002

Syntax

retVal = object.GetFilterSRC()

Remarks

The event filters described in the array returned by the GetFilterSRC method provide developers a way of ignoring specified events based on object type. The array returned is that passed to the SetFilterSRC method for this Event object.

The array that is returned by the GetFilterSRC method can be interpreted in the following manner.

The number of elements in the array is a multiple of 7. These seven elements contain the following values:

• The first three elements describe the section, row, and cell of the beginning cell of the range.

• The next three elements describe the section, row, and cell of the end cell of the range.

• The last element contains a True or False value indicating whether you want to receive events for the specified range of cells (True to listen to events for a range of cells; False to exclude events for the range of cells).

For an event to successfully pass through a cell range filter, it must satisfy the following criteria:

• It must be a valid section, row, cell reference.

• If all filters are True, the event must match at least one filter.

• If all filters are False, the event must not match any filter.

• If the filters are a mixture of True and False, the event must match at least one True filter and not match any False filters.

If there are no True ranges defined in the array, events are considered True.

For details about defining event filters using command IDs, see the SetFilterSRC method.