Click or drag to resize

PdfForm Class

A form XObject is a PDF content stream that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images).

A form XObject may be painted multiple times—either on several pages or at several locations on the same page—and produces the same results each time, subject only to the graphics state at the time it is invoked.

Inheritance Hierarchy

Namespace: SautinSoft.Pdf.Content
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.6.18
Syntax
public sealed class PdfForm : PdfExternalObject

The PdfForm type exposes the following members.

Constructors
 NameDescription
Public methodPdfForm Initializes a new instance of the PdfForm class.
Top
Properties
 NameDescription
Public propertyAssociatedFiles(Optional; PDF 2.0) An array of one or more PdfFileSpecifications which denote the associated files for this PdfImage or PdfForm.
(Inherited from PdfExternalObject)
Public propertyBoundingBox(Required) The form XObject’s bounding box, used to clip the form XObject and to determine its size for caching.
Public propertyContent

Gets the content of the PdfForm.

Returns if the PdfForm doesn't have an associated resource dictionary. In that case use either GetContent(PdfContent) to retrieve the read-only content of the PdfForm with PdfContentResources (fonts, images, etc.) resolved from the specified PdfContent or SetResources(PdfContent) method to set PdfContentResources (fonts, images, etc.) from the specified PdfContent to this PdfForm before retrieving the Content property.

Public propertyDocument Gets the PdfDocument associated with this PdfContentResource or if no PdfDocument is associated with this PdfContentResource.
(Inherited from PdfContentResource)
Public propertyMetadata(Optional; PDF 1.4) A metadata stream containing metadata for the component.
(Inherited from PdfObject)
Public propertySize Gets the form size in the original (untransformed) coordinate system in which Transform is Identity.
Public propertyTransform(Optional) An array of six numbers specifying the form matrix, which maps form space into user space (see 8.3.4, "Transformation Matrices"). Default value: the identity matrix [1 0 0 1 0 0].
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetContent

Gets the read-only content of the PdfForm with PdfContentResources (fonts, images, etc.) resolved from the specified resourcesProvider.

To get the editable content of the PdfForm, use the Content property and, optionally, SetResources(PdfContent) method before it, if the Content property returns .

Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodSetBoundingBox Sets the BoundingBox.
Public methodSetResources

Sets the PdfContentResources (fonts, images, etc.) from the specified PdfContent to this PdfForm.

This method is useful if the Content property returns (if the PdfForm doesn't have an associated resource dictionary).

Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Extension Methods
 NameDescription
Public Extension MethodGetArray Gets the PdfArray that serves as a backing storage of the specified PdfObject or if no PdfArray serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetOrAddDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Top
See Also