Click or drag to resize

PdfFileSpecification Class

Represents a file sppecification
Inheritance Hierarchy
SystemObject
  Patagames.Pdf.Net.WrappersPdfWrapper
    Patagames.Pdf.Net.WrappersPdfFileSpecification

Namespace: Patagames.Pdf.Net.Wrappers
Assembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.89.2704
Syntax
public class PdfFileSpecification : PdfWrapper

The PdfFileSpecification type exposes the following members.

Constructors
 NameDescription
Public methodPdfFileSpecification(PdfDocument) Creates new instance of PdfFileSpecification class.
Public methodPdfFileSpecification(PdfDocument, PdfTypeBase) Creates a new instance of PdfFileSpecification and initialize it with specified dictionary
Top
Properties
 NameDescription
Public propertyDescription Gets or sets descriptive text associated with the file specification.
Public propertyEmbeddedFile Gets or sets embedded file.
Public propertyFileName Gets or sets a file specification string.
Public propertyIsDisposed Gets a value indicating whether the object has been disposed of.
(Overrides PdfWrapperIsDisposed)
Public propertyIsSimpleSpec Gets a flag indicating whether this instance represents a simple file specification or a full one.
Public propertyIsUrl Gets or sets a flag indicating that the FileName should be interpreted as an URL
Public propertyIsVolatile Gets or sets a flag indicating whether the file referenced by the this file specification is volatile (changes frequently with time).
Top
Methods
 NameDescription
Public methodStatic memberFrom Creates a new instance of PdfFileSpecification and initialize it with specified dictionary
Top
Remarks
A PDF file can refer to the contents of another file by using a file specification (PDF 1.1), which can take either of two forms:
  • A simple file specification gives just the name of the target file in a standard format, independent of the naming conventions of any particular file system. It can take the form of either a string or a dictionary
  • A full file specification includes information related to one or more specific file systems.

Although the file designated by a file specification is normally external to the PDF file referring to it, PDF 1.3 permits a copy of the external file to be embedded within the referring PDF file, allowing its contents to be stored or transmitted along with the PDF file. However, embedding a file does not change the presumption that it is external to the PDF file. Consequently, to ensure that the PDF file can be processed correctly, it may be necessary to copy its embedded files back into a local file system.

See Also