MoreEnumerablePadTSource Method (IEnumerableTSource, Int32, TSource) |
Pads a sequence with a given filler value if it is narrower (shorter
in length) than a given width.
Namespace:
MoreLinq
Assembly:
MoreLinq (in MoreLinq.dll) Version: 2.4.0
Syntax public static IEnumerable<TSource> Pad<TSource>(
this IEnumerable<TSource> source,
int width,
TSource padding
)
<ExtensionAttribute>
Public Shared Function Pad(Of TSource) (
source As IEnumerable(Of TSource),
width As Integer,
padding As TSource
) As IEnumerable(Of TSource)
public:
[ExtensionAttribute]
generic<typename TSource>
static IEnumerable<TSource>^ Pad(
IEnumerable<TSource>^ source,
int width,
TSource padding
)
[<ExtensionAttribute>]
static member Pad :
source : IEnumerable<'TSource> *
width : int *
padding : 'TSource -> IEnumerable<'TSource>
Parameters
- source
- Type: System.Collections.GenericIEnumerableTSource
The sequence to pad. - width
- Type: SystemInt32
The width/length below which to pad. - padding
- Type: TSource
The value to use for padding.
Type Parameters
- TSource
- The type of the elements of source.
Return Value
Type:
IEnumerableTSource
Returns a sequence that is at least as wide/long as the width/length
specified by the
width parameter.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IEnumerableTSource. 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).
Remarks
This operator uses deferred execution and streams its results.
Examples int[] numbers = { 123, 456, 789 };
IEnumerable<int> result = numbers.Pad(5, -1);
The
result variable, when iterated over, will yield
123, 456, and 789 followed by two occurrences of -1, in turn.
See Also