# GrapeCity.Documents.Excel.Expressions.WorkbookReference

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="GrapeCity_Documents_Excel_Expressions_WorkbookReference" data-uid="GrapeCity.Documents.Excel.Expressions.WorkbookReference" class="text-break">WorkbookReference Class
</h1>
  <div class="markdown level0 summary"><p>Represents a reference to an external workbook.
This class is immutable.</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"><span class="xref">WorkbookReference</span></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a>&lt;<a class="xref" href="GrapeCity.Documents.Excel.Expressions.WorkbookReference.html">WorkbookReference</a>&gt;</div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="GrapeCity.Documents.Excel.Expressions.html">GrapeCity.Documents.Excel.Expressions</a></h6>
  <h6><strong>Assembly</strong>: DS.Documents.Excel.dll</h6>
  <h5 id="GrapeCity_Documents_Excel_Expressions_WorkbookReference_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public sealed class WorkbookReference : IEquatable&lt;WorkbookReference&gt;</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public NotInheritable Class WorkbookReference
    Implements IEquatable(Of WorkbookReference)</code></pre>
  </div>
  <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_Excel_Expressions_WorkbookReference_BaseDirectory" data-uid="GrapeCity.Documents.Excel.Expressions.WorkbookReference.BaseDirectory">
          <a class="xref" href="GrapeCity.Documents.Excel.Expressions.WorkbookReference.BaseDirectory.html#GrapeCity_Documents_Excel_Expressions_WorkbookReference_BaseDirectory">BaseDirectory</a>
        </td>
        <td class="markdown level1 summary"><p>The base directory that contains workbook.
If the value is not <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a> (<code>Nothing</code>),
<a class="xref" href="GrapeCity.Documents.Excel.Expressions.WorkbookReference.Name.html#GrapeCity_Documents_Excel_Expressions_WorkbookReference_Name">Name</a> is the file name of workbook.
If the value is empty, the path is the root directory.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_Expressions_WorkbookReference_BaseUri" data-uid="GrapeCity.Documents.Excel.Expressions.WorkbookReference.BaseUri">
          <a class="xref" href="GrapeCity.Documents.Excel.Expressions.WorkbookReference.BaseUri.html#GrapeCity_Documents_Excel_Expressions_WorkbookReference_BaseUri">BaseUri</a>
        </td>
        <td class="markdown level1 summary"><p>The base uri that contains workbook. <br>
If the value is not <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a> (<code>Nothing</code>),
<a class="xref" href="GrapeCity.Documents.Excel.Expressions.WorkbookReference.Name.html#GrapeCity_Documents_Excel_Expressions_WorkbookReference_Name">Name</a> is the file name of workbook.<br>
For example, the base uri of <a href="https://www.grapecity.com/file/example.xlsx">https://www.grapecity.com/file/example.xlsx</a> is
<a href="https://www.grapecity.com/file">https://www.grapecity.com/file</a> . The file name is example.xlsx .</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_Expressions_WorkbookReference_Name" data-uid="GrapeCity.Documents.Excel.Expressions.WorkbookReference.Name">
          <a class="xref" href="GrapeCity.Documents.Excel.Expressions.WorkbookReference.Name.html#GrapeCity_Documents_Excel_Expressions_WorkbookReference_Name">Name</a>
        </td>
        <td class="markdown level1 summary"><p>The name of the workbook.
If the <a class="xref" href="GrapeCity.Documents.Excel.Expressions.WorkbookReference.BaseDirectory.html#GrapeCity_Documents_Excel_Expressions_WorkbookReference_BaseDirectory">BaseDirectory</a> is not <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a> (<code>Nothing</code>),
represents the file name of the workbook.</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_Excel_Expressions_WorkbookReference_Equals_GrapeCity_Documents_Excel_Expressions_WorkbookReference_" data-uid="GrapeCity.Documents.Excel.Expressions.WorkbookReference.Equals(GrapeCity.Documents.Excel.Expressions.WorkbookReference)">
          <a class="xref" href="GrapeCity.Documents.Excel.Expressions.WorkbookReference.Equals.html#GrapeCity_Documents_Excel_Expressions_WorkbookReference_Equals_GrapeCity_Documents_Excel_Expressions_WorkbookReference_">Equals(WorkbookReference)</a>
        </td>
        <td class="markdown level1 summary"><p>Check if the workbook reference equals to another.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_Expressions_WorkbookReference_Equals_System_Object_" data-uid="GrapeCity.Documents.Excel.Expressions.WorkbookReference.Equals(System.Object)">
          <a class="xref" href="GrapeCity.Documents.Excel.Expressions.WorkbookReference.Equals.html#GrapeCity_Documents_Excel_Expressions_WorkbookReference_Equals_System_Object_">Equals(object)</a>
        </td>
        <td class="markdown level1 summary"><p>Check if the workbook reference equals to another.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_Expressions_WorkbookReference_FromFilePath_System_String_" data-uid="GrapeCity.Documents.Excel.Expressions.WorkbookReference.FromFilePath(System.String)">
          <a class="xref" href="GrapeCity.Documents.Excel.Expressions.WorkbookReference.FromFilePath.html#GrapeCity_Documents_Excel_Expressions_WorkbookReference_FromFilePath_System_String_">FromFilePath(string)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a workbook reference from file path.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_Expressions_WorkbookReference_FromName_System_String_" data-uid="GrapeCity.Documents.Excel.Expressions.WorkbookReference.FromName(System.String)">
          <a class="xref" href="GrapeCity.Documents.Excel.Expressions.WorkbookReference.FromName.html#GrapeCity_Documents_Excel_Expressions_WorkbookReference_FromName_System_String_">FromName(string)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a workbook reference from workbook name.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_Expressions_WorkbookReference_FromUri_System_String_" data-uid="GrapeCity.Documents.Excel.Expressions.WorkbookReference.FromUri(System.String)">
          <a class="xref" href="GrapeCity.Documents.Excel.Expressions.WorkbookReference.FromUri.html#GrapeCity_Documents_Excel_Expressions_WorkbookReference_FromUri_System_String_">FromUri(string)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a workbook reference from a URI link to workbook.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_Expressions_WorkbookReference_GetHashCode" data-uid="GrapeCity.Documents.Excel.Expressions.WorkbookReference.GetHashCode">
          <a class="xref" href="GrapeCity.Documents.Excel.Expressions.WorkbookReference.GetHashCode.html#GrapeCity_Documents_Excel_Expressions_WorkbookReference_GetHashCode">GetHashCode()</a>
        </td>
        <td class="markdown level1 summary"><p>Gets hash code of the workbook reference.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_Expressions_WorkbookReference_ToString" data-uid="GrapeCity.Documents.Excel.Expressions.WorkbookReference.ToString">
          <a class="xref" href="GrapeCity.Documents.Excel.Expressions.WorkbookReference.ToString.html#GrapeCity_Documents_Excel_Expressions_WorkbookReference_ToString">ToString()</a>
        </td>
        <td class="markdown level1 summary"><p>Converts workbook reference to string.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>
