PdfPortfolioFolder Class

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

Represents a PdfPortfolio folder used to organize the EmbeddedFiles into a hierarchical structure.

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

Properties

CreationDate

(Optional; PDF 2.0) The date the folder was first created.

public DateTimeOffset? CreationDate { get; set; }
Public Property CreationDate As DateTimeOffset?
Property Value
System.Nullable<System.DateTimeOffset>

The date the folder was first created.

Description

(Optional; PDF 2.0) A text description associated with this folder.

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

A text description associated with this folder.

Files

Gets the EmbeddedFiles contained in this PdfPortfolioFolder.

public PdfPortfolioFileCollection Files { get; }
Public ReadOnly Property Files As PdfPortfolioFileCollection
Property Value
PdfPortfolioFileCollection

The EmbeddedFiles contained in this PdfPortfolioFolder.

Folders

Gets the subfolders contained in this PdfPortfolioFolder.

public PdfPortfolioFolderCollection Folders { get; }
Public ReadOnly Property Folders As PdfPortfolioFolderCollection
Property Value
PdfPortfolioFolderCollection

The subfolders contained in this PdfPortfolioFolder.

ModificationDate

(Optional; PDF 2.0) The date of the most recent change to immediate child files or folders of this folder.

public DateTimeOffset? ModificationDate { get; set; }
Public Property ModificationDate As DateTimeOffset?
Property Value
System.Nullable<System.DateTimeOffset>

The date of the most recent change to immediate child files or folders of this folder.

Name

(Required; PDF 2.0) Gets or sets the name of this PdfPortfolioFolder. Two sibling folders shall not share the same name following case normalization.

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

The name of this PdfPortfolioFolder.

Exceptions
System.ArgumentNullException

Value is null or System.String.Empty.

Parent

Gets the parent folder, or null if this PdfPortfolioFolder is a root folder (contained in the Folders collection).

public PdfPortfolioFolder Parent { get; }
Public ReadOnly Property Parent As PdfPortfolioFolder
Property Value
PdfPortfolioFolder

The parent folder, or null if this PdfPortfolioFolder is a root folder.

PortfolioFieldValues

(Optional; PDF 2.0) A collection item dictionary, which shall be used to create the user interface for portable collections (see 7.11.6, "Collection Items").

public PdfPortfolioFieldValueDictionary PortfolioFieldValues { get; }
Public ReadOnly Property PortfolioFieldValues As PdfPortfolioFieldValueDictionary
Property Value
PdfPortfolioFieldValueDictionary

A collection item dictionary, which shall be used to create the user interface for portable collections.

Thumbnail

(Optional; PDF 2.0) A stream object defining the thumbnail image for the folder (see 12.3.4, "Thumbnail Images").

public PdfImage Thumbnail { get; set; }
Public Property Thumbnail As PdfImage
Property Value
PdfImage

A stream object defining the thumbnail image for the folder.

Methods

ToString()

Returns a System.String that represents this PdfPortfolioFolder instance.

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

A System.String that represents this PdfPortfolioFolder 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