Click or drag to resize
Pdftools logo

SubForm Class

A form field that contains other fields

Inheritance Hierarchy
SystemObject
  PdfTools.Toolbox.InternalNativeBase
    PdfTools.Toolbox.InternalNativeObject
      PdfTools.Toolbox.Pdf.FormsFieldNode
        PdfTools.Toolbox.Pdf.FormsSubForm

Namespace: PdfTools.Toolbox.Pdf.Forms
Assembly: PdfTools.Toolbox (in PdfTools.Toolbox.dll) Version: 1.11.0+eb7160cc6b920e36fb1ea2abe5f76809067c0c55
Syntax
C#
Copy
public class SubForm : FieldNode

The SubForm type exposes the following members.

Properties
 NameDescription
Public propertyChildren

The child form fields

Adding to this list results in an error:
  • IllegalState if the list has already been closed
  • UnsupportedOperation if the document is read-only
  • IllegalArgument
    • if the given form field node is
    • if the given form field node has already been closed
    • if the given form field node does not belong to the same document as the list
    • if the given form field node has already been added to a form field node list
    • if the given form field node's identifier equals an identifier of one of the form field nodes in this list
This list does not support removing or setting elements or clearing.
Public propertyDisplayName

User interface name

The display name is not directly visible, but a PDF viewer can display this name, e.g., in a tool tip.
(Inherited from FieldNode)
Public propertyExportName

The name used when exporting


(Inherited from FieldNode)
Top
Methods
 NameDescription
Public methodStatic memberCreate

Create a sub form

The returned sub form object is not yet used, but it is associated with the given target document.
Public methodEquals
(Inherited from NativeObject)
Public methodGetHashCode
(Inherited from NativeObject)
Top
See Also