Rename Method—ArcGIS Pro

Enqueue the rename operation on the object with the name referred to by the Description.

Syntax

C#
Visual Basic (Declaration)

public Token Rename( 
   Description description,
   string newName
)

Public Function Rename( _
   ByVal description As Description, _
   ByVal newName As String _
) As Token

Parameters

description: Indicates the object to be renamed.
newName: The new name of the object.

Return Value

The Token for the object to be renamed.

Exceptions

Exception	Description
System.ArgumentException	Rename does not support description. -or- The new name is invalid. -or- The total path length for the renamed description must be less than 252 characters. The new name is invalid.
System.ArgumentNullException	description is null.

Exception

Description

System.ArgumentException

Rename does not support description.

-or-

The new name is invalid.

-or-

The total path length for the renamed description must be less than 252 characters.

The new name is invalid.

System.ArgumentNullException

is null.

Example

      
//Renaming a table from 'Original_Table' to 'Renamed_Table'

string tableToBeRenamed = "Original_Table";
string tableRenameAs = "Renamed_Table";

TableDefinition tableDefinition = geodatabase.GetDefinition<TableDefinition>(tableToBeRenamed);

SchemaBuilder schemaBuilder = new SchemaBuilder(geodatabase);

// Table rename 
schemaBuilder.Rename(new TableDescription(tableDefinition), tableRenameAs);
schemaBuilder.Build();

Requirements

Target Platforms: Windows 11, Windows 10, Windows 8.1

Reference

SchemaBuilder Class
SchemaBuilder Members