EnumerableExtensionsTryAddRange(IEnumerable, IEnumerable, Boolean, Boolean) Method

Tries to add the specified collection to the target collection.

Definition

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

C#

public static bool TryAddRange(
	this IEnumerable target,
	IEnumerable collection,
	bool checkReadOnly = true,
	bool throwError = true
)

VB

<ExtensionAttribute>
Public Shared Function TryAddRange ( 
	target As IEnumerable,
	collection As IEnumerable,
	Optional checkReadOnly As Boolean = true,
	Optional throwError As Boolean = true
) As Boolean

C++

public:
[ExtensionAttribute]
static bool TryAddRange(
	IEnumerable^ target, 
	IEnumerable^ collection, 
	bool checkReadOnly = true, 
	bool throwError = true
)

F#

[<ExtensionAttribute>]
static member TryAddRange : 
        target : IEnumerable * 
        collection : IEnumerable * 
        ?checkReadOnly : bool * 
        ?throwError : bool 
(* Defaults:
        let _checkReadOnly = defaultArg checkReadOnly true
        let _throwError = defaultArg throwError true
*)
-> bool

Parameters

target IEnumerable: The target collection.
collection IEnumerable: The collection to add to the target.
checkReadOnly Boolean (Optional): to return if the target collection is read-only; to attempt adding the collection without checking the read-only state. This parameter is optional.
Default value: .
throwError Boolean (Optional): to forward any exception thrown by a found add method; to suppress the exceptions thrown by the found add method and return on failure. This parameter is optional.
Default value: .

Return Value

Boolean
, if the whole collection could be added to target; otherwise, .

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 collection can be added to the target collection if that is either an ICollectionT, IProducerConsumerCollectionT or IList implementation.

If target is neither a ListT nor an ISupportsRangeCollectionT implementation, then the elements of collection will only be added one by one.

Note

Whenever possible, try to use the generic TryAddRange<T> overload for better performance.

Caution

If not every element in collection is compatible with target, then it can happen that some elements of collection have been added to target and the method returns .