FILTERPROPERTY / FP

Returns the value of a specified property, optionally in a designated row and collection result set, as a string enclosed in quotes. If the value is empty, returns NULL as an unquoted string.

Return Value

String

Syntax

One of the following:

FILTERPROPERTY( propertyName ): Appears as FP or FILTERPROPERTY in the Event Action Expression Editor

FILTERPROPERTY( row#, propertyName ): Appears as FP2 or FILTERPROPERTY2 in the Event Action Expression Editor

FILTERPROPERTY( collection, row#, propertyName ): Appears as FP3 or FILTERPROPERTY3 in the Event Action Expression Editor

where:

  • propertyName is the name of the property for which you want to retrieve the value.
    Note:  When using the IdoOnItem or IdoPostItem framework events to retrieve a property that is part of that event, this is the only accepted parameter.
  • row# is the one-based number of the row containing the property value you want to retrieve.
    Note:  This argument is used only with the IdoOnLoadCollection and IdoPostLoadCollection framework events. See Usage section.
  • collection is the name of a result set containing a collection you loaded earlier using a Load IDO Collection action.

Usage

FP / FILTERPROPERTY is used only with these framework events:

  • IdoOnItemDelete
  • IdoOnItemInsert
  • IdoOnItemUpdate
  • IdoPostItemDelete
  • IdoPostItemInsert
  • IdoPostItemUpdate

FP2 / FILTERPROPERTY2 is used only with the IdoOnLoadCollection and IdoPostLoadCollection framework events.

FP3 / FILTERPROPERTY3 is used with any event, but only after using a Load IDO Collection action.

Related topics