SetDataConnection Method

In This Topic

Updates a MapMember's data source. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Sub SetDataConnection( _
   ByVal dataConnection As CIMDataConnection, _
   Optional ByVal validateConnection As Boolean _
)

public void SetDataConnection( 
   CIMDataConnection dataConnection,
   bool validateConnection
)

Parameters

dataConnection: A CIM data connection value object.
validateConnection: true to make sure dataset exists and of valid data type before replacing the data source e.g. you cannot change a FeatureLayer's data source to a Raster Dataset.

-or-

false to indicate no validation required. It might not already exist. This can be useful for scenarios that require data sources to be updated ahead of the data being created. Note, in these cases, the data would appear broken in the map.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Example

Reset the URL of a feature service layer

{
    CIMStandardDataConnection dataConnection = featureLayer.GetDataConnection() as CIMStandardDataConnection;
    dataConnection.WorkspaceConnectionString = @"DATABASE=C:\Data\USNationalParks\USNationalParks.gdb";
    //Note: needs to be called on the MCT
    featureLayer.SetDataConnection(dataConnection);
}

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.0 or higher.

Reference

MapMember Class
MapMember Members

Send feedback