Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 10.1   10.2   10.3   10.4   10.5   11.0   11.1   11.2   11.3   11.4    Statistic    FMM    Blog  

DynaPDF.GetField

Returns the most important properties of a field.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 4.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "DynaPDF.GetField"; PDF; Field; Selector )   More

(old name: DynaPDF.GetFieldEx)

Parameters

Parameter Description Example
PDF The PDF reference returned from DynaPDF.New. $pdf
Field The field index or field name.
Zero based and up to DynaPDF.GetFieldCount-1.
"FirstName"
Selector What value to query. Can be Deleted, BBox, FieldType, GroupType, Handle, BackColor, BackColorSP, BorderColor, BorderColorSP, BorderStyle, BorderWidth, CharSpacing, Checked, CheckBoxChar, DefState, DefValue, EditFont, ExpValueCount, BorderColor, FieldFlags, FieldFont, FontSize, FieldName, HighlightMode, IsCalcField, MapName, MaxLen, KidCount, PageNum, Rotate, TextAlign, TextColor, TextColorSP, TextScaling, ToolTip, UniqueName, Value, WordSpacing, Parent or Kids.

Added ModDate, CaptionPos, DownCaption, DownImage, RollCaption, RollImage, UpCaption, UpImage, Action and ActionType for version 9.0.
"Name"

Result

Returns field handle or error.

Description

Returns the most important properties of a field.
Field handles are simple array indexes into the field array of the global AcroForm object. To enumerate all fields of a document execute the function in a loop from 0 though DynaPDF.GetFieldCount-1.
See GetFieldEx function in DynaPDF help file for details.

See also GetFieldEx function in DynaPDF manual.

Examples

Query bounding box of field:

MBS( "DynaPDF.GetField"; $pdf; "FirstName"; "BBox" )

See also

Release notes

Example Databases

Blog Entries

Created 18th August 2014, last changed 28th May 2019


DynaPDF.GetFTextHeightEx - DynaPDF.GetFieldAsJSON

Feedback: Report problem or ask question.