PdfPortfolioField Class

Describes the attributes of a particular field in a PDF Portfolio, including the type of data stored in the PdfPortfolioFieldValue and the lookup PdfName key used to locate the PdfPortfolioFieldValue in the file or the Portfolio folder.

Inheritance Hierarchy

SystemObject
SautinSoft.PdfPdfObject
SautinSoft.Pdf.PortfoliosPdfPortfolioField

Namespace: SautinSoft.Pdf.Portfolios
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.8.8

Syntax

public sealed class PdfPortfolioField : PdfObject

Public NotInheritable Class PdfPortfolioField
	Inherits PdfObject

The PdfPortfolioField type exposes the following members.

Properties

	Name	Description
	DataType	(Required) The data type of PdfPortfolioFieldValue or PdfFileSpecification and PdfPortfolioFolder related property that this PdfPortfolioField describes.
	Hidden	(Optional) If set, do not display the PdfPortfolioField in the user interface. Default value: .
	Metadata	(Optional; PDF 1.4) A metadata stream containing metadata for the component. (Inherited from PdfObject)
	Name	(Required) The textual field name that shall be presented to the user by the conforming reader.
	Order	(Optional) The relative order of the field name in the user interface. Fields shall be sorted by the conforming reader in ascending order.
	ReadOnly	(Optional) If set, the user may not change the value associated with the PdfPortfolioField. Default value: .

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	ToString	Returns a String that represents this PdfPortfolioField instance. (Overrides ObjectToString)

Extension Methods

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