ValueExtensionsWhere(IEnumerableValue, Value, Boolean) Method

Filters a sequence of Values based on a Value that contains filters.
When using this method to filter and assign the result to a ReadValue, also add PagingHandled to the Options of the same Command to inform the TwinCAT HMI server that filtering was handled by the TwinCAT HMI server extension and must not be handled again by the TwinCAT HMI server.

Namespace: TcHmiSrv.Core.Tools.Queries.Extensions
Assembly: TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 3.1.7447.0+85f9b473a1dd11b8f3e5c9a182fd1901975e46f9

Syntax

C#

public static IEnumerable<Value> Where(
    this IEnumerable<Value> collection,
    Value filters,
    bool useCache
)

Parameters

collection IEnumerable Value	An IEnumerableT of Values to filter.
filters Value	A Value that contains filters. Please note that the path property is not yet supported and therefore ignored.
useCache Boolean	true to use the cache to get or add a predicate created from filters; otherwise, false to not use the cache to get or add a delegate. When this method is called, a predicate is created from filters and passed to WhereTSource(IEnumerableTSource, FuncTSource, Boolean) to filter collection. Since creating the predicate is relatively time-consuming, it can be cached and reused when this method is called again if the value returned for filters by GetHashCode matches that of the cached predicate.

Return Value

IEnumerable Value
An IEnumerableT of Values that contains elements from collection that have not been filtered out.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable Value. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Version Information

Supported in: 3.1.7447.0, 2.3.7447.0, 1.10.7447.0

Reference

ValueExtensions Class Where Overload TcHmiSrv.Core.Tools.Queries.Extensions Namespace