PdfPackage

PdfPackage class

Represents native metadata in a PDF document.

public class PdfPackage : DocumentPackage

Properties

Name Description
Author { get; set; } Gets or sets the document author.
Count { get; } Gets the number of metadata properties.
CreatedDate { get; set; } Gets or sets the date of document creation.
Creator { get; set; } Gets the creator of the document.
Item { get; } Gets the MetadataProperty with the specified name.
Keys { get; } Gets a collection of the metadata property names.
Keywords { get; set; } Gets or sets the keywords.
MetadataType { get; } Gets the metadata type.
ModifiedDate { get; set; } Gets or sets the date of the last modification.
Producer { get; set; } Gets the document producer.
PropertyDescriptors { get; } Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
Subject { get; set; } Gets or sets the subject of the document.
Title { get; set; } Gets or sets the title of the document.
TrappedFlag { get; set; } Gets or sets the trapped flag.

Methods

Name Description
virtual AddProperties(Func<MetadataProperty, bool>, PropertyValue) Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well.
Clear() Removes all writable metadata properties from the package.
ClearBuiltInProperties() Removes all built-in metadata properties.
ClearCustomProperties() Removes all custom metadata properties.
Contains(string) Determines whether the package contains a metadata property with the specified name.
virtual FindProperties(Func<MetadataProperty, bool>) Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well.
GetEnumerator() Returns an enumerator that iterates through the collection.
Remove(string) Removes a writable metadata property by the specified name.
virtual RemoveProperties(Func<MetadataProperty, bool>) Removes metadata properties satisfying the specified predicate.
virtual Sanitize() Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.
Set(string, string) Adds or replaces the metadata property with the specified name.
virtual SetProperties(Func<MetadataProperty, bool>, PropertyValue) Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of AddProperties and UpdateProperties. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package.
virtual UpdateProperties(Func<MetadataProperty, bool>, PropertyValue) Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well.

Remarks

Learn more

Examples

This code snippet demonstrates how to update built-in metadata properties in a PDF document.

using (Metadata metadata = new Metadata(Constants.InputPdf))
{
    var root = metadata.GetRootPackage<PdfRootPackage>();

    root.DocumentProperties.Author = "test author";
    root.DocumentProperties.CreatedDate = DateTime.Now;
    root.DocumentProperties.Title = "test title";
    root.DocumentProperties.Keywords = "metadata, built-in, update";

    // ... 

    metadata.Save(Constants.OutputPdf);
}

See Also

PdfInspectionPackage PdfRootPackage