ISetWindowFieldsPartitionExtensionsShiftTInput, TValue Method (ISetWindowFieldsPartitionTInput, FuncTInput, TValue, Int32, TValue) |
Returns the value from an expression applied to a document in a specified position relative to the current document.
Namespace:
MongoDB.Driver.Linq
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax public static TValue Shift<TInput, TValue>(
this ISetWindowFieldsPartition<TInput> partition,
Func<TInput, TValue> selector,
int by,
TValue defaultValue
)
<ExtensionAttribute>
Public Shared Function Shift(Of TInput, TValue) (
partition As ISetWindowFieldsPartition(Of TInput),
selector As Func(Of TInput, TValue),
by As Integer,
defaultValue As TValue
) As TValue
[<ExtensionAttribute>]
static member Shift :
partition : ISetWindowFieldsPartition<'TInput> *
selector : Func<'TInput, 'TValue> *
by : int *
defaultValue : 'TValue -> 'TValue
Parameters
- partition
- Type: MongoDB.DriverISetWindowFieldsPartitionTInput
The partition. - selector
- Type: SystemFuncTInput, TValue
The selector that selects a value from the input document. - by
- Type: SystemInt32
The relative position of the document to evaluate the selector on to shift a value to this document. - defaultValue
- Type: TValue
The default value to use if the document position is outside the partition.
Type Parameters
- TInput
- The type of the input documents in the partition.
- TValue
- The type of the selected values.
Return Value
Type:
TValueThe value from an expression applied to a document in a specified position relative to the current document.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
ISetWindowFieldsPartitionTInput. 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).
See Also