PadExtension.Pad<TSource>(IEnumerable<TSource>, Int32, TSource) Method

Pads a sequence with a given filler value if it is narrower (shorter in length) than a given width.

Definition

Namespace: MoreLinq.Extensions
Assembly: MoreLinq (in MoreLinq.dll) Version: 4.4.0+6d97c3b1d482f98300f4446df14742b0e3fafbec
C#
public static IEnumerable<TSource> Pad<TSource>(
	this IEnumerable<TSource> source,
	int width,
	TSource padding
)

Parameters

source  IEnumerable<TSource>
The sequence to pad.
width  Int32
The width/length below which to pad.
padding  TSource
The value to use for padding.

Type Parameters

TSource
The type of the elements of source.

Return Value

IEnumerable<TSource>
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 IEnumerable<TSource>. 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.

Example

C#
int[] numbers = { 123, 456, 789 };
var 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