DynaPDF.GetFieldAsJSON
Queries one form fields as JSON object.
Component |
Version |
macOS |
Windows |
Linux |
Server |
iOS SDK |
DynaPDF
|
10.5 |
✅ Yes |
✅ Yes |
✅ Yes |
✅ Yes |
✅ Yes |
MBS( "DynaPDF.GetFieldAsJSON"; PDF; Field )
More
MBS(
"DynaPDF.GetFieldAsJSON"; /* Queries one form fields as JSON object. */
$PDF; /* The PDF reference returned from
DynaPDF.New. */
$Field) /* The field index or field name.
Zero based and up to
DynaPDF.GetFieldCount-1.e.g. "FirstName" */
Less
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" |
Result
Returns JSON or error.
Description
Queries one form fields as JSON object.
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 GetFieldAsJSON function in DynaPDF manual.
Examples
Query JSON for one field by name:
Set Variable [ $JSON ; Value: MBS( "DynaPDF.GetFieldAsJSON"; $PDF; "FirstName" ) ]
Query JSON for one field by index:
Set Variable [ $JSON ; Value: MBS( "DynaPDF.GetFieldAsJSON"; $PDF; 0 ) ]
See also
Release notes
- Version 14.0
- Version 11.0
- Version 10.5
Blog Entries
This function checks for a license.
Created 19th September 2020, last changed 8th November 2023
DynaPDF.GetField
-
DynaPDF.GetFieldBackColor