Click or drag to resize
Pdftools logo

FileReference Class

Description of a file

A file description is used for embedded files.
Inheritance Hierarchy
SystemObject
  PdfTools.Toolbox.InternalNativeBase
    PdfTools.Toolbox.InternalNativeObject
      PdfTools.Toolbox.PdfFileReference

Namespace: PdfTools.Toolbox.Pdf
Assembly: PdfTools.Toolbox (in PdfTools.Toolbox.dll) Version: 1.2.0+708f7116d933787a0712d56133e4c2c9bf21e5e3
Syntax
C#
Copy
public class FileReference : NativeObject

The FileReference type exposes the following members.

Properties
 NameDescription
Public propertyAssociationRelationship

The file's association relationship

This property is if the file is not associated with any object. When associating a file reference with an object such as the document or a page, then this property defines the relationship between the file and the object. Typical values are:
  • "Source": used if this file is the original source material for the associated content.
  • "Data": used if this file represents information used to derive a visual presentation such as for a table or a graph.
  • "Alternative": used if this file is an alternative representation of content, for example audio.
  • "Supplement": used if this file represents a supplemental representation of the original source or data that may be more easily consumable (e.g., a MathML version of an equation).
  • "EncryptedPayload": used if this file is an encrypted payload document that should be displayed to the user if the PDF processor has the cryptographic filter needed to decrypt the document.
  • "FormData": used if this file is the data associated with form fields of this PDF.
  • "Schema": used if this file is a schema definition for the associated object.
  • "Unspecified": used when the relationship is not known.
Public propertyData

The file's stream

Public propertyDescription

The file's description

For embedded files, this is the description of the file presented to the user in the list of embedded files.
Public propertyMediaType

The file's MIME type

Public propertyModificationDate

The file's date of last modification

Public propertyName

The file name

For embedded files, this is the name presented to the user in a the list of embedded files.
Top
Methods
 NameDescription
Public methodStatic memberCopy

Copy a file reference object

Copy a file reference object from an input document to the given targetDocument. The returned object is associated with the given target document but not yet part of it.
Public methodStatic memberCreate

Create a new file reference object

The newly created file reference object belongs to the document but is not (yet) used as an embedded file. The object can be added to the list of embedded files or to the list of associated files.
Public methodEquals
(Inherited from NativeObject)
Public methodGetHashCode
(Inherited from NativeObject)
Top
See Also