# GrapeCity.Documents.Pdf.FileSpecification

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="GrapeCity_Documents_Pdf_FileSpecification" data-uid="GrapeCity.Documents.Pdf.FileSpecification" class="text-break">FileSpecification Class
</h1>
  <div class="markdown level0 summary"><p>Represents a PDF File Specification.</p>
<p>
The complex architecture of this class is based on the PDF Specification,
for full details please consult that spec.
</p>
<p>
In many practical scenarios while generating PDFs, using the provided static constructors
on the derived classes (<a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.html">FileSpecification</a>, <a class="xref" href="GrapeCity.Documents.Pdf.EmbeddedFileStream.html">EmbeddedFileStream</a> etc.)
may be enough though.
</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
    <div class="level1"><a class="xref" href="GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase.html">PdfWrapperBase</a></div>
    <div class="level2"><span class="xref">PdfDynamicWrapper</span>&lt;<span class="xref">IPdfObject</span>&gt;</div>
    <div class="level3"><span class="xref">FileSpecification</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="GrapeCity.Documents.Pdf.html">GrapeCity.Documents.Pdf</a></h6>
  <h6><strong>Assembly</strong>: DS.Documents.Pdf.dll</h6>
  <h5 id="GrapeCity_Documents_Pdf_FileSpecification_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class FileSpecification : PdfDynamicWrapper&lt;IPdfObject&gt;</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class FileSpecification
    Inherits PdfDynamicWrapper(Of IPdfObject)</code></pre>
  </div>
  <h3 id="constructors">Constructors
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification__ctor" data-uid="GrapeCity.Documents.Pdf.FileSpecification.#ctor">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.-ctor.html#GrapeCity_Documents_Pdf_FileSpecification__ctor">FileSpecification()</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.html">FileSpecification</a> class.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_DOSFile" data-uid="GrapeCity.Documents.Pdf.FileSpecification.DOSFile">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.DOSFile.html#GrapeCity_Documents_Pdf_FileSpecification_DOSFile">DOSFile</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.FileInfo.html">FileSpecification.FileInfo</a> object defining information about referenced file for DOS platform.
NOTE: Using this property is not recommended beginning with PDF 1.7.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_Desc" data-uid="GrapeCity.Documents.Pdf.FileSpecification.Desc">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.Desc.html#GrapeCity_Documents_Pdf_FileSpecification_Desc">Desc</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the description of this File Specification.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_File" data-uid="GrapeCity.Documents.Pdf.FileSpecification.File">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.File.html#GrapeCity_Documents_Pdf_FileSpecification_File">File</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.FileInfo.html">FileSpecification.FileInfo</a> object that specifies information about a referenced file.
Note that this property should be used for files with names containing ASCII characters only,
and is provided for backwards compatibility. For file names that contain non-ASCII characters,
<a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.UnicodeFile.html#GrapeCity_Documents_Pdf_FileSpecification_UnicodeFile">UnicodeFile</a> should be used instead.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_FileSystem" data-uid="GrapeCity.Documents.Pdf.FileSpecification.FileSystem">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.FileSystem.html#GrapeCity_Documents_Pdf_FileSpecification_FileSystem">FileSystem</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the file system to be used to interpret this file specification.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_HasEmbeddedFileStream" data-uid="GrapeCity.Documents.Pdf.FileSpecification.HasEmbeddedFileStream">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.HasEmbeddedFileStream.html#GrapeCity_Documents_Pdf_FileSpecification_HasEmbeddedFileStream">HasEmbeddedFileStream</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a value indicating that this file specification has at least one
<a class="xref" href="GrapeCity.Documents.Pdf.EmbeddedFileStream.html">EmbeddedFileStream</a> associated with it.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_ID" data-uid="GrapeCity.Documents.Pdf.FileSpecification.ID">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.ID.html#GrapeCity_Documents_Pdf_FileSpecification_ID">ID</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the <a class="xref" href="GrapeCity.Documents.Pdf.FileID.html">FileID</a> object specifying the ID of the referenced file.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_MacFile" data-uid="GrapeCity.Documents.Pdf.FileSpecification.MacFile">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.MacFile.html#GrapeCity_Documents_Pdf_FileSpecification_MacFile">MacFile</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.FileInfo.html">FileSpecification.FileInfo</a> object defining information about referenced file for Mac OS platform.
NOTE: Using this property is not recommended beginning with PDF 1.7.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_Relationship" data-uid="GrapeCity.Documents.Pdf.FileSpecification.Relationship">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.Relationship.html#GrapeCity_Documents_Pdf_FileSpecification_Relationship">Relationship</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value that represents the relationship of this object
to the source that points to it.</p>
<p>
Predefined values are <b>Source</b>, <b>Data</b>, <b>Alternative</b>,
<b>Supplement</b> and <b>Unspecified</b>.
</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_UnicodeFile" data-uid="GrapeCity.Documents.Pdf.FileSpecification.UnicodeFile">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.UnicodeFile.html#GrapeCity_Documents_Pdf_FileSpecification_UnicodeFile">UnicodeFile</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.FileInfo.html">FileSpecification.FileInfo</a> object that specifies information about a referenced file.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_UnixFile" data-uid="GrapeCity.Documents.Pdf.FileSpecification.UnixFile">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.UnixFile.html#GrapeCity_Documents_Pdf_FileSpecification_UnixFile">UnixFile</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.FileInfo.html">FileSpecification.FileInfo</a> object defining information about referenced file for Unix platform.
NOTE: Using this property is not recommended beginning with PDF 1.7.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_Volatile" data-uid="GrapeCity.Documents.Pdf.FileSpecification.Volatile">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.Volatile.html#GrapeCity_Documents_Pdf_FileSpecification_Volatile">Volatile</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating whether the file referenced by the file specification is volatile
(changes frequently with time). If the value is true, applications should never cache a copy of the file.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_FromDOSFileName_System_String_" data-uid="GrapeCity.Documents.Pdf.FileSpecification.FromDOSFileName(System.String)">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.FromDOSFileName.html#GrapeCity_Documents_Pdf_FileSpecification_FromDOSFileName_System_String_">FromDOSFileName(string)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.html">FileSpecification</a> object from a DOS file name.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_FromEmbeddedFile_GrapeCity_Documents_Pdf_EmbeddedFileStream_System_String_" data-uid="GrapeCity.Documents.Pdf.FileSpecification.FromEmbeddedFile(GrapeCity.Documents.Pdf.EmbeddedFileStream,System.String)">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.FromEmbeddedFile.html#GrapeCity_Documents_Pdf_FileSpecification_FromEmbeddedFile_GrapeCity_Documents_Pdf_EmbeddedFileStream_System_String_">FromEmbeddedFile(EmbeddedFileStream, string)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.html">FileSpecification</a> object referencing a specified <a class="xref" href="GrapeCity.Documents.Pdf.EmbeddedFileStream.html">EmbeddedFileStream</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_FromEmbeddedStream_System_String_GrapeCity_Documents_Pdf_EmbeddedFileStream_System_String_" data-uid="GrapeCity.Documents.Pdf.FileSpecification.FromEmbeddedStream(System.String,GrapeCity.Documents.Pdf.EmbeddedFileStream,System.String)">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.FromEmbeddedStream.html#GrapeCity_Documents_Pdf_FileSpecification_FromEmbeddedStream_System_String_GrapeCity_Documents_Pdf_EmbeddedFileStream_System_String_">FromEmbeddedStream(string, EmbeddedFileStream, string)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.html">FileSpecification</a> object referencing a specified <a class="xref" href="GrapeCity.Documents.Pdf.EmbeddedFileStream.html">EmbeddedFileStream</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_FromURI_System_String_" data-uid="GrapeCity.Documents.Pdf.FileSpecification.FromURI(System.String)">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.FromURI.html#GrapeCity_Documents_Pdf_FileSpecification_FromURI_System_String_">FromURI(string)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.html">FileSpecification</a> object representing an URI reference.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Pdf_FileSpecification_GetStream" data-uid="GrapeCity.Documents.Pdf.FileSpecification.GetStream">
          <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.GetStream.html#GrapeCity_Documents_Pdf_FileSpecification_GetStream">GetStream()</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.stream">Stream</a> containing the content of this <a class="xref" href="GrapeCity.Documents.Pdf.FileSpecification.html">FileSpecification</a>,
or null if the file specification is empty.</p>
<p>Important: this <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.stream">Stream</a> must be disposed after use.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>