Click or drag to resize

ScriptContextRenameField Method

Renames the given field in the schema.

Namespace:  Compiled.EDD.Scripting
Assembly:  Compiled.EDD.Scripting (in Compiled.EDD.Scripting.dll) Version: 7.6.1.3-5cb5c356
Syntax
C#
Copy
public void RenameField(
	FieldItem field,
	string newFieldName
)

Parameters

field
Type: Compiled.EDD.ScriptingFieldItem
The field to rename.
newFieldName
Type: SystemString
The new name of the field.

Implements

IScriptContextRenameField(FieldItem, String)
Exceptions
ExceptionCondition
ExceptionThrown when attempting to delete a system scoped field.
ArgumentExceptionThrown when attempting to rename a field with a duplicate name.
ArgumentExceptionThrown when invalid characters are in field name.
Remarks
Valid field names can contain letters, digits, whitespace, and the following chars: _ - : # / \ @ ! ( ) % & . < > ^
See Also