Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old


Queries all form fields as JSON array.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 10.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "DynaPDF.GetFieldsAsJSON"; PDF { ; Flags } )   More


Parameter Description Example Flags
PDF The PDF reference returned from DynaPDF.New. $pdf
Flags Pass value for combination of flags you need.
Add 1 to get flat list instead of fields and children as items within the parent field.
Add 2 to include font information for field and edit fonts.
Add 4 to include font buffer data.
0 Optional


Returns JSON or error.


Queries all form fields as JSON array.
See TPDFFieldEx structure in DynaPDF help, which we convert to JSON for you.

Keys include Deleted, BBox, FieldType, GroupType, Handle, BackColor, BackColorSP, BorderColor, BorderColorSP, BorderStyle, BorderWidth, CharSpacing, Checked, CheckBoxChar, DefState, Description, EditFont, ExpValCount, ExpValue, FieldFlags, FieldFont, FontSize, FieldName, HighlightMode, IsCalcField, MapName, MaxLen, ChildrenCount, Children, Parent, PageNum, Rotate, TextAlign, TextColor, TextColorSP, TextScaling, ToolTip, UniqueName, Value, WordSpacing, PageIndex, Barcode, Signature, ModDate, CaptionPos, DownCaption, DownImage, RollCaption, RollImage, UpCaption, UpImage, OC, Action, Action and Events.

Added FullyQualifiedFieldName as field for v14.0.

See also GetFieldsAsJSON function in DynaPDF manual.


Query JSON:

Set Variable [ $JSON; Value: MBS( "DynaPDF.GetFieldsAsJSON"; PDF ) ]

Query document information:

Set Variable [ $pdf ; Value: MBS("DynaPDF.New") ]
# Load PDF from container
Set Variable [ $r ; Value: MBS("DynaPDF.OpenPDFFromContainer"; $pdf; PDF JSON::PDF) ]
# import a page
Set Variable [ $r ; Value: MBS("DynaPDF.ImportPDFFile"; $pdf; 1) ]
# query all fields:
Set Variable [ $JSON ; Value: MBS("DynaPDF.GetFieldsAsJSON"; $pdf) ]
If [ MBS("IsError") = 0 ]
    Set Variable [ $JSON ; Value: MBS("JSON.Colorize"; $JSON) ]
End If
# store in field
Set Field [ PDF JSON::JSON ; $JSON ]
# Release memory
Set Variable [ $r ; Value: MBS("DynaPDF.Release"; $pdf) ]

See also

Release notes

Example Databases

Blog Entries

This function checks for a license.

Created 16th September 2020, last changed 8th November 2023

DynaPDF.GetFieldType - DynaPDF.GetFontAsJSON