CreateLayers(BulkLayerCreationParams,ILayerContainerEdit) Method

In This Topic

Creates a readonly list of new Layer instances using the specified BulkLayerCreationParams and adds it to a container such as a map. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

IReadOnlyList<Layer> CreateLayers( 
   BulkLayerCreationParams layerParams,
   ILayerContainerEdit container
)

Overloads Function CreateLayers( _
   ByVal layerParams As BulkLayerCreationParams, _
   ByVal container As ILayerContainerEdit _
) As IReadOnlyList(Of Layer)

Parameters

layerParams: A BulkLayerCreationParams object.
container: A map or group layer where the Layers will be added.

Return Value

A Readonly list of Layer.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentNullException	layerParams or container is null.
System.ArgumentException	An elevation surface layer cannot be used as a container for bulk layer creation.
System.ArgumentException	Unable to bulk create layers with a combination of standard and custom items.
System.ArgumentException	Unable to bulk create layers with data supplied as a mixture of Uris, Items and data connections.
System.ArgumentException	Unable to bulk create layers with the supplied child LayerCreationParams.

Remarks

The bulk layer creation process creates the layers it is able to per the data supplied. If invalid Uris, data connections or Items exist amongst valid data, there will be a mismatch in the number of layers created compared to the number of data items supplied. For example, 5 Uris are supplied, but only 4 layers are created because one of the Uris points to a dataset that does not exist. LayerFactory.CreateLayers will return the layers created, but no information regarding the invalid dataset. The only exception to this is if all datasets are invalid (and no layers are created); in this scenario an System.ArgumentException will be thrown.

See the BulkLayerCreationParams.RollbackBehavior for information about rollback options with bulk layer creation when the BulkLayerCreationParams object is created with a set of LayerCreationParams objects.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.4 or higher.

Reference

ILayerFactory Interface
ILayerFactory Members
Overload List

Send feedback