Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
DynaPDF.SetFieldName
Changes the name of an interactive form field.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
DynaPDF | 4.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "DynaPDF.SetFieldName"; PDF; Field; NewName ) More
Parameters
Parameter | Description | Example |
---|---|---|
The PDF reference returned from DynaPDF.New. | ||
Field | The field index or field name. | "FirstName" |
NewName | The new name for the field. | "LastName" |
Result
Returns OK or error.
Description
Changes the name of an interactive form field.Field names must sometimes be changed when multiple interactive forms with identical field names are imported. The resulting form will be damaged if the names of such fields are not changed.
The function SetFieldName() does not check whether a field name is already in use by another field. Such a checking would not be useful, because the usage of the function would be much more complicated. Use the function DynaPDF.CheckFieldNames to check the integrity of the form after field names were changed.
Changing of field names can cause problems if the field was used in JavaScript action or global JavaScript. The JavaScript(s) must also be changed to avoid error messages in Adobe's Acrobat. Global JavaScripts can be accessed with the function DynaPDF.GetJavaScript and changed with the function DynaPDF.ChangeJavaScript. A JavaScript Action can be accessed with the function DynaPDF.GetJavaScriptAction and changed with the function DynaPDF.ChangeJavaScriptAction.
See also SetFieldName function in DynaPDF manual.
See also
- DynaPDF.CheckFieldNames
- DynaPDF.GetFieldMapName
- DynaPDF.GetFieldName
- DynaPDF.GetFieldType
- DynaPDF.GetJavaScript
- DynaPDF.GetJavaScriptAction
- DynaPDF.New
- DynaPDF.SetFieldColor
- DynaPDF.SetFieldFlags
- DynaPDF.SetFieldMapName
Release notes
- Version 11.2
- Fixed DynaPDF.SetFieldName to allow to specify field to rename by name.
Blog Entries
This function checks for a license.
Created 18th August 2014, last changed 18th August 2014