Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IGetValueElement<GetType, FilterType>

Used by IValueElementNode to describe state retrieval functions supported by ValuePageElement, ValuePageElementList, ValuePageElementMap and ValuePageElementGroup.

Type parameters

  • GetType

  • FilterType

Hierarchy

Index

Methods

getContainsValue

  • getContainsValue(value: GetType): FilterType
  • Returns the 'containsValue' status of a ValuePageElement or of the ValuePageElements managed by ValuePageElementList, ValuePageElementMap or ValuePageElementGroup.

    A ValuePageElement's 'hasValue' status is set to true if its actual value contains the expected value.

    Parameters

    • value: GetType

      the expected value used in the comparison which sets the 'containsValue' status

    Returns FilterType

getHasAnyValue

  • getHasAnyValue(filterMask?: FilterType): FilterType
  • Returns the 'hasAnyValue' status of a ValuePageElement or of the ValuePageElements managed by ValuePageElementList, ValuePageElementMap or ValuePageElementGroup.

    Parameters

    • Optional filterMask: FilterType

      can be used to skip the invocation of the state retrieval function for some or all managed PageElements and not include the skipped results in the total result

    Returns FilterType

getHasValue

  • getHasValue(value: GetType): FilterType
  • Returns the 'hasValue' status of a ValuePageElement or of the ValuePageElements managed by ValuePageElementList, ValuePageElementMap or ValuePageElementGroup.

    A ValuePageElement's 'hasValue' status is set to true if its actual value equals the expected value.

    Parameters

    • value: GetType

      the expected value used in the comparison which sets the 'hasValue' status

    Returns FilterType

getValue

  • getValue(filterMask?: FilterType): GetType
  • Returns the value of a ValuePageElement or of the ValuePageElements managed by a ValuePageElementList, ValuePageElementMap or ValuePageElementGroup.

    Parameters

    • Optional filterMask: FilterType

      can be used to skip the invocation of the state retrieval function for some or all managed PageElements and not include the skipped results in the total result

    Returns GetType

Generated using TypeDoc