OnGetCustomFields

The OnGetCustomFields event can be implemented by a rename script to add custom fields to the Rename dialog. This lets you provide one or more controls that users can use to pass parameters to your script.

 

Method Name:

OnGetCustomFields

Argument Type:

GetCustomFieldData 

Return Type:

none

Description:

The Rename dialog will call this method when your script is loaded from a preset (or when you click the Refresh button in the integrated script editor). 
 

The GetCustomFieldData.fields property lets you add one or more custom fields to the Rename dialog. You can also provide labels for your fields using the field_labels property, and cue banners for any edit fields using the field_tips property.

 

Each property is a Map object which you can populate to create your custom fields. See Custom Fields in the Rename Dialog for more information.