PdfPortfolioField Class

Namespace:
GemBox.Pdf.Portfolios
Assembly:
GemBox.Pdf.dll

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 PortfolioFieldValues or the PortfolioFieldValues.

public sealed class PdfPortfolioField : PdfObject
Public NotInheritable Class PdfPortfolioField
    Inherits PdfObject
Inheritance:
System.Object
PdfPortfolioField

Properties

DataType

(Required) The data type of PdfPortfolioFieldValue or PdfFileSpecification and PdfPortfolioFolder related property that this PdfPortfolioField describes.

public PdfPortfolioFieldDataType DataType { get; }
Public ReadOnly Property DataType As PdfPortfolioFieldDataType
Property Value
PdfPortfolioFieldDataType

The data type of PdfPortfolioFieldValue or PdfFileSpecification/PdfPortfolioFolder-related property that this PdfPortfolioField describes.

See Also

Hidden

(Optional) If set, do not display the PdfPortfolioField in the user interface.

Default value: false.

public bool Hidden { get; set; }
Public Property Hidden As Boolean
Property Value
System.Boolean

If set, do not display the PdfPortfolioField in the user interface.

See Also

Name

(Required) The textual field name that shall be presented to the user by the conforming reader.

public string Name { get; set; }
Public Property Name As String
Property Value
System.String

The textual field name that shall be presented to the user by the conforming reader.

Exceptions
System.ArgumentNullException

Value is null or System.String.Empty.

See Also

Order

(Optional) The relative order of the field name in the user interface. Fields shall be sorted by the conforming reader in ascending order.

public int? Order { get; set; }
Public Property Order As Integer?
Property Value
System.Nullable<System.Int32>

The relative order of the field name in the user interface.

See Also

ReadOnly

(Optional) If set, the user may not change the GemBox.Pdf.PdfFileSpecification.portfolioFieldValues associated with the PdfPortfolioField.

Default value: true.

public bool ReadOnly { get; set; }
Public Property ReadOnly As Boolean
Property Value
System.Boolean

If set, the user may not change the GemBox.Pdf.PdfFileSpecification.portfolioFieldValues associated with the PdfPortfolioField.

See Also

Methods

ToString()

Returns a System.String that represents this PdfPortfolioField instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this PdfPortfolioField instance.

Overrides
System.Object.ToString()
Remarks

This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Inherited Properties

Metadata

(Optional; PDF 1.4) A metadata stream containing metadata for the component.

(Inherited from PdfObject)

Extension Methods

Examples

See Also