RenameQueryDefinition Method

In This Topic

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

Syntax

Visual Basic (Declaration)
C#

Public Sub RenameQueryDefinition( _
   ByVal queryDefinitionName As String, _
   ByVal newQueryDefinitionName As String _
)

public void RenameQueryDefinition( 
   string queryDefinitionName,
   string newQueryDefinitionName
)

Parameters

queryDefinitionName: The name of the ArcGIS.Core.CIM.CIMKnowledgeGraphQueryDefinition to rename. This corresponds to ArcGIS.Core.CIM.CIMKnowledgeGraphQueryDefinition.Name.
newQueryDefinitionName: The new name for the ArcGIS.Core.CIM.CIMKnowledgeGraphQueryDefinition.

Exceptions

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

Remarks

Query definition names must be unique within an investigation. If the already exists in the investigation, then an System.InvalidOperationException will be thrown.

Example

Rename a Query Definition

{
  // access the currently active knowledge graph investigation view
  KnowledgeGraphInvestigationView activeView = KnowledgeGraphInvestigationView.Active;
  KnowledgeGraphInvestigation investigation = activeView?.Investigation;
  if (investigation != null)
  {
    await QueuedTask.Run(() =>
    {
      // rename the query definition
      investigation.RenameQueryDefinition("Query1", "EntityQuery");
    });
  }
}

Requirements

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

ArcGIS Pro version: 3.7 or higher.

Reference

KnowledgeGraphInvestigation Class
KnowledgeGraphInvestigation Members

Send feedback