RenameField

Renames an IDEA field.

Compatibility

Available as of IDEA version 9.0

Syntax

RenameField(database as Object, oldFieldName as String, newFieldName as String, Optional description as String)

Parameters

database

Object containing the opened database.

oldFieldName

Name of the field that needs to be renamed.

newFieldName

New name of the field.

description

Only one optional argument: Description.

Remarks

Error is raised if:

• database is null
• oldFieldName or newFieldName is null or empty.

Example

Dim SimpleCommands As Object 
Dim db As Object 
Dim fileName As String 

Sub Main 
	Set SimpleCommands = SmartContext.MacroCommands.SimpleCommands 

	'Get the name of the database. 
	fileName = SmartContext.PrimaryInputFile 

	'Open the database. 
	Set db = Client.OpenDatabase(fileName) 

	'Change the name of the field "NAME" into "NEWNAME". 
	SimpleCommands.RenameField db, "NAME","NEWNAME", "My new field description" 

	'Close the database. 
	db.Close 
	Set db = Nothing 

	'Release object. 
	Set SimpleCommands = Nothing 
End Sub

Copy example