PdfFormActionSelectedFieldCollection Class

Represents a collection of PdfField names used in PdfSubmitFormAction and PdfResetFormAction.

Inheritance Hierarchy

SystemObject
  SautinSoft.PdfPdfObject
    SautinSoft.PdfPdfCollection
      SautinSoft.PdfPdfCollectionString
        SautinSoft.Pdf.FormsPdfFormActionSelectedFieldCollection

Namespace: SautinSoft.Pdf.Forms
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.11.26

Syntax

Copy

public sealed class PdfFormActionSelectedFieldCollection : PdfCollection<string>, 
	IList, ICollection, IEnumerable, IList<string>, 
	ICollection<string>, IEnumerable<string>

Public NotInheritable Class PdfFormActionSelectedFieldCollection
	Inherits PdfCollection(Of String)
	Implements IList, ICollection, IEnumerable, IList(Of String), 
	ICollection(Of String), IEnumerable(Of String)

The PdfFormActionSelectedFieldCollection type exposes the following members.

Properties

	Name	Description
	All	Gets or sets a value indicating whether to submit / reset all form fields. If , then only fields with names specified in SelectedFields are submitted / reset (if Excluded is ) or excluded from the submission / resetting (if Excluded is ). Default value: .
	Excluded	Gets or sets a value indicating whether fields with names specified in SelectedFields are excluded from the submission / resetting. Default value: .

Name

Description

All

Gets or sets a value indicating whether to submit / reset all form fields.

If , then only fields with names specified in SelectedFields are submitted / reset (if Excluded is ) or excluded from the submission / resetting (if Excluded is ).

Default value: .

Excluded

Gets or sets a value indicating whether fields with names specified in SelectedFields are excluded from the submission / resetting.

Default value: .

Top

Methods

	Name	Description
	Add	Adds a PdfField to the end of the PdfFormActionSelectedFieldCollection.

Top

Extension Methods

	Name	Description
	GetArray	Gets the PdfArray that serves as a backing storage of the specified PdfCollection. (Defined by PdfObjectExtensions)
	GetArray	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)
	GetDictionary	Gets the PdfDictionary that serves as a backing storage of the specified PdfObject. (Defined by PdfObjectExtensions)
	GetOrAddArray	Gets the PdfArray that serves as a backing storage of the specified PdfCollection. (Defined by PdfObjectExtensions)
	GetOrAddDictionary	Gets the PdfDictionary that serves as a backing storage of the specified PdfObject. (Defined by PdfObjectExtensions)

Top

Reference

SautinSoft.Pdf.Forms Namespace

Other Resources

PDF Specification ISO 32000-1:2008, section '12.7.5.2 Submit-Form Action'

PDF Specification ISO 32000-1:2008, section '12.7.5.3 Reset-Form Action'

Form Actions example