MoreEnumerablePadStartTSource Method (IEnumerableTSource, Int32, TSource)

Pads a sequence with a given filler value in the beginning if it is narrower (shorter in length) than a given width. An additional parameter specifies the value to use for padding.

Namespace: MoreLinq
Assembly: MoreLinq (in MoreLinq.dll) Version: 2.8.0

Syntax

C++

Copy

public static IEnumerable<TSource> PadStart<TSource>(
	this IEnumerable<TSource> source,
	int width,
	TSource padding
)

<ExtensionAttribute>
Public Shared Function PadStart(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>^ PadStart(
	IEnumerable<TSource>^ source, 
	int width, 
	TSource padding
)

[<ExtensionAttribute>]
static member PadStart : 
        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

Copy

int[] numbers = { 123, 456, 789 };
var result = numbers.PadLeft(5, -1);

The result variable will contain { -1, -1, 123, 456, 789 }.

Reference

MoreEnumerable Class

PadStart Overload

MoreLinq Namespace