Pdf |
Represents a full file specification that might include information related to one or more specific file systems with which a PDF file can refer to the contents of another file (PDF 1.1).
A file specification shall refer to a file external to the PDF file or to a file embedded within the referring PDF file, allowing its contents to be stored or transmitted along with the PDF file. The file is considered external to the PDF file in either case.
Inheritance HierarchyNamespace: SautinSoft.Pdf
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.8.8
SyntaxThe PdfFileSpecification type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AssociatedRelationshipType | (Optional; PDF 2.0) A name value that represents the relationship between the component of this PDF document that refers to this PdfFileSpecification and the associated file denoted by this PdfFileSpecification. Default value: Unspecified. |
| Description | (Optional; PDF 1.6) Descriptive text associated with the file specification. It shall be used for files in the EmbeddedFiles name tree (see 7.7.4, "Name Dictionary"). |
| EmbeddedFile | (Required if RelatedFiles collection is not empty; PDF 1.3) An embedded file stream (see 7.11.4, "Embedded File Streams"). |
| EncryptedPayload | (PDF 2.0; Required if this file specification references an encrypted payload document) The value of this property is a PdfEncryptedPayload which identifies that the file specified in the EmbeddedFile is an encrypted payload. |
| IsUrl | Gets or sets a value indicating whether the URL file system shall be used to interpret this file specification. When the IsUrl property in a PdfFileSpecification has the value , the value of the Name property in that PdfFileSpecification is not a file specification string, but a uniform resource locator (URL) of the form defined in Internet RFC 3986, Uniform Resource Locators. Default value: . |
| IsVolatile | (Optional; PDF 1.2) A flag indicating whether the file referenced by the file specification is volatile (changes frequently with time). If the value is , applications shall not cache a copy of the file. For example, a movie annotation referencing a URL to a live video camera could set this flag to to notify the conforming reader that it should re-acquire the movie each time it is played. Default value: . |
| Metadata | (Optional; PDF 1.4) A metadata stream containing metadata for the component.
(Inherited from PdfObject) |
| Name | Gets or sets the file specification string of the form described in 7.11.2, "File Specification Strings", or (if the IsUrl is ) a uniform resource locator, as described in 7.11.5, "URL Specifications". |
| PortfolioFieldValues | (Optional; shall be indirect reference; PDF 1.7) A collection item dictionary, which shall be used to create the user interface for portable collections (see 7.11.6, "Collection Items"). |
| PortfolioFolder | Gets the parent PdfPortfolioFolder or if the PDF document is not a PDF Portfolio (Portfolio is ) or if this PdfFileSpecification is one of the root EmbeddedFiles contained in the PdfPortfolio. |
| RelatedFiles | (Optional; PDF 1.3) A related files array (see 7.11.4.2, "Related Files Arrays") identifying files that are related to the EmbeddedFile. |
| Thumbnail | (Optional; PDF 2.0) A stream object defining the thumbnail image for the file specification (see 12.3.4, "Thumbnail Images"). |
Methods| Name | Description | |
|---|---|---|
 | AddRelatedFile | Adds a new empty PdfEmbeddedFile to the RelatedFiles collection. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| SetEmbeddedFile | Sets the EmbeddedFile to a new empty PdfEmbeddedFile. |
| SetEmbeddedFile(String) | Sets the EmbeddedFile to a new PdfEmbeddedFile copied from the resource specified by the filePath. |
| SetEncryptedPayload | Sets the EncryptedPayload toa new PdfEncryptedPayload with the specified cryptographicFilterName. |
| ToString |
Returns a String that represents this PdfFileSpecification instance.
(Overrides ObjectToString) |
Extension Methods| Name | Description | |
|---|---|---|
 | GetArray |
Gets the PdfArray that serves as a backing storage of the specified PdfObject or if no PdfArray serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions) |
| GetDictionary |
Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions) |
| GetOrAddDictionary |
Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions) |
See Also