itext.forms
An interactive control on the screen that raises events and/or can retain data.
Button field flags
Returns Btn, the form type for choice form fields.
the form type, as a
If true, the field is a set of radio buttons; if false, the field is a
check box.
If true, the field is a set of radio buttons; if false, the field is a
check box. This flag only works if the Pushbutton flag is set to false.
whether the field is currently radio buttons or a checkbox
If true, the field is a set of radio buttons; if false, the field is a
check box.
If true, the field is a set of radio buttons; if false, the field is a
check box. This flag should be set only if the Pushbutton flag is set to false.
whether the field should be radio buttons or a checkbox
current
If true, clicking the selected button deselects it, leaving no button
selected.
If true, clicking the selected button deselects it, leaving no button
selected. If false, exactly one radio button shall be selected at all
times. Only valid for radio buttons.
whether a radio button currently allows to choose no options
If true, clicking the selected button deselects it, leaving no button selected.
If true, clicking the selected button deselects it, leaving no button selected.
If false, exactly one radio button shall be selected at all times.
whether a radio button may allow to choose no options
current
If true, the field is a pushbutton that does not retain a permanent value.
whether or not the field is currently a pushbutton
If true, the field is a pushbutton that does not retain a permanent value.
whether or not to set the field to a pushbutton
current
If true, a group of radio buttons within a radio button field that use
the same value for the on state will turn on and off in unison;
that is if one is checked, they are all checked.
If true, a group of radio buttons within a radio button field that use
the same value for the on state will turn on and off in unison;
that is if one is checked, they are all checked.
If false, the buttons are mutually exclusive
whether or not buttons are turned off in unison
If true, a group of radio buttons within a radio button field that use
the same value for the on state will turn on and off in unison; that is
if one is checked, they are all checked.
If true, a group of radio buttons within a radio button field that use
the same value for the on state will turn on and off in unison; that is
if one is checked, they are all checked.
If false, the buttons are mutually exclusive
whether or not buttons should turn off in unison
current
An AcroForm field type representing any type of choice field.
An AcroForm field type representing any type of choice field. Choice fields
are to be represented by a viewer as a list box or a combo box.
Choice field flags
Returns Ch, the form type for choice form fields.
the form type, as a
Sets the index of the first visible option in a scrollable list.
the index of the first option
current
Gets the current index of the first option in a scrollable list.
the index of the first option, as a
Sets the selected items in the field.
a sorted array of indices representing selected items in the field
current
Highlights the options.
Highlights the options. If this method is used for Combo box, the first value in input array
will be the field value
Array of options to be highlighted
current
Highlights the options.
Highlights the options. Is this method is used for Combo box, the first value in input array
will be the field value
The option numbers
The edited
Gets the currently selected items in the field
a sorted array of indices representing the currently selected items in the field
If true, the field is a combo box; if false, the field is a list box.
whether or not the field should be a combo box
current
If true, the field is a combo box; if false, the field is a list box.
whether or not the field is now a combo box.
If true, the combo box shall include an editable text box as well as a
drop-down list; if false, it shall include only a drop-down list.
If true, the combo box shall include an editable text box as well as a
drop-down list; if false, it shall include only a drop-down list.
This flag shall be used only if the Combo flag is true.
whether or not to add an editable text box
current
If true, the combo box shall include an editable text box as well as a
drop-down list; if false, it shall include only a drop-down list.
If true, the combo box shall include an editable text box as well as a
drop-down list; if false, it shall include only a drop-down list.
This flag shall be used only if the Combo flag is true.
whether or not there is currently an editable text box
If true, the field's option items shall be sorted alphabetically.
If true, the field's option items shall be sorted alphabetically.
This flag is intended for use by writers, not by readers.
whether or not to sort the items
current
If true, the field's option items shall be sorted alphabetically.
If true, the field's option items shall be sorted alphabetically.
This flag is intended for use by writers, not by readers.
whether or not the items are currently sorted
If true, more than one of the field's option items may be selected
simultaneously; if false, at most one item shall be selected.
whether or not to allow multiple selection
current
If true, more than one of the field's option items may be selected simultaneously; if false, at most one item shall be selected.
whether or not multiple selection is currently allowed
If true, text entered in the field shall be spell-checked..
whether or not to require the PDF viewer to perform a spell check
current
If true, text entered in the field shall be spell-checked..
whether or not PDF viewer must perform a spell check
If true, the new value shall be committed as soon as a selection is made (commonly with the pointing device).
whether or not to save changes immediately
current
If true, the new value shall be committed as soon as a selection is made (commonly with the pointing device).
whether or not to save changes immediately
This class represents a single field or field group in an
AcroForm.
This class represents a single field or field group in an
AcroForm.
To be able to be wrapped with this
the
must be indirect.
Flag that designates, if set, that the field can contain multiple lines
of text.
Flag that designates, if set, that the field's contents must be obfuscated.
Size of text in form fields when font size is not explicitly set.
A field with the symbol check
A field with the symbol circle
A field with the symbol cross
A field with the symbol diamond
A field with the symbol square
A field with the symbol star
Creates a form field as a wrapper object around a
.
Creates a form field as a wrapper object around a
.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
Creates a minimal
.
The document
Creates a form field as a parent of a
.
The widget which will be a kid of the
The document
Makes a field flag by bit position.
Makes a field flag by bit position. Bit positions are numbered 1 to 32.
But position 0 corresponds to flag 1, position 3 corresponds to flag 4 etc.
bit position of a flag in range 1 to 32 from the pdf specification.
corresponding field flag.
Creates an empty form field without a predefined set of layout or
behavior.
the
to create the field in
a new
Creates an empty form field without a predefined set of layout or
behavior.
the
to create the field in
the
of the document.
null if it's no PDF/A document
a new
Creates an empty
button form field
with custom
behavior and layout, on a specified location.
the
to create the button field in
the location on the page for the button
an int, containing a set of binary behavioral
flags. Do binary OR on this int to set the
flags you require.
a new
Creates an empty
button form field
with custom
behavior and layout, on a specified location.
the
to create the button field in
the location on the page for the button
an int, containing a set of binary behavioral
flags. Do binary OR on this int to set the
flags you require.
the
of the document.
null if it's no PDF/A document
a new
Creates an empty
button form field
with custom
behavior and layout.
the
to create the button field in
an int, containing a set of binary behavioral
flags. Do binary OR on this int to set the
flags you require.
a new
Creates an empty
button form field
with custom
behavior and layout.
the
to create the button field in
an int, containing a set of binary behavioral
flags. Do binary OR on this int to set the
flags you require.
the
of the document.
null if it's no PDF/A document
a new
Creates an empty
text form field.
the
to create the text field in
a new
Creates an empty
text form field.
the
to create the text field in
the desired
of the field. Must match the conformance
level of the
this field will eventually be added into
a new
Creates an empty
text form field.
the
to create the text field in
the location on the page for the text field
a new
Creates a named
text form field
with an initial
value, and the form's default font specified in
.
the
to create the text field in
the location on the page for the text field
the name of the form field
a new
Creates a named
text form field
with an initial
value, and the form's default font specified in
.
the
to create the text field in
the location on the page for the text field
the name of the form field
the initial value
a new
Creates a named
text form field
with an initial
value, with a specified font and font size.
the
to create the text field in
the location on the page for the text field
the name of the form field
the initial value
a
the size of the font
a new
Creates a named
text form field
with an initial
value, with a specified font and font size.
the
to create the text field in
the location on the page for the text field
the name of the form field
the initial value
a
the size of the font
true for multiline text field
a new
Creates a named
text form field
with an initial
value, with a specified font and font size.
the
to create the text field in
the location on the page for the text field
the name of the form field
the initial value
a
the size of the font
true for multiline text field
the
of the document.
null if it's no PDF/A document
a new
Creates a named
multilined text form field
with an initial
value, with a specified font and font size.
the
to create the text field in
the location on the page for the text field
the name of the form field
the initial value
a
the size of the font
a new
Creates a named
multiline text form field
with an initial
value, and the form's default font specified in
.
the
to create the text field in
the location on the page for the text field
the name of the form field
the initial value
a new
Creates an empty
choice form field.
the
to create the choice field in
an int, containing a set of binary behavioral
flags. Do binary OR on this int to set the
flags you require.
a new
Creates an empty
choice form field.
the
to create the choice field in
an int, containing a set of binary behavioral
flags. Do binary OR on this int to set the
flags you require.
the
of the document.
null if it's no PDF/A document
a new
Creates an empty
choice form field
with custom
behavior and layout, on a specified location.
the
to create the choice field in
the location on the page for the choice field
an int, containing a set of binary behavioral
flags. Do binary OR on this int to set the
flags you require.
a new
Creates a
choice form field
with custom
behavior and layout, on a specified location.
the
to create the choice field in
the location on the page for the choice field
the name of the form field
the initial value
an array of
objects that each represent
the 'on' state of one of the choices.
an int, containing a set of binary behavioral
flags. Do binary OR on this int to set the
flags you require.
a new
Creates a
choice form field
with custom
behavior and layout, on a specified location.
the
to create the choice field in
the location on the page for the choice field
the name of the form field
the initial value
an array of
objects that each represent
the 'on' state of one of the choices.
an int, containing a set of binary behavioral
flags. Do binary OR on this int to set the
flags you require.
the desired font to be used when displaying the text
the
of the document.
null if it's no PDF/A document
a new
Creates a
choice form field
with custom
behavior and layout, on a specified location.
the
to create the choice field in
the location on the page for the choice field
the name of the form field
the initial value
a
the size of the font
an array of
objects that each represent
the 'on' state of one of the choices.
an int, containing a set of binary behavioral
flags. Do binary OR on this int to set the
flags you require.
a new
Creates a
choice form field
with custom
behavior and layout, on a specified location.
the
to create the choice field in
the location on the page for the choice field
the name of the form field
the initial value
a
the size of the font
an array of
objects that each represent
the 'on' state of one of the choices.
an int, containing a set of binary behavioral
flags. Do binary OR on this int to set the
flags you require.
the
of the document.
null if it's no PDF/A document
a new
Creates an empty
signature form field.
the
to create the signature field in
a new
Creates an empty
signature form field.
the
to create the signature field in
the
of the document.
null if it's no PDF/A document
a new
Creates an empty
signature form field.
the
to create the signature field in
the location on the page for the signature field
a new
Creates an empty
signature form field.
the
to create the signature field in
the location on the page for the signature field
the
of the document.
null if it's no PDF/A document
a new
Creates a
radio group form field.
the
to create the radio group in
the name of the form field
the initial value
a new
radio group
Creates a
radio group form field.
the
to create the radio group in
the name of the form field
the initial value
the
of the document.
null if it's no PDF/A document
a new
radio group
Creates a generic
that is added to a radio group.
the
to create the radio group in
the location on the page for the field
the radio button group that this field should belong to
the initial value
a new
Creates a generic
that is added to a radio group.
the
to create the radio group in
the location on the page for the field
the radio button group that this field should belong to
the initial value
the
of the document.
null if it's no PDF/A document
a new
Creates a
as a push button without data.
the
to create the radio group in
the location on the page for the field
the name of the form field
the text to display on the button
a new
Creates a
as a push button without data, with
its caption in a custom font.
the
to create the radio group in
the location on the page for the field
the name of the form field
the text to display on the button
a
the size of the font
a new
Creates a
as a push button without data, with
its caption in a custom font.
the
to create the radio group in
the location on the page for the field
the name of the form field
the text to display on the button
a
the size of the font
the
of the document.
null if it's no PDF/A document
a new
Creates a
as a checkbox.
the
to create the radio group in
the location on the page for the field
the name of the form field
the initial value
a new
checkbox
Creates a
as a checkbox.
the
to create the radio group in
the location on the page for the field
the name of the form field
the initial value
the type of checkbox graphic to use.
a new
checkbox
Creates a
as a checkbox.
Creates a
as a checkbox. Check symbol will fit rectangle.
You may set font and font size after creation.
the
to create the radio group in
the location on the page for the field
the name of the form field
the initial value
the type of checkbox graphic to use.
the
of the document.
null if it's no PDF/A document
a new
checkbox
Creates a
combobox
with custom
behavior and layout, on a specified location.
the
to create the combobox in
the location on the page for the combobox
the name of the form field
the initial value
a two-dimensional array of Strings which will be converted
to a PdfArray.
a new
as a combobox
Creates a
combobox
with custom
behavior and layout, on a specified location.
the
to create the combobox in
the location on the page for the combobox
the name of the form field
the initial value
a two-dimensional array of Strings which will be converted
to a PdfArray.
the desired font to be used when displaying the text
the
of the document.
null if it's no PDF/A document
a new
as a combobox
Creates a
combobox
with custom
behavior and layout, on a specified location.
the
to create the combobox in
the location on the page for the combobox
the name of the form field
the initial value
an array of Strings which will be converted to a PdfArray.
a new
as a combobox
Creates a
combobox
with custom
behavior and layout, on a specified location.
the
to create the combobox in
the location on the page for the combobox
the name of the form field
the initial value
an array of Strings which will be converted to a PdfArray.
the desired font to be used when displaying the text
the
of the document.
null if it's no PDF/A document
a new
as a combobox
Creates a
list field
with custom
behavior and layout, on a specified location.
the
to create the choice field in
the location on the page for the choice field
the name of the form field
the initial value
a two-dimensional array of Strings which will be converted
to a PdfArray.
a new
as a list field
Creates a
list field
with custom
behavior and layout, on a specified location.
the
to create the choice field in
the location on the page for the choice field
the name of the form field
the initial value
a two-dimensional array of Strings which will be converted
to a PdfArray.
the desired font to be used when displaying the text
the
of the document.
null if it's no PDF/A document
a new
as a list field
Creates a
list field
with custom
behavior and layout, on a specified location.
the
to create the list field in
the location on the page for the list field
the name of the form field
the initial value
an array of Strings which will be converted to a PdfArray.
a new
as a list field
Creates a
list field
with custom
behavior and layout, on a specified location.
the
to create the list field in
the location on the page for the list field
the name of the form field
the initial value
an array of Strings which will be converted to a PdfArray.
the desired font to be used when displaying the text
the
of the document.
null if it's no PDF/A document
a new
as a list field
Creates a (subtype of)
object.
Creates a (subtype of)
object. The type of the object
depends on the FT entry in the pdfObject parameter.
assumed to be either a
, or a
to a
the
to create the field in
a new
, or null if
pdfObject does not contain a FT entry
Returns the type of the parent form field, or of the wrapped
<PdfDictionary> object.
the form type, as a
Sets a value to the field and generating field appearance if needed.
of the field
the field
Sets a value to the field and generating field appearance if needed.
of the field
set this flat to false if you want to keep the appearance of the field generated before
the field
Set text field value with given font and size
text value
a
the size of the font
the edited field
Sets the field value and the display string.
Sets the field value and the display string. The display string
is used to build the appearance.
the field value
the string that is used for the appearance. If null
the value parameter will be used
the edited field
Sets a parent
for the current object.
another form field that this field belongs to, usually a group field
the edited field
Gets the parent dictionary.
another form field that this field belongs to, usually a group field
Gets the kids of this object.
contents of the dictionary's Kids property, as a
Adds a new kid to the Kids array property from a
.
Adds a new kid to the Kids array property from a
. Also sets the kid's Parent property to this object.
a new
entry for the field's Kids array property
the edited field
Adds a new kid to the Kids array property from a
.
Adds a new kid to the Kids array property from a
. Also sets the kid's Parent property to this object.
a new
entry for the field's Kids array property
the edited field
Changes the name of the field to the specified value.
the new field name, as a String
the edited field
Gets the current field name.
the current field name, as a
Changes the alternate name of the field to the specified value.
Changes the alternate name of the field to the specified value. The
alternate is a descriptive name to be used by status messages etc.
the new alternate name, as a String
the edited field
Gets the current alternate name.
Gets the current alternate name. The alternate is a descriptive name to
be used by status messages etc.
the current alternate name, as a
Changes the mapping name of the field to the specified value.
Changes the mapping name of the field to the specified value. The
mapping name can be used when exporting the form data in the document.
the new alternate name, as a String
the edited field
Gets the current mapping name.
Gets the current mapping name. The mapping name can be used when
exporting the form data in the document.
the current mapping name, as a
Checks whether a certain flag, or any of a combination of flags, is set
for this form field.
an int interpreted as a series of a binary flags
true if any of the flags specified in the parameter is also set
in the form field.
Adds a flag, or combination of flags, for the form field.
Adds a flag, or combination of flags, for the form field. This method is
intended to be used one flag at a time, but this is not technically
enforced. To replace the current value, use
.
an int interpreted as a series of a binary flags
the edited field
Adds or removes a flag, or combination of flags, for the form field.
Adds or removes a flag, or combination of flags, for the form field. This
method is intended to be used one flag at a time, but this is not
technically enforced. To replace the current value, use
.
an int interpreted as a series of a binary flags
if true, adds the flag(s). if false,
removes the flag(s).
the edited field
If true, the field can contain multiple lines of text; if false, the field's text is restricted to a single line.
whether the field can span over multiple lines.
If true, the field is intended for entering a secure password that should not be echoed visibly to the screen.
If true, the field is intended for entering a secure password that should not be echoed visibly to the screen.
Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters.
whether or not the contents of the field must be obfuscated
Sets a flag, or combination of flags, for the form field.
Sets a flag, or combination of flags, for the form field. This method
replaces the previous value. Compare with
which adds a flag to the existing flags.
an int interpreted as a series of a binary flags
the edited field
Gets the current list of PDF form field flags.
the current list of flags, encoded as an int
Gets the current value contained in the form field.
the current value, as a
Gets the current value contained in the form field.
the current value, as a
Sets the default fallback value for the form field.
the default value
the edited field
Gets the default fallback value for the form field.
the default value
Sets an additional action for the form field.
the dictionary key to use for storing the action
the action
the edited field
Gets the currently additional action dictionary for the form field.
the additional action dictionary
Sets options for the form field.
Sets options for the form field. Only to be used for checkboxes and radio buttons.
an array of
objects that each represent
the 'on' state of one of the choices.
the edited field
Gets options for the form field.
Gets options for the form field. Should only return usable values for
checkboxes and radio buttons.
the options, as an
of
objects
Gets all
that this form field and its
kids
refer to.
a list of
Gets default appearance string containing a sequence of valid page-content graphics or text state operators that
define such properties as the field's text size and color.
the default appearance graphics, as a
Sets default appearance string containing a sequence of valid page-content graphics or text state operators that
define such properties as the field's text size and color.
a valid sequence of PDF content stream syntax
the edited field
Updates DA for Variable text, Push button and choice form fields.
Updates DA for Variable text, Push button and choice form fields.
The resources required for DA will be put to AcroForm's DR.
Note, for other form field types DA will be removed.
Gets a code specifying the form of quadding (justification) to be used in displaying the text:
0 Left-justified
1 Centered
2 Right-justified
the current justification attribute
Sets a code specifying the form of quadding (justification) to be used in displaying the text:
0 Left-justified
1 Centered
2 Right-justified
the value to set the justification attribute to
the edited field
Gets a default style string, as described in "Rich Text Strings" section of Pdf spec.
the default style, as a
Sets a default style string, as described in "Rich Text Strings" section of Pdf spec.
a new default style for the form field
the edited field
Gets a rich text string, as described in "Rich Text Strings" section of Pdf spec.
Gets a rich text string, as described in "Rich Text Strings" section of Pdf spec.
May be either
or
.
the current rich text value
Sets a rich text string, as described in "Rich Text Strings" section of Pdf spec.
Sets a rich text string, as described in "Rich Text Strings" section of Pdf spec.
May be either
or
.
a new rich text value
The edited PdfFormField
Gets the current fontSize of the form field.
the current fontSize
Gets the current font of the form field.
the current
font
Gets the current color of the form field.
the current
color
Basic setter for the font property.
Basic setter for the font property. Regenerates the field
appearance after setting the new value.
Note that the font will be added to the document so ensure that the font is embedded
if it's a pdf/a document.
The new font to be set
The edited PdfFormField
Basic setter for the fontSize property.
Basic setter for the fontSize property. Regenerates the
field appearance after setting the new value.
The new font size to be set
The edited PdfFormField
Basic setter for the fontSize property.
Basic setter for the fontSize property. Regenerates the
field appearance after setting the new value.
The new font size to be set
The edited PdfFormField
Combined setter for the font and fontSize
properties.
Combined setter for the font and fontSize
properties. Regenerates the field appearance after setting the new value.
The new font to be set
The new font size to be set
The edited PdfFormField
Combined setter for the font and fontSize
properties.
Combined setter for the font and fontSize
properties. Regenerates the field appearance after setting the new value.
The new font to be set
The new font size to be set
The edited PdfFormField
Basic setter for the backgroundColor property.
Basic setter for the backgroundColor property. Regenerates
the field appearance after setting the new value.
The new color to be set or
if no background needed
The edited PdfFormField
Basic setter for the degRotation property.
Basic setter for the degRotation property. Regenerates
the field appearance after setting the new value.
The new degRotation to be set
The edited PdfFormField
Sets the action on all
widgets
of this form field.
The action
The edited field
Changes the type of graphical marker used to mark a checkbox as 'on'.
Changes the type of graphical marker used to mark a checkbox as 'on'.
Notice that in order to complete the change one should call
regenerateField
method
the new checkbox marker
The edited field
Set the visibility flags of the form field annotation
Options are: HIDDEN, HIDDEN_BUT_PRINTABLE, VISIBLE, VISIBLE_BUT_DOES_NOT_PRINT
visibility option
The edited field
This method regenerates appearance stream of the field.
This method regenerates appearance stream of the field. Use it if you
changed any field parameters and didn't use setValue method which
generates appearance by itself.
whether or not the regeneration was successful.
Gets the border width for the field.
the current border width.
Sets the border width for the field.
The new border width.
The edited field
Sets the Border Color.
the new value for the Border Color
the edited field
Sets the text color.
the new value for the Color
the edited field
Sets the ReadOnly flag, specifying whether or not the field can be changed.
if true, then the field cannot be changed.
the edited field
Gets the ReadOnly flag, specifying whether or not the field can be changed.
true if the field cannot be changed.
Sets the Required flag, specifying whether or not the field must be filled in.
if true, then the field must be filled in.
the edited field
Gets the Required flag, specifying whether or not the field must be filled in.
true if the field must be filled in.
Sets the NoExport flag, specifying whether or not exporting is forbidden.
if true, then exporting is forbidden
the edited field
Gets the NoExport attribute.
whether exporting the value following a form action is forbidden.
Specifies on which page the form field's widget must be shown.
the page number
the edited field
Gets the appearance state names.
an array of Strings containing the names of the appearance states
Sets an appearance for (the widgets related to) the form field.
the type of appearance stream to be added
- PdfName.N: normal appearance
- PdfName.R: rollover appearance
- PdfName.D: down appearance
the state of the form field that needs to be true
for the appearance to be used. Differentiates between several streams
of the same type.
the appearance instructions, as a
the edited field
Sets zero font size which will be interpreted as auto-size according to ISO 32000-1, 12.7.3.3.
the edited field
Releases underlying pdf object and other pdf entities used by wrapper.
Releases underlying pdf object and other pdf entities used by wrapper.
This method should be called instead of direct call to
if the wrapper is used.
Generate default appearance, /DA key.
preferred font. If
is not null, it will be used instead.
preferred font size. If
is valid,
it will be used instead.
color for the DA
resources
generated string
Gets font and font size.
normal appearance, will be ignored.
array where first index is PdfFont and the second is font name.
Draws the visual appearance of text in a form field.
The location on the page for the list field
a
The size of the font
The initial value
The appearance
Draws the visual appearance of multiline text in a form field.
The location on the page for the list field
a
The size of the font, will be ignored
The initial value
The appearance
Draws the visual appearance of Choice box in a form field.
The location on the page for the list field
The initial value
The appearance
Draws a border using the borderWidth and borderColor of the form field.
The
on which to draw
The PdfFormXObject
The width of the rectangle to draw
The height of the rectangle to draw
Draws the appearance of a radio button with a specified value.
the width of the radio button to draw
the height of the radio button to draw
the value of the button
Draws the appearance of a radio button with a specified value.
the width of the radio button to draw
the height of the radio button to draw
the value of the button
Draws a radio button.
the
on which to draw
the width of the radio button to draw
the height of the radio button to draw
required to be true for fulfilling the drawing operation
Draws the appearance of a checkbox with a specified state value.
the width of the checkbox to draw
the height of the checkbox to draw
the state of the form field that will be drawn
Draws PDF/A-2 compliant check appearance.
Draws PDF/A-2 compliant check appearance.
Actually it's just PdfA check appearance. According to corrigendum there is no difference between them
width of the checkbox
height of the checkbox
name that corresponds to the "On" state of the checkbox
the type that determines how the checkbox will look like. Allowed values are
TYPE_CHECK
,
TYPE_CIRCLE
,
TYPE_CROSS
,
TYPE_DIAMOND
,
TYPE_SQUARE
,
TYPE_STAR
width of the checkbox
height of the checkbox
the selected value of the checkbox which determines the appearance of the checkbox
the type that determines how the checkbox will look like. Allowed values are
TYPE_CHECK
,
TYPE_CIRCLE
,
TYPE_CROSS
,
TYPE_DIAMOND
,
TYPE_SQUARE
,
TYPE_STAR
Draws the appearance for a push button.
the width of the pushbutton
the width of the pushbutton
the text to display on the button
a
the size of the font
a new
Draws the appearance for a push button.
the width of the pushbutton
the width of the pushbutton
the text to display on the button
a
will be ignored.
the size of the font
a new
Performs the low-level drawing operations to draw a button object.
the
of the page to draw on.
will be ignored, according to spec it shall be 0
will be ignored, according to spec it shall be 0
the width of the button
the width of the button
the text to display on the button
a
the size of the font
Performs the low-level drawing operations to draw a checkbox object.
the
of the page to draw on.
the width of the button
the width of the button
the size of the font
the boolean value of the checkbox
Calculate the necessary height offset after applying field rotation
so that the origin of the bounding box is the lower left corner with respect to the field text.
bounding box rectangle before rotation
rotation of the page
rotation of the field relative to the page
translation value for height
Calculate the necessary width offset after applying field rotation
so that the origin of the bounding box is the lower left corner with respect to the field text.
bounding box rectangle before rotation
rotation of the page
rotation of the field relative to the page
translation value for width
Puts object directly to AcroForm dictionary.
Puts object directly to AcroForm dictionary.
It works much faster than consequent invocation of
and
.
Note, this method assume that Catalog already has AcroForm object.
should be called explicitly.
the key of the object.
the object to add.
An AcroForm field containing signature data.
Returns Sig, the form type for signature form fields.
the form type, as a
Adds the signature to the signature field.
the signature to be contained in the signature field, or an indirect reference to it
the edited field
Gets the
, which contains fields that
must be locked if the document is signed.
a dictionary containing locked fields.
An AcroForm field containing textual data.
Returns Tx, the form type for textual form fields.
the form type, as a
If true, the field can contain multiple lines of text; if false, the field?s text is restricted to a single line.
whether or not the file can contain multiple lines of text
current
If true, the field is intended for entering a secure password that should not be echoed visibly to the screen.
If true, the field is intended for entering a secure password that should not be echoed visibly to the screen.
Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters.
whether or not to obscure the typed characters
current
If true, the text entered in the field represents the pathname of a file
whose contents are to be submitted as the value of the field.
whether or not this field currently represents a path
If true, the text entered in the field represents the pathname of a file
whose contents are to be submitted as the value of the field.
whether or not this field should represent a path
current
If true, text entered in the field is spell-checked.
whether or not spell-checking is currently enabled
If true, text entered in the field is spell-checked.
whether or not to spell-check
current
If true, the field scrolls (horizontally for single-line fields, vertically for multiple-line fields)
to accommodate more text than fits within its annotation rectangle.
If true, the field scrolls (horizontally for single-line fields, vertically for multiple-line fields)
to accommodate more text than fits within its annotation rectangle.
Once the field is full, no further text is accepted.
whether or not longer texts are currently allowed
If true, the field scrolls (horizontally for single-line fields, vertically for multiple-line fields)
to accommodate more text than fits within its annotation rectangle.
If true, the field scrolls (horizontally for single-line fields, vertically for multiple-line fields)
to accommodate more text than fits within its annotation rectangle.
Once the field is full, no further text is accepted.
whether or not to allow longer texts
current
Meaningful only if the MaxLen entry is present in the text field dictionary
and if the Multiline, Password, and FileSelect flags are clear.
Meaningful only if the MaxLen entry is present in the text field dictionary
and if the Multiline, Password, and FileSelect flags are clear.
If true, the field is automatically divided into as many equally spaced positions,
or combs, as the value of MaxLen, and the text is laid out into those combs.
whether or not combing is enabled
Meaningful only if the MaxLen entry is present in the text field dictionary
and if the Multiline, Password, and FileSelect flags are clear.
Meaningful only if the MaxLen entry is present in the text field dictionary
and if the Multiline, Password, and FileSelect flags are clear.
If true, the field is automatically divided into as many equally spaced positions,
or combs, as the value of MaxLen, and the text is laid out into those combs.
whether or not to enable combing
current
If true, the value of this field should be represented as a rich text string.
If true, the value of this field should be represented as a rich text string.
If the field has a value, the RV entry of the field dictionary specifies the rich text string.
whether or not text is currently represented as rich text
If true, the value of this field should be represented as a rich text string.
If true, the value of this field should be represented as a rich text string.
If the field has a value, the RV entry of the field dictionary specifies the rich text string.
whether or not to represent text as rich text
current
Gets the maximum length of the field's text, in characters.
Gets the maximum length of the field's text, in characters.
This is an optional parameter, so if it is not specified, 0 value will be returned.
the current maximum text length
Sets the maximum length of the field's text, in characters.
the maximum text length
current
This class represents the static form technology AcroForm on a PDF file.
To be used with
.
To be used with
.
If set, the document contains at least one signature field. This flag
allows a conforming reader to enable user interface items (such as menu
items or pushbuttons) related to signature processing without having to
scan the entire document for the presence of signature fields.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
To be used with
.
To be used with
.
If set, the document contains signatures that may be invalidated if the
file is saved (written) in a way that alters its previous contents, as
opposed to an incremental update. Merely updating the file by appending
new information to the end of the previous version is safe. Conforming
readers may use this flag to inform a user requesting a full save that
signatures will be invalidated and require explicit confirmation before
continuing with the operation.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
Keeps track of whether or not appearances must be generated by the form
fields themselves, or by the PDF viewer application.
Keeps track of whether or not appearances must be generated by the form
fields themselves, or by the PDF viewer application. Default is
true.
A map of field names and their associated
form field
objects.
The PdfDocument to which the PdfAcroForm belongs.
Creates a PdfAcroForm as a wrapper of a dictionary.
Creates a PdfAcroForm as a wrapper of a dictionary.
Also initializes an XFA form if an /XFA entry is present in
the dictionary.
the PdfDictionary to be wrapped
Creates a PdfAcroForm from a
of fields.
Creates a PdfAcroForm from a
of fields.
Also initializes an empty XFA form.
a
of
objects
Retrieves AcroForm from the document.
Retrieves AcroForm from the document. If there is no AcroForm in the
document Catalog and createIfNotExist flag is true then the AcroForm
dictionary will be created and added to the document.
the document to retrieve the
from
when true, this method will create a
if none exists for this document
the
document
's AcroForm,
or a new one provided that createIfNotExist parameter is true, otherwise null.
This method adds the field to the last page in the document.
This method adds the field to the last page in the document.
If there's no pages, creates a new one.
the
to be added to the form
This method adds the field to a specific page.
the
to be added to the form
the
on which to add the field
This method merges field with its annotation and place it on the given
page.
This method merges field with its annotation and place it on the given
page. This method won't work if the field has no or more than one widget
annotations.
the
to be added to the form
the
on which to add the field
Gets the
form field
s as a
.
a map of field names and their associated
form field
objects
Gets a collection of
form field
s, prepared for flattening using
method.
Gets a collection of
form field
s, prepared for flattening using
method.
If returned collection is empty, all form fields will be flattened on
flattenFields
call.
a collection of
form field
s for flattening
Gets the
this
belongs to.
the document of this form
Sets the NeedAppearances boolean property on the AcroForm.
Sets the NeedAppearances boolean property on the AcroForm.
NeedAppearances has been deprecated in PDF 2.0.
NeedAppearances is a flag specifying whether to construct appearance
streams and appearance dictionaries for all widget annotations in the
document.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
a boolean. Default value is false
current AcroForm.
Gets the NeedAppearances boolean property on the AcroForm.
Gets the NeedAppearances boolean property on the AcroForm.
NeedAppearances has been deprecated in PDF 2.0.
NeedAppearances is a flag specifying whether to construct appearance
streams and appearance dictionaries for all widget annotations in the
document.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
the NeedAppearances property as a
. Default value is false
Sets the SigFlags integer property on the AcroForm.
Sets the SigFlags integer property on the AcroForm.
SigFlags is a set of flags specifying various document-level
characteristics related to signature fields.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
an integer. Use
and/or
.
Use bitwise OR operator to combine these values. Default value is 0
current AcroForm.
Changes the SigFlags integer property on the AcroForm.
Changes the SigFlags integer property on the AcroForm.
This method allows only to add flags, not to remove them.
SigFlags is a set of flags specifying various document-level
characteristics related to signature fields.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
an integer. Use
and/or
.
Use bitwise OR operator to combine these values. Default is 0
current AcroForm.
Gets the SigFlags integer property on the AcroForm.
Gets the SigFlags integer property on the AcroForm.
SigFlags is a set of flags specifying various document-level
characteristics related to signature fields
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
current value for SigFlags.
Sets the CO array property on the AcroForm.
Sets the CO array property on the AcroForm.
CO, Calculation Order, is an array of indirect references to
field dictionaries with calculation actions, defining the calculation
order in which their values will be recalculated when the value of any
field changes
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
an array of indirect references
current AcroForm
Gets the CO array property on the AcroForm.
Gets the CO array property on the AcroForm.
CO, Calculation Order, is an array of indirect references to
field dictionaries with calculation actions, defining the calculation
order in which their values will be recalculated when the value of any
field changes
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
an array of indirect references
Sets the DR dictionary property on the AcroForm.
Sets the DR dictionary property on the AcroForm.
DR is a resource dictionary containing default resources
(such as fonts, patterns, or colour spaces) that shall be used by form
field appearance streams. At a minimum, this dictionary shall contain a
Font entry specifying the resource name and font dictionary of the
default font for displaying text.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
a resource dictionary
current AcroForm
Gets the DR dictionary property on the AcroForm.
Gets the DR dictionary property on the AcroForm.
DR is a resource dictionary containing default resources
(such as fonts, patterns, or colour spaces) that shall be used by form
field appearance streams. At a minimum, this dictionary shall contain a
Font entry specifying the resource name and font dictionary of the
default font for displaying text.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
a resource dictionary
Sets the DA String property on the AcroForm.
Sets the DA String property on the AcroForm.
This method sets a default (fallback value) for the DA
attribute of variable text
form field
s.
a String containing a sequence of valid PDF syntax
current AcroForm
Gets the DA String property on the AcroForm.
Gets the DA String property on the AcroForm.
This method returns the default (fallback value) for the DA
attribute of variable text
form field
s.
the form-wide default appearance, as a String
Sets the Q integer property on the AcroForm.
Sets the Q integer property on the AcroForm.
This method sets a default (fallback value) for the Q
attribute of variable text
form field
s.
an integer representing a justification value
current AcroForm
Gets the Q integer property on the AcroForm.
Gets the Q integer property on the AcroForm.
This method gets the default (fallback value) for the Q
attribute of variable text
form field
s.
an integer representing a justification value
Sets the XFA property on the AcroForm.
Sets the XFA property on the AcroForm.
XFA can either be a
or a
.
Its contents must be valid XFA.
a stream containing the XDP
current AcroForm
Sets the XFA property on the AcroForm.
Sets the XFA property on the AcroForm.
XFA can either be a
or a
.
Its contents must be valid XFA.
an array of text string and stream pairs representing
the individual packets comprising the XML Data Package. (ISO 32000-1,
section 12.7.2 "Interactive Form Dictionary")
current AcroForm
Gets the XFA property on the AcroForm.
an object representing the entire XDP. It can either be a
or a
.
Gets a
form field
by its name.
the name of the
form field
to retrieve
the
form field
, or null if it
isn't present
Gets the attribute generateAppearance, which tells
to generate an appearance Stream for all
form field
s
that don't have one.
bolean value indicating if the appearances need to be generated
Sets the attribute generateAppearance, which tells
to generate an appearance Stream for all
form field
s
that don't have one.
Sets the attribute generateAppearance, which tells
to generate an appearance Stream for all
form field
s
that don't have one.
Not generating appearances will speed up form flattening but the results
can be unexpected in Acrobat. Don't use it unless your environment is
well controlled. The default is true.
If generateAppearance is set to true, then
NeedAppearances is set to false. This does not
apply vice versa.
Note, this method does not change default behaviour of
method.
a boolean
Flattens interactive
form field
s in the document.
Flattens interactive
form field
s in the document. If
no fields have been explicitly included via
,
then all fields are flattened. Otherwise only the included fields are
flattened.
Tries to remove the
form field
with the specified
name from the document.
the name of the
form field
to remove
a boolean representing whether or not the removal succeeded.
Adds a
form field
, identified by name, to the list of fields to be flattened.
Adds a
form field
, identified by name, to the list of fields to be flattened.
Does not perform a flattening operation in itself.
the name of the
form field
to be flattened
Changes the identifier of a
form field.
the current name of the field
the new name of the field. Must not be used currently.
Creates an in-memory copy of a
.
Creates an in-memory copy of a
. This new field is
not added to the document.
the name of the
form field
to be copied
a clone of the original
Replaces the
of a certain name with another
.
the name of the
form field
to be replaced
the new
Gets all AcroForm fields in the document.
a
of field dictionaries
Determines whether the AcroForm contains XFA data.
a boolean
Gets the
atribute.
the XFA form object
Removes the XFA stream from the document.
Releases underlying pdf object and other pdf entities used by wrapper.
Releases underlying pdf object and other pdf entities used by wrapper.
This method should be called instead of direct call to
if the wrapper is used.
A sample implementation of the {#link IPdfPageExtraCopier} interface which
copies only AcroForm fields to a new page.
A sample implementation of the {#link IPdfPageExtraCopier} interface which
copies only AcroForm fields to a new page.
NOTE: While it's absolutely not necessary to use the same PdfPageFormCopier instance for copying operations,
it is still worth to know that PdfPageFormCopier uses some caching logic which can potentially improve performance
in case of the reusing of the same instance.
A signature field lock dictionary.
A signature field lock dictionary. Specifies a set of form
fields that shall be locked when this signature field is
signed.
Creates an instance of
.
Creates an instance of
.
The dictionary whose entries should be added to
the signature field lock dictionary.
Sets the permissions granted for the document when the corresponding signature
field is signed.
Sets the permissions granted for the document when the corresponding signature
field is signed. See
for getting more info.
The permissions granted for the document.
This
object.
Sets signature lock for specific fields in the document.
Indicates the set of fields that should be locked after the actual
signing of the corresponding signature takes place.
Names indicating the fields.
This
object.
Enumerates the different actions of a signature field lock.
Enumerates the different actions of a signature field lock.
Indicates the set of fields that should be locked when the
corresponding signature field is signed:
- all the fields in the document,
- all the fields specified in the /Fields array,
- all the fields except those specified in the /Fields array.
Utility class to draw form fields
.
A class to process "classic" fields.
Creates a new instance from a Collection with the full names.
the Collection
Gets the mapping from short names to long names.
Gets the mapping from short names to long names. A long
name may contain the #subform name part.
the mapping from short names to long names
Sets the mapping from short names to long names.
Sets the mapping from short names to long names. A long
name may contain the #subform name part.
the mapping from short names to long names
A structure to store each part of a SOM name and link it to the next part
beginning from the lower hierarchy.
Gets the full name by traversing the hierarchy using only the
index 0.
the full name
Search the current node for a similar name.
Search the current node for a similar name. A similar name starts
with the same name but has a different index. For example, "detail[3]"
is similar to "detail[9]". The main use is to discard names that
correspond to out of bounds records.
the name to search
true if a similitude was found
Processes XFA forms.
The URI for the XFA Data schema.
An empty constructor to build on.
Creates an XFA form by the stream containing all xml information
The InputStream
Creates an XFA form by the
containing all xml information
The document
A constructor from a
. It is assumed, but not
necessary for correct initialization, that the dictionary is actually a
. An entry in the dictionary with the XFA
key must contain correct XFA syntax. If the XFA key is
absent, then the constructor essentially does nothing.
the dictionary object to initialize from
A constructor from a PdfDocument.
A constructor from a PdfDocument. It basically does everything
from finding the XFA stream to the XML parsing.
the PdfDocument instance
Sets the XFA key from a byte array.
Sets the XFA key from a byte array. The old XFA is erased.
the data
pdfDocument
Sets the XFA key from a byte array.
Sets the XFA key from a byte array. The old XFA is erased.
the data
an AcroForm instance
Extracts DOM nodes from an XFA document.
an XFA file as a
DOM
document
a
of XFA packet names and their associated
DOM nodes
Write the XfaForm to the provided PdfDocument.
the PdfDocument to write the XFA Form to
Write the XfaForm to the provided PdfDocument.
the PdfAcroForm to write the XFA Form to
Changes a field value in the XFA form.
the name of the field to be changed
the new value
Gets the xfa field value.
the fully qualified field name
the field value
Returns true if it is a XFA form.
true if it is a XFA form
Finds the complete field name from a partial name.
the complete or partial name
the complete name or null if not found
Finds the complete SOM name contained in the datasets section from a
possibly partial name.
the complete or partial name
the complete name or null if not found
Finds the Node contained in the datasets section from a
possibly partial name.
the complete or partial name
the Node or null if not found
Gets all the text contained in the child nodes of this node.
the Node
the text found or "" if no text was found
Sets the text of this node.
Sets the text of this node. All the child's node are deleted and a new
child text node is created.
the Node to add the text to
the text to add
Gets the top level DOM document.
the top level DOM document
Sets the top DOM document.
the top DOM document
Gets the Node that corresponds to the datasets part.
the Node that corresponds to the datasets part
Replaces the XFA data under datasets/data.
Replaces the XFA data under datasets/data. Accepts a
file
object
to fill this object with XFA data. The resulting DOM document may
be modified.
the
Replaces the XFA data under datasets/data.
Replaces the XFA data under datasets/data. Accepts a
file
object
to fill this object with XFA data.
the
whether or not the resulting DOM document may be modified
Replaces the XFA data under datasets/data.
Replaces the XFA data under datasets/data. Accepts an
to fill this object with XFA data. The resulting DOM document may be
modified.
the
Replaces the XFA data under datasets/data.
Replaces the XFA data under datasets/data. Accepts an
to fill this object with XFA data.
the
whether or not the resulting DOM document may be modified
Replaces the XFA data under datasets/data.
Replaces the XFA data under datasets/data. Accepts a
SAX input source
to fill this object with XFA data. The resulting DOM
document may be modified.
the
SAX input source
Replaces the XFA data under datasets/data.
Replaces the XFA data under datasets/data. Accepts a
SAX input source
to fill this object with XFA data.
the
SAX input source
whether or not the resulting DOM document may be modified
Replaces the XFA data under datasets/data.
the input
Replaces the XFA data under datasets/data.
the input
whether or not the resulting DOM document may be modified
Return the XFA Object, could be an array, could be a Stream.
Return the XFA Object, could be an array, could be a Stream.
Returns null if no XFA Object is present.
a PdfDocument instance
the XFA object
Return the XFA Object, could be an array, could be a Stream.
Return the XFA Object, could be an array, could be a Stream.
Returns null if no XFA Object is present.
a PdfAcroForm instance
the XFA object
Serializes a XML document to a byte array.
the XML document
the serialized XML document
Extracts the nodes from the domDocument.
Some XFA forms don't have a datasets node.
Some XFA forms don't have a datasets node.
If this is the case, we have to add one.
A class for some basic SOM processing.
The order the names appear in the XML, depth first.
The mapping of full names to nodes.
The data to do a search from the bottom hierarchy.
A stack to be used when parsing.
A temporary store for the repetition count.
Escapes a SOM string fragment replacing "." with "\.".
the unescaped string
the escaped string
Unescapes a SOM string fragment replacing "\." with ".".
the escaped string
the unescaped string
Outputs the stack as the sequence of elements separated
by '.'.
the stack as the sequence of elements separated by '.'
Gets the name with the #subform removed.
the long name
the short name
Adds a SOM name to the search node chain.
the SOM name
Adds a SOM name to the search node chain.
the start point
the stack with the separated SOM parts
the full name
Searches the SOM hierarchy from the bottom.
the SOM parts
the full name or null if not found
Splits a SOM name in the individual parts.
the full SOM name
the split name
Gets the order the names appear in the XML, depth first.
the order the names appear in the XML, depth first
Sets the order the names appear in the XML, depth first
the order the names appear in the XML, depth first
Gets the mapping of full names to nodes.
the mapping of full names to nodes
Sets the mapping of full names to nodes.
the mapping of full names to nodes
Gets the data to do a search from the bottom hierarchy.
the data to do a search from the bottom hierarchy
Sets the data to do a search from the bottom hierarchy.
the data to do a search from the bottom hierarchy
Processes the datasets section in the XFA form.
Creates a new instance from the datasets node.
Creates a new instance from the datasets node. This expects
not the datasets but the data node that comes below.
the datasets node
Inserts a new Node that will match the short name.
the datasets top Node
the short name
the new Node of the inserted name
Represent Action tag in xfdf document structure.
Represent Action tag in xfdf document structure.
Content model: ( URI | Launch | GoTo | GoToR | Named ).
Attributes: none.
For more details see paragraph 6.5.1 in Xfdf specification.
Type of inner action element.
Type of inner action element. Possible values:
,
,
,
,
.
Represents Name, required attribute of URI element.
Represents Name, required attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
Represents IsMap, optional attribute of URI element.
Represents IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
Represents Name, required attribute of Named element.
Represents Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
Represents OriginalName required attribute of File inner element of GoToR or Launch element.
Represents OriginalName required attribute of File inner element of GoToR or Launch element.
Corresponds to F key in go-to action or launch dictionaries.
For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
Represents NewWindow, optional attribute of Launch element.
Represents NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
Represents Dest, inner element of link, GoTo, and GoToR elements.
Represents Dest, inner element of link, GoTo, and GoToR elements.
Corresponds to Dest key in link annotation dictionary.
For more details see paragraph 6.5.10 in Xfdf specification.
Returns the type of inner action element.
Returns the type of inner action element. Possible values:
,
,
,
,
.
Sets the type of inner action element.
Sets the type of inner action element. Possible values:
,
,
,
,
.
Gets the string value of URI elements.
Gets the string value of URI elements. Corresponds to Name, required attribute of URI element.
For more details see paragraph 6.5.30 in Xfdf specification.
Sets the string value of URI elements.
Sets the string value of URI elements. Corresponds to Name, required attribute of URI element.
For more details see paragraph 6.5.30 in Xfdf specification.
Gets IsMap, optional attribute of URI element.
Gets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
Sets IsMap, optional attribute of URI element.
Sets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
Gets the value of Name, required attribute of Named element.
Gets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
Sets the value of Name, required attribute of Named element.
Sets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
Gets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
Gets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
Corresponds to F key in go-to action or launch dictionaries.
For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
Sets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
Sets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
Corresponds to F key in go-to action or launch dictionaries.
For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
Sets the boolean value of NewWindow, optional attribute of Launch element.
Sets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
Gets the boolean value of NewWindow, optional attribute of Launch element.
Gets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
Gets Dest, inner element of link, GoTo, and GoToR elements.
Gets Dest, inner element of link, GoTo, and GoToR elements.
Corresponds to Dest key in link annotation dictionary.
For more details see paragraph 6.5.10 in Xfdf specification.
Sets Dest, inner element of link, GoTo, and GoToR elements.
Sets Dest, inner element of link, GoTo, and GoToR elements.
Corresponds to Dest key in link annotation dictionary.
For more details see paragraph 6.5.10 in Xfdf specification.
Represents annotation, a child element of annots tag in Xfdf document structure.
Represents annotation, a child element of annots tag in Xfdf document structure. For more details see part 6.4 in Xfdf specification.
Represents the type of annotation.
Represents the type of annotation. Possible values:
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
.
Represents a list of attributes of the annotation.
Represents contents tag in Xfdf document structure.
Represents contents tag in Xfdf document structure. Is a child of caret, circle, fileattachment, freetext,
highlight, ink, line, polygon, polyline, sound, square, squiggly, stamp, strikeout, text, and
underline elements.
Corresponds to Contents key in annotation dictionary.
Content model: a string or a rich text string.
For more details see paragraph 6.5.4 in Xfdf document specification.
Represents contents-richtext tag in Xfdf document structure.
Represents contents-richtext tag in Xfdf document structure. Is a child of caret, circle, fileattachment, freetext,
highlight, ink, line, polygon, polyline, sound, square, squiggly, stamp, strikeout, text, and
underline elements.
Corresponds to RC key in annotation dictionary.
Content model: text string.
For more details see paragraph 6.5.5 in Xfdf document specification.
A boolean, indicating if annotation has inner popup element.
Represents a popup annotation, an inner element of the annotation element.
Represents Action element, a child of OnActivation element of the link annotation.
Represents Action element, a child of OnActivation element of the link annotation.
Corresponds to the A key in the link annotation dictionary.
Represents Dest element, a child element of link, GoTo, GoToR elements.
Represents Dest element, a child element of link, GoTo, GoToR elements.
Corresponds to the Dest key in link annotation dictionary.
Represents appearance element, a child element of stamp element.
Represents appearance element, a child element of stamp element.
Corresponds to the AP key in the annotation dictionary.
Content model: Base64 encoded string.
For more details see paragraph 6.5.1 in Xfdf document specification.
Represents the defaultappearance element, a child of the caret and freetext elements.
Represents the defaultappearance element, a child of the caret and freetext elements.
Corresponds to the DA key in the free text annotation dictionary.
Content model: text string.
For more details see paragraph 6.5.7 in Xfdf document specification.
Represents defaultstyle element, a child of the freetext element.
Represents defaultstyle element, a child of the freetext element.
Corresponds to the DS key in the free text annotation dictionary.
Content model : a text string.
For more details see paragraph 6.5.9 in Xfdf document specification.
Represents the BorderStyleAlt element, a child of the link element.
Represents the BorderStyleAlt element, a child of the link element.
Corresponds to the Border key in the common annotation dictionary.
For more details see paragraph 6.5.3 in Xfdf document specification.
Represents the string, containing vertices element, a child of the polygon and polyline elements.
Represents the string, containing vertices element, a child of the polygon and polyline elements.
Corresponds to the Vertices key in the polygon or polyline annotation dictionary.
For more details see paragraph 6.5.31 in Xfdf document specification.
The reference to the source
.
The reference to the source
. Used for attaching popups in case of reading data from pdf file.
Gets the string value of the type of annotation.
Gets the string value of the type of annotation. Possible values:
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
.
Sets the string value of the type of annotation.
Sets the string value of the type of annotation. Possible values:
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
.
Gets a list of all attributes of the annotation.
Finds the attribute by name in attributes list.
The name of the attribute to look for.
with the given name, or null, if no object with this name was found.
Finds the attribute by name in attributes list and return its string value.
The name of the attribute to look for.
the value of the
with the given name, or null, if no object with this name was found.
Gets the popup annotation, an inner element of the annotation element.
Sets the popup annotation, an inner element of the annotation element.
Gets the boolean, indicating if annotation has inner popup element.
Sets the boolean, indicating if annotation has inner popup element.
Gets the string value of contents tag in Xfdf document structure.
Gets the string value of contents tag in Xfdf document structure. Contents is a child of caret, circle,
fileattachment, freetext, highlight, ink, line, polygon, polyline, sound, square, squiggly, stamp, strikeout,
text, and underline elements.
Corresponds to Contents key in annotation dictionary.
Content model: a string or a rich text string.
For more details see paragraph 6.5.4 in Xfdf document specification.
Sets the string value of contents tag in Xfdf document structure.
Gets the string value of contents-richtext tag in Xfdf document structure.
Gets the string value of contents-richtext tag in Xfdf document structure. It is a child of caret, circle, fileattachment,
freetext, highlight, ink, line, polygon, polyline, sound, square, squiggly, stamp, strikeout, text, and
underline elements.
Corresponds to RC key in annotation dictionary.
Content model: text string.
For more details see paragraph 6.5.5 in Xfdf document specification.
Gets the string value of contents-richtext tag in xfdf document structure.
Gets Action element, a child of OnActivation element of the link annotation.
Gets Action element, a child of OnActivation element of the link annotation.
Corresponds to the A key in the link annotation dictionary.
Sets Action element, a child of OnActivation element of the link annotation.
Sets Action element, a child of OnActivation element of the link annotation.
Corresponds to the A key in the link annotation dictionary.
Adds new
to the list of annotation attributes.
attribute to be added.
Adds new attribute with given name and boolean value converted to string.
Adds new attribute by given name and value.
Adds new attribute by given name and value. If required attribute is present, value of the attribute can't be null.
Adds page, required attribute of every annotation.
Gets Dest element, a child element of link, GoTo, GoToR elements.
Gets Dest element, a child element of link, GoTo, GoToR elements.
Corresponds to the Dest key in link annotation dictionary.
Sets Dest element, a child element of link, GoTo, GoToR elements.
Sets Dest element, a child element of link, GoTo, GoToR elements.
Corresponds to the Dest key in link annotation dictionary.
Gets the string value of the appearance element, a child element of stamp element.
Gets the string value of the appearance element, a child element of stamp element.
Corresponds to the AP key in the annotation dictionary.
Content model: Base64 encoded string.
For more details see paragraph 6.5.1 in Xfdf document specification.
Gets the string value of the appearance element, a child element of stamp element.
Gets the string value of the appearance element, a child element of stamp element.
Corresponds to the AP key in the annotation dictionary.
Content model: Base64 encoded string.
Gets the string value of the defaultappearance element, a child of the caret and freetext elements.
Gets the string value of the defaultappearance element, a child of the caret and freetext elements.
Corresponds to the DA key in the free text annotation dictionary.
Content model: text string.
For more details see paragraph 6.5.7 in Xfdf document specification.
Sets the string value of the defaultappearance element, a child of the caret and freetext elements.
Sets the string value of the defaultappearance element, a child of the caret and freetext elements.
Corresponds to the DA key in the free text annotation dictionary.
Content model: text string.
Gets the string value of the defaultstyle element, a child of the freetext element.
Gets the string value of the defaultstyle element, a child of the freetext element.
Corresponds to the DS key in the free text annotation dictionary.
Content model : a text string.
For more details see paragraph 6.5.9 in Xfdf document specification.
Sets the string value of the defaultstyle element, a child of the freetext element.
Sets the string value of the defaultstyle element, a child of the freetext element.
Corresponds to the DS key in the free text annotation dictionary.
Content model : a text string.
Gets the BorderStyleAlt element, a child of the link element.
Gets the BorderStyleAlt element, a child of the link element.
Corresponds to the Border key in the common annotation dictionary.
For more details see paragraph 6.5.3 in Xfdf document specification.
Sets the BorderStyleAlt element, a child of the link element.
Sets the BorderStyleAlt element, a child of the link element.
Corresponds to the Border key in the common annotation dictionary.
Gets the string, containing vertices element, a child of the polygon and polyline elements.
Gets the string, containing vertices element, a child of the polygon and polyline elements.
Corresponds to the Vertices key in the polygon or polyline annotation dictionary.
For more details see paragraph 6.5.31 in Xfdf document specification.
Sets the string, containing vertices element, a child of the polygon and polyline elements.
Sets the string, containing vertices element, a child of the polygon and polyline elements.
Corresponds to the Vertices key in the polygon or polyline annotation dictionary.
Gets the reference to the source
.
Gets the reference to the source
. Used for attaching popups in case of reading data from pdf file.
Sets the reference to the source
.
Sets the reference to the source
. Used for attaching popups in case of reading data from pdf file.
Represent annots tag in xfdf document structure.
Represent annots tag in xfdf document structure.
Content model: ( text | caret | freetext | fileattachment | highlight | ink | line | link
| circle | square | polygon | polyline | sound | squiggly | stamp |
strikeout | underline )*.
Attributes: none.
For more details see paragraph 6.4.1 in Xfdf specification.
Represents a list of children annotations.
Gets a list of children annotations.
Adds a new
to the list of children annotations.
containing info about pdf document annotation.
The exception thrown when the attribute with given name is not found in the object attributes list.
the name of missing attribute.
Represents the attribute of any xfdf element.
Returns a string containing attribute name.
Returns a string representation of attribute value.
Represents the BorderStyleAlt element, a child of the link element.
Represents the BorderStyleAlt element, a child of the link element.
Corresponds to the Border key in the common annotation dictionary.
Content model: border style encoded in the format specified in the border style attributes.
Required attributes: HCornerRadius, VCornerRadius, Width.
Optional attributes: DashPattern.
For more details see paragraph 6.5.3 in Xfdf document specification.
For more details about attributes see paragraph 6.6.19 in Xfdf document specification.
Number specifying the horizontal corner radius of the rectangular border.
Number specifying the horizontal corner radius of the rectangular border.
Corresponds to array index 0 in the Border key in the common annotation dictionary.
Number specifying the vertical corner radius of the rectangular border.
Number specifying the vertical corner radius of the rectangular border.
Corresponds to array index 1 in the Border key in the common annotation dictionary.
Number specifying the width of the rectangular border.
Number specifying the width of the rectangular border.
Corresponds to array index 2 in the Border key in the common annotation dictionary.
An array of numbers specifying the pattern of dashes and gaps of the border.
An array of numbers specifying the pattern of dashes and gaps of the border.
Corresponds to array index 3 in the Border key in the common annotation dictionary.
Encoded border style string.
Gets a float value specifying the horizontal corner radius of the rectangular border.
Gets a float value specifying the horizontal corner radius of the rectangular border.
Corresponds to array index 0 in the Border key in the common annotation dictionary.
Gets a float value specifying the vertical corner radius of the rectangular border.
Gets a float value specifying the vertical corner radius of the rectangular border.
Corresponds to array index 1 in the Border key in the common annotation dictionary.
Gets a float value specifying the width of the rectangular border.
Gets a float value specifying the width of the rectangular border.
Corresponds to array index 2 in the Border key in the common annotation dictionary.
Gets a array of numbers specifying the pattern of dashes and gaps of the border.
Gets a array of numbers specifying the pattern of dashes and gaps of the border.
Corresponds to array index 3 in the Border key in the common annotation dictionary.
Sets a array of numbers specifying the pattern of dashes and gaps of the border.
Sets a array of numbers specifying the pattern of dashes and gaps of the border.
Corresponds to array index 3 in the Border key in the common annotation dictionary.
Gets an encoded border style string.
Sets an encoded border style string.
Represents Dest element, a child of the link, GoTo, and GoToR elements.
Represents Dest element, a child of the link, GoTo, and GoToR elements.
Corresponds to the Dest key in the link annotations dictionary.
For more details see paragraph 6.5.10 in Xfdf document specification.
Content model: ( Named | XYZ | Fit | FitH | FitV | FitR | FitB | FitBH | FitBV )
Represents Name attribute of Named element, a child of Dest element.
Represents Name attribute of Named element, a child of Dest element.
Allows a destination to be referred to indirectly by means of a name object or a byte string.
For more details see paragraph 6.5.25 in Xfdf document specification.
Represents the XYZ element, a child of the Dest element.
Represents the XYZ element, a child of the Dest element.
Corresponds to the XYZ key in the destination syntax.
Required attributes: Page, Left, Bottom, Right, Top.
For more details see paragraph 6.5.32 in Xfdf document specification.
Represents the Fit element, a child of the Dest element.
Represents the Fit element, a child of the Dest element.
Corresponds to the Fit key in the destination syntax.
Required attributes: Page.
For more details see paragraph 6.5.13 in Xfdf document specification.
Represents the FitH element, a child of the Dest element.
Represents the FitH element, a child of the Dest element.
Corresponds to the FitH key in the destination syntax.
Required attributes: Page, Top.
For more details see paragraph 6.5.17 in Xfdf document specification.
Represents the FitV element, a child of the Dest element.
Represents the FitV element, a child of the Dest element.
Corresponds to the FitV key in the destination syntax.
Required attributes: Page, Left.
For more details see paragraph 6.5.19 in Xfdf document specification.
Represents the FitR element, a child of the Dest element.
Represents the FitR element, a child of the Dest element.
Corresponds to the FitR key in the destination syntax.
Required attributes: Page, Left, Bottom, Right, Top.
For more details see paragraph 6.5.18 in Xfdf document specification.
Represents the FitB element, a child of the Dest element.
Represents the FitB element, a child of the Dest element.
Corresponds to the FitB key in the destination syntax.
Required attributes: Page.
For more details see paragraph 6.5.14 in Xfdf document specification.
Represents the FitBH element, a child of the Dest element.
Represents the FitBH element, a child of the Dest element.
Corresponds to the FitBH key in the destination syntax.
Required attributes: Page, Top.
For more details see paragraph 6.5.15 in Xfdf document specification.
Represents the FitBV element, a child of the Dest element.
Represents the FitBV element, a child of the Dest element.
Corresponds to the FitBV key in the destination syntax.
Required attributes: Page, Left.
For more details see paragraph 6.5.16 in Xfdf document specification.
Gets string value of the Name attribute of Named element, a child of Dest element.
Gets string value of the Name attribute of Named element, a child of Dest element.
Allows a destination to be referred to indirectly by means of a name object or a byte string.
For more details see paragraph 6.5.25 in Xfdf document specification.
Sets string value of the Name attribute of Named element, a child of Dest element.
Sets string value of the Name attribute of Named element, a child of Dest element.
Allows a destination to be referred to indirectly by means of a name object or a byte string.
Gets the XYZ element, a child of the Dest element.
Gets the XYZ element, a child of the Dest element.
Corresponds to the XYZ key in the destination syntax.
Required attributes: Page, Left, Bottom, Right, Top.
For more details see paragraph 6.5.32 in Xfdf document specification.
Sets the XYZ element, a child of the Dest element.
Sets the XYZ element, a child of the Dest element.
Corresponds to the XYZ key in the destination syntax.
Required attributes: Page, Left, Bottom, Right, Top.
Gets the Fit element, a child of the Dest element.
Gets the Fit element, a child of the Dest element.
Corresponds to the Fit key in the destination syntax.
Required attributes: Page.
For more details see paragraph 6.5.13 in Xfdf document specification.
Sets the Fit element, a child of the Dest element.
Sets the Fit element, a child of the Dest element.
Corresponds to the Fit key in the destination syntax.
Required attributes: Page.
Gets the FitH element, a child of the Dest element.
Gets the FitH element, a child of the Dest element.
Corresponds to the FitH key in the destination syntax.
Required attributes: Page, Top.
For more details see paragraph 6.5.17 in Xfdf document specification.
Sets the FitH element, a child of the Dest element.
Sets the FitH element, a child of the Dest element.
Corresponds to the FitH key in the destination syntax.
Required attributes: Page, Top.
Gets the FitV element, a child of the Dest element.
Gets the FitV element, a child of the Dest element.
Corresponds to the FitV key in the destination syntax.
Required attributes: Page, Left.
For more details see paragraph 6.5.19 in Xfdf document specification.
Sets the FitV element, a child of the Dest element.
Sets the FitV element, a child of the Dest element.
Corresponds to the FitV key in the destination syntax.
Required attributes: Page, Left.
Gets the FitR element, a child of the Dest element.
Gets the FitR element, a child of the Dest element.
Corresponds to the FitR key in the destination syntax.
Required attributes: Page, Left, Bottom, Right, Top.
For more details see paragraph 6.5.18 in Xfdf document specification.
Sets the FitR element, a child of the Dest element.
Sets the FitR element, a child of the Dest element.
Corresponds to the FitR key in the destination syntax.
Required attributes: Page, Left, Bottom, Right, Top.
Sets the FitB element, a child of the Dest element.
Sets the FitB element, a child of the Dest element.
Corresponds to the FitB key in the destination syntax.
Required attributes: Page.
For more details see paragraph 6.5.14 in Xfdf document specification.
Gets the FitB element, a child of the Dest element.
Gets the FitB element, a child of the Dest element.
Corresponds to the FitB key in the destination syntax.
Required attributes: Page.
Sets the FitBH element, a child of the Dest element.
Sets the FitBH element, a child of the Dest element.
Corresponds to the FitBH key in the destination syntax.
Required attributes: Page, Top.
For more details see paragraph 6.5.15 in Xfdf document specification.
Gets the FitBH element, a child of the Dest element.
Gets the FitBH element, a child of the Dest element.
Corresponds to the FitBH key in the destination syntax.
Required attributes: Page, Top.
Sets the FitBV element, a child of the Dest element.
Sets the FitBV element, a child of the Dest element.
Corresponds to the FitBV key in the destination syntax.
Required attributes: Page, Left.
For more details see paragraph 6.5.16 in Xfdf document specification.
Sets the FitBV element, a child of the Dest element.
Sets the FitBV element, a child of the Dest element.
Corresponds to the FitBV key in the destination syntax.
Required attributes: Page, Left.
Represents encoding attribute of data or resource elements (children of fileattachment and sound elements).
To be removed in 7.2
Represents the name attribute of the field element.
Represents the name attribute of the field element.
Corresponds to the T key in the field dictionary.
In a hierarchical form field, the name is the partial field name.
For more details see paragraph 6.3.2.2 in Xfdf document specification.
Represents the value element, a child of the field element and contains the field's value, whose format may
vary depending on the field type.
Represents the value element, a child of the field element and contains the field's value, whose format may
vary depending on the field type.
Corresponds to the V key in the FDF field dictionary.
Content model: text string.
For more details see paragraph 6.3.3 in Xfdf document specification.
Represents the value-richtext element, a child of the field element and contains the field's value formatted as a
rich text string.
Represents the value-richtext element, a child of the field element and contains the field's value formatted as a
rich text string.
Corresponds to the RV key in the variable text field dictionary.
Content model: text strign or rich text string.
Attributes: none.
For more details see paragraph 6.3.4 in Xfdf document specification.
Indicates if a value-richtext element is present inside the field.
Parent field of current field.
Gets the string value of the name attribute of the field element.
Gets the string value of the name attribute of the field element.
Corresponds to the T key in the field dictionary.
In a hierarchical form field, the name is the partial field name.
For more details see paragraph 6.3.2.2 in Xfdf document specification.
Sets the string value of the name attribute of the field element.
Sets the string value of the name attribute of the field element.
Corresponds to the T key in the field dictionary.
In a hierarchical form field, the name is the partial field name.
Gets the string representation of the value element, a child of the field element and contains the field's value, whose format may
vary depending on the field type.
Gets the string representation of the value element, a child of the field element and contains the field's value, whose format may
vary depending on the field type.
Corresponds to the V key in the FDF field dictionary.
For more details see paragraph 6.3.3 in Xfdf document specification.
Sets the string representation of the value element, a child of the field element and contains the field's value, whose format may
vary depending on the field type.
Sets the string representation of the value element, a child of the field element and contains the field's value, whose format may
vary depending on the field type.
Corresponds to the V key in the FDF field dictionary.
Gets the string representation of the value-richtext element, a child of the field element and contains the field's value formatted as a
rich text string.
Gets the string representation of the value-richtext element, a child of the field element and contains the field's value formatted as a
rich text string.
Corresponds to the RV key in the variable text field dictionary.
Content model: text strign or rich text string.
For more details see paragraph 6.3.4 in Xfdf document specification.
Sets the string representation of the value-richtext element, a child of the field element and contains the field's value formatted as a
rich text string.
Sets the string representation of the value-richtext element, a child of the field element and contains the field's value formatted as a
rich text string.
Corresponds to the RV key in the variable text field dictionary.
Content model: text strign or rich text string.
Gets a boolean indicating if a value-richtext element is present inside the field.
Sets a boolean indicating if a value-richtext element is present inside the field.
Gets a parent field of current field.
Sets a parent field of current field.
Represents the fields element, a child of the xfdf element and is the container for form field elements.
Represents the fields element, a child of the xfdf element and is the container for form field elements.
Content model: ( field* ).
Attributes: none.
For more details see paragraph 6.3.1 in Xfdf specification.
Represents a list of children fields
Gets a list of children fields
Adds a new field to the list.
FieldObject containing the info about the form field.
Represent Fit, a child of the Dest element.
Represent Fit, a child of the Dest element.
Content model: none.
Attributes: depends of type of Fit (FitH, FitB, FitV etc.).
For more details see paragraphs 6.5.13-6.5.19, 6.6.23 in Xfdf specification.
Represents the page displayed by current Fit element.
Represents the page displayed by current Fit element.
Attribute of Fit, FitB, FitBH, FitBV, FitH, FitR, FitV, XYZ elements.
Vertical coordinate positioned at the top edge of the window.
Vertical coordinate positioned at the bottom edge of the window.
Horizontal coordinate positioned at the left edge of the window.
Horizontal coordinate positioned at the right edge of the window.
Corresponds to the zoom object in the destination syntax.
Corresponds to the zoom object in the destination syntax.
Attribute of XYZ object.
Gets the PdfObject representing the page displayed by current Fit element.
Gets the PdfObject representing the page displayed by current Fit element.
Attribute of Fit, FitB, FitBH, FitBV, FitH, FitR, FitV, XYZ elements.
Gets a float vertical coordinate positioned at the top edge of the window.
Sets a float vertical coordinate positioned at the top edge of the window.
Gets a float horizontal coordinate positioned at the left edge of the window.
Sets a float horizontal coordinate positioned at the left edge of the window.
Gets a float vertical coordinate positioned at the bottom edge of the window.
Sets a float vertical coordinate positioned at the bottom edge of the window.
Gets a float horizontal coordinate positioned at the right edge of the window.
Sets a float horizontal coordinate positioned at the right edge of the window.
Gets a float representing the zoom ratio.
Gets a float representing the zoom ratio.
Attribute of XYZ object.
Sets a float representing the zoom ratio.
Sets a float representing the zoom ratio.
Attribute of XYZ object.
Represents f element, child of the xfdf element.
Represents f element, child of the xfdf element.
Corresponds to the F key in the file dictionary.
Specifies the source file or target file: the PDF document that this XFDF file was exported from or is intended to be
imported into.
Attributes: href.
For more details see paragraph 6.2.2 in Xfdf document specification.
The name of the source or target file.
Gets the name of the source or target file.
Sets the name of the source or target file.
Represents ids element, child of the xfdf element.
Represents ids element, child of the xfdf element.
Corresponds to the ID key in the file dictionary.
The two attributes are file identifiers for the source or target file designated by the f element, taken
from the ID entry in the file’s trailer dictionary.
Attributes: original, modified.
For more details see paragraph 6.2.3 in Xfdf document specification.
This attribute corresponds to the permanent identifier which
is based on the contents of the file at the time it was originally created.
This attribute corresponds to the permanent identifier which
is based on the contents of the file at the time it was originally created.
This value does not change when the file is incrementally updated.
The value shall be a hexadecimal number.
A common value for this is an MD5 checksum.
The attribute contains a unique identifier for the
modified version of the pdf and corresponding xfdf document.
The attribute contains a unique identifier for the
modified version of the pdf and corresponding xfdf document. The
modified attribute corresponds to the changing identifier that is based
on the file's contents at the time it was last updated.
The value shall be a hexadecimal number.
A common value for this is an MD5 checksum.
Gets the string value of the permanent identifier which
is based on the contents of the file at the time it was originally created.
Gets the string value of the permanent identifier which
is based on the contents of the file at the time it was originally created.
This value does not change when the file is incrementally updated.
The value shall be a hexadecimal number.
Sets the string value of the permanent identifier which
is based on the contents of the file at the time it was originally created.
Sets the string value of the permanent identifier which
is based on the contents of the file at the time it was originally created.
This value does not change when the file is incrementally updated.
The value shall be a hexadecimal number.
A common value for this is an MD5 checksum.
Gets the string value of the unique identifier for the
modified version of the pdf and corresponding xfdf document.
Gets the string value of the unique identifier for the
modified version of the pdf and corresponding xfdf document. The
modified attribute corresponds to the changing identifier that is based
on the file's contents at the time it was last updated.
The value shall be a hexadecimal number.
Sets the string value of the unique identifier for the
modified version of the pdf and corresponding xfdf document.
Sets the string value of the unique identifier for the
modified version of the pdf and corresponding xfdf document. The
modified attribute corresponds to the changing identifier that is based
on the file's contents at the time it was last updated.
The value shall be a hexadecimal number.
A common value for this is an MD5 checksum.
Represents the mode attribute of data and resource elements.
Represents the mode attribute of data and resource elements.
Does not correspond to a PDF key.
Class containing constants to be used in xfdf processing.
Creates a new xml-styled document for writing xfdf info.
Creates a new xml-styled document for writing xfdf info.
Creates a new xfdf document based on given input stream.
the stream containing xfdf info.
Saves the info from output stream to xml-styled document.
the document to save info to.
the stream containing xfdf info.
Represents f element, child of the xfdf element.
Represents f element, child of the xfdf element.
Corresponds to the F key in the file dictionary.
Represents ids element, a child of the xfdf element.
Represents ids element, a child of the xfdf element.
Corresponds to the ID key in the file dictionary.
Represents the fields element, a child of the xfdf element and is the container for form field elements.
Represent annots element, a child of the xfdf element and is the container for annot elements.
A list of attributes of xfdf object.
Gets the f element, child of the xfdf element.
Gets the f element, child of the xfdf element.
Corresponds to the F key in the file dictionary.
Sets the f element, child of the xfdf element.
Sets the f element, child of the xfdf element.
Corresponds to the F key in the file dictionary.
Gets the ids element, child of the xfdf element.
Gets the ids element, child of the xfdf element.
Corresponds to the ID key in the file dictionary.
Sets the ids element, child of the xfdf element.
Sets the ids element, child of the xfdf element.
Corresponds to the ID key in the file dictionary.
Gets the fields element, a child of the xfdf element and is the container for form field elements.
Sets the fields element, a child of the xfdf element and is the container for form field elements.
Gets the annots element, a child of the xfdf element and is the container for annot elements.
Sets the annots element, a child of the xfdf element and is the container for annot elements.
Gets the list of attributes of xfdf object.
Sets the list of attributes of xfdf object.
Merges info from XfdfObject to pdf document.
the target document for merge.
the name of the target document. Will be checked in the merge process to determined
if it is the same as href attribute of f element of merged XfdfObject. If the names are
different, a warning will be thrown.
Writes info from XfdfObject to .xfdf file.
name of the target file.
Writes info from XfdfObject to .xfdf file.
target output stream.
Extracts data from pdf document acroform and annotations into XfdfObject.
Extracts data from pdf document acroform and annotations into XfdfObject.
*
Pdf document for data extraction.
The name od pdf document for data extraction.
XfdfObject containing data from pdf forms and annotations.
Extracts data from input stream into XfdfObject.
Extracts data from input stream into XfdfObject. Typically input stream is based on .xfdf file
The input stream containing xml-styled xfdf data.
XfdfObject containing original xfdf data.
Converts a string containing 2 or 4 float values into a
.
Converts a string containing 2 or 4 float values into a
.
If only two coordinates are present, they should represent
width and height.
Converts a string containing 4 float values into a PdfArray, representing rectangle fringe.
Converts a string containing 4 float values into a PdfArray, representing rectangle fringe.
If the number of floats in the string is not equal to 4, returns and PdfArray with empty values.
Converts a Rectangle to a string containing 4 float values.
Converts float value to string with UTF-8 encoding.
Converts a string containing 4 float values into a float array, representing quadPoints.
Converts a string containing 4 float values into a float array, representing quadPoints.
If the number of floats in the string is not equal to 8, returns an empty float array.
Converts a float array, representing quadPoints into a string containing 8 float values.
Converts a string containing a comma separated list of names of the flags into an integer representation
of the flags.
Converts an integer representation of the flags into a string with a comma separated list of names of the flags.
Converts an array of 3 floats into a hex string representing the rgb color.
Converts a Color object into a hex string representing the rgb color.
Converts float representation of the rgb color into a hex string representing the rgb color.
Converts string containing id from decimal to hexadecimal format.
Converts string containing hex color code to Color object.
Converts string containing hex color code into an array of 3 integer values representing rgb color.
Converts an array of float vertices to string.
Converts to string an array of floats representing the fringe.
Converts to string an array of floats representing the fringe.
If the number of floats doesn't equal 4, an empty string is returned.
Converts a string into an array of floats representing vertices.
Returns a string representation of the start point of the line (x_1, y_1) based on given line array.
Returns a string representation of the start point of the line (x_1, y_1) based on given line array.
If the line array doesn't contain 4 floats, returns an empty string.
an array of 4 floats representing the line (x_1, y_1, x_2, y_2)
Returns a string representation of the end point of the line (x_2, y_2) based on given line array.
Returns a string representation of the end point of the line (x_2, y_2) based on given line array.
If the line array doesn't contain 4 floats, returns an empty string.
an array of 4 floats representing the line (x_1, y_1, x_2, y_2)
Merges existing XfdfObject into pdf document associated with it.
The object to be merged.
The associated pdf document.
The name of the associated pdf document.
Merges existing FieldsObject and children FieldObject entities into the form of the pdf document
associated with it.
object containing acroform fields data to be merged.
acroform to be filled with xfdf data.
Merges existing XfdfObject into pdf document associated with it.
The AnnotsObject with children AnnotObject entities to be mapped into PdfAnnotations.
The associated pdf document.
Creates a XfdfWriter for output stream specified.
A stream to write xfdf file into.
Writes data from
into a xfdf data file.
containing the data.