EnumerableExtensions.TryInsert(T) Method (IEnumerable(T), Int32, T, Boolean, Boolean)


EnumerableExtensionsTryInsertT Method (IEnumerableT, Int32, T, Boolean, Boolean)	KGy SOFT Core Libraries Help

Tries to insert the specified item at the specified index to the collection.

Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 5.0.0

Syntax

C++

Copy

public static bool TryInsert<T>(
	this IEnumerable<T> collection,
	int index,
	T item,
	bool checkReadOnlyAndBounds = true,
	bool throwError = true
)

<ExtensionAttribute>
Public Shared Function TryInsert(Of T) ( 
	collection As IEnumerable(Of T),
	index As Integer,
	item As T,
	Optional checkReadOnlyAndBounds As Boolean = true,
	Optional throwError As Boolean = true
) As Boolean

public:
[ExtensionAttribute]
generic<typename T>
static bool TryInsert(
	IEnumerable<T>^ collection, 
	int index, 
	T item, 
	bool checkReadOnlyAndBounds = true, 
	bool throwError = true
)

[<ExtensionAttribute>]
static member TryInsert : 
        collection : IEnumerable<'T> * 
        index : int * 
        item : 'T * 
        ?checkReadOnlyAndBounds : bool * 
        ?throwError : bool 
(* Defaults:
        let _checkReadOnlyAndBounds = defaultArg checkReadOnlyAndBounds true
        let _throwError = defaultArg throwError true
*)
-> bool

Parameters

collection: Type: System.Collections.GenericIEnumerableT
The collection to insert the item into.
index: Type: SystemInt32
The zero-based index at which item should be inserted.
item: Type: T
The item to be inserted.
checkReadOnlyAndBounds (Optional): Type: SystemBoolean
to return if the collection is read-only or the index is invalid; to attempt inserting the element without checking the read-only state and bounds. This parameter is optional.
Default value: .
throwError (Optional): Type: SystemBoolean
to forward any exception thrown by a found insert method; to suppress the exceptions thrown by the found insert method and return on failure. This parameter is optional.
Default value: .

Type Parameters

T: The type of the elements in the collection.

Return Value

Type: Boolean
if an inserting method could be successfully called; if such method was not found, or checkReadOnlyAndBounds is and the collection was read-only, or throwError is and the inserting method threw an exception.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerableT. 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

The item can be inserted into the collection if that is either an IListT or IList implementation.

Reference

EnumerableExtensions Class

TryInsert Overload

KGySoft.CoreLibraries Namespace