EnumerableExtensionsTryInsert(IEnumerable, Int32, Object, Boolean, Boolean) Method

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

Definition

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

C#

public static bool TryInsert(
	this IEnumerable collection,
	int index,
	Object? item,
	bool checkReadOnlyAndBounds = true,
	bool throwError = true
)

VB

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

C++

public:
[ExtensionAttribute]
static bool TryInsert(
	IEnumerable^ collection, 
	int index, 
	Object^ item, 
	bool checkReadOnlyAndBounds = true, 
	bool throwError = true
)

F#

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

Parameters

collection IEnumerable: The collection to insert the item into.
index Int32: The zero-based index at which item should be inserted.
item Object: The item to be inserted.
checkReadOnlyAndBounds Boolean (Optional): 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 Boolean (Optional): 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: .

Return Value

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 IEnumerable. 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 IList or IListT implementation.

Note

If it is known that the collection implements only the supported generic IListT interface, then for better performance use the generic TryInsert<T> overload if possible.