RenameFilteredFindPathsConfiguration Method

In This Topic

Renames the ArcGIS.Core.CIM.CIMFilteredFindPathsConfiguration with the specified name. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Sub RenameFilteredFindPathsConfiguration( _
   ByVal filteredFindPathsConfigurationName As String, _
   ByVal newFilteredFindPathsConfigurationName As String _
)

public void RenameFilteredFindPathsConfiguration( 
   string filteredFindPathsConfigurationName,
   string newFilteredFindPathsConfigurationName
)

Parameters

filteredFindPathsConfigurationName: The name of the ArcGIS.Core.CIM.CIMFilteredFindPathsConfiguration to rename. This corresponds to ArcGIS.Core.CIM.CIMFilteredFindPathsConfiguration.Name.
newFilteredFindPathsConfigurationName: The new name for the ArcGIS.Core.CIM.CIMFilteredFindPathsConfiguration.

Exceptions

Exception	Description
System.ArgumentNullException	filteredFindPathsConfigurationName or newFilteredFindPathsConfigurationName are null or empty.
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.InvalidOperationException	The filteredFindPathsConfigurationName does not exist in the investigation or the newFilteredFindPathsConfigurationName already exists in the investigation.

Remarks

Filtered find paths configuration names must be unique within an investigation. If the already exists in the investigation, then an System.InvalidOperationException will be thrown. This check is case insensitive.

Example

Rename a Filtered Find Paths Configuration

{
  // access the currently active knowledge graph investigation view
  KnowledgeGraphInvestigationView activeView = KnowledgeGraphInvestigationView.Active;
  KnowledgeGraphInvestigation investigation = activeView?.Investigation;
  if (investigation != null)
  {
    await QueuedTask.Run(() =>
    {
      // rename the FFPConfig
      investigation.RenameFilteredFindPathsConfiguration("FFPConfig1", "FFPConfig_POI");
    });
  }
}

Requirements

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

ArcGIS Pro version: 3.7 or higher.

Reference

KnowledgeGraphInvestigation Class
KnowledgeGraphInvestigation Members

Send feedback