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

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

Namespace: MoreLinq.Extensions
Assembly: MoreLinq (in MoreLinq.dll) Version: 3.3.1+b77df70598ab84c28cd43dcf74594024b6d575e1

Syntax

C++

Copy

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.Generic.IEnumerable<TSource>
The sequence to pad.
width: Type: System.Int32
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: 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.

Examples

Copy

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.

Reference

PadExtension Class

Pad Overload

MoreLinq.Extensions Namespace