You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OnDoc/VSdoc/topic_00000000000004C9.html

1224 lines
20 KiB

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="GENERATOR" content="VSdocman - documentation generator; https://www.helixoft.com" />
<link rel="icon" href="favicon.ico">
<title>FastExcel Class</title>
<link rel="stylesheet" type="text/css" href="msdn2019/toc.css" />
<script src="msdn2019/toc.js"></script>
<link rel="stylesheet" type="text/css" href="msdn2019/msdn2019.css">
<script src="msdn2019/msdn2019.js" type="text/javascript"></script>
<script src="SyntaxHighlighter/scripts/shCore_helixoft.js" type="text/javascript"></script>
<script src="SyntaxHighlighter/scripts/shBrushVb.js" type="text/javascript"></script>
<script src="SyntaxHighlighter/scripts/shBrushCSharp.js" type="text/javascript"></script>
<script src="SyntaxHighlighter/scripts/shBrushFSharp.js" type="text/javascript"></script>
<script src="SyntaxHighlighter/scripts/shBrushCpp.js" type="text/javascript"></script>
<script src="SyntaxHighlighter/scripts/shBrushJScript.js" type="text/javascript"></script>
<link href="SyntaxHighlighter/styles/shCore.css" rel="stylesheet" type="text/css" />
<link href="SyntaxHighlighter/styles/shThemeMsdnLW.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">
SyntaxHighlighter.all();
</script>
<link rel="stylesheet" type="text/css" href="vsdocman_overrides.css">
</head>
<body style="direction: ltr;">
<div id="topic">
<!--HEADER START-->
<div id="header">
<div id="header-top-container">
<div id="header-top-parent-container1">
<div id="header-top-container1">
<div id="runningHeaderText1"><a id="headerLogo" href="#" onclick="window.location.href = getCssCustomProperty('--headerLogoLink'); return false;">logo</a></div>
<div id="runningHeaderText1b"><script>
document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</script></div>
</div>
</div>
<div id="header-top-container2">
<div id="runningHeaderText">SOLUTION-WIDE PROPERTIES Reference</div>
<div id="search-bar-container">
<form id="search-bar" action="search--.html">
<input id="HeaderSearchInput" type="search" name="search" placeholder="Search" >
<button id="btn-search" class="c-glyph" title="Search">
<span>Search</span>
</button>
</form>
<button id="cancel-search" class="cancel-search" title="Cancel">
<span>Cancel</span>
</button>
</div>
</div>
</div>
<hr />
<div id="header-breadcrumbs"></div>
<div id="headerLinks">
</div>
<hr />
</div>
<!--HEADER END-->
<div id="mainSection">
<div id="toc-area">
<div id="toc-container" class="stickthis full-height">
<div id="-1"></div>
<div id="c-1">
<div id="ci-1" class="inner-for-height"></div>
</div>
</div>
</div>
<div id="mainBody">
<h1 class="title">FastExcel Class</h1>
<div class="metadata">
Namespace:
<a href="topic_00000000000004AC.html">FastExcel</a>
<br />Assembly: ExcelNet (in ExcelNet.dll)
</div>
<summary-info>/// Fast Excel
///</summary-info>
<div class="section_container">
<div id="syntaxSection" class="section">
<div id="syntaxCodeBlocks">
<div class="codeSnippetContainer">
<div class="codeSnippetTabs">
<div class="codeSnippetTabLeftCornerActive">
</div>
<div class="codeSnippetTab csFirstTab csActiveTab codeVB">
<a>VB</a>
</div>
<div class="codeSnippetTab csNaTab codeCsharp">
<a href="javascript: CodeSnippet_SetLanguage('Csharp');">C#</a>
</div>
<div class="codeSnippetTab csNaTab codeFsharp">
<a href="javascript: CodeSnippet_SetLanguage('Fsharp');">F#</a>
</div>
<div class="codeSnippetTab csNaTab codeCpp">
<a href="javascript: CodeSnippet_SetLanguage('Cpp');">C++</a>
</div>
<div class="codeSnippetTab csLastTab csNaTab codeJScript">
<a href="javascript: CodeSnippet_SetLanguage('JScript');">JScript</a>
</div>
<div class="codeSnippetTabRightCorner">
</div>
<div style="clear:both;">
</div>
</div>
<div class="codeSnippetCodeCollection">
<div class="codeSnippetToolbar">
<a title="Copy to clipboard." href="javascript:void(0)" onclick="CopyCode(this);">Copy</a>
</div>
<div class="codeSnippetCode codeVB">
<pre xml:space="preserve" class="brush: vb">Public Class FastExcel&nbsp;<br /> Implements <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.idisposable">IDisposable</a></pre>
</div>
<div class="codeSnippetCode codeNA">
<pre xml:space="preserve">This language is not supported or no code example is available.</pre>
</div>
</div>
</div>
<div class="codeSnippetContainer">
<div class="codeSnippetTabs">
<div class="codeSnippetTabLeftCorner">
</div>
<div class="codeSnippetTab csFirstTab csNaTab codeVB">
<a>VB</a>
</div>
<div class="codeSnippetTab csActiveTab codeCsharp">
<a href="javascript: CodeSnippet_SetLanguage('Csharp');">C#</a>
</div>
<div class="codeSnippetTab csNaTab codeFsharp">
<a href="javascript: CodeSnippet_SetLanguage('Fsharp');">F#</a>
</div>
<div class="codeSnippetTab csNaTab codeCpp">
<a href="javascript: CodeSnippet_SetLanguage('Cpp');">C++</a>
</div>
<div class="codeSnippetTab csLastTab csNaTab codeJScript">
<a href="javascript: CodeSnippet_SetLanguage('JScript');">JScript</a>
</div>
<div class="codeSnippetTabRightCorner">
</div>
<div style="clear:both;">
</div>
</div>
<div class="codeSnippetCodeCollection">
<div class="codeSnippetToolbar">
<a title="Copy to clipboard." href="javascript:void(0)" onclick="CopyCode(this);">Copy</a>
</div>
<div class="codeSnippetCode codeCsharp">
<pre xml:space="preserve" class="brush: csharp">public class FastExcel : <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.idisposable">IDisposable</a></pre>
</div>
<div class="codeSnippetCode codeNA">
<pre xml:space="preserve">This language is not supported or no code example is available.</pre>
</div>
</div>
</div>
<div class="codeSnippetContainer">
<div class="codeSnippetTabs">
<div class="codeSnippetTabLeftCorner">
</div>
<div class="codeSnippetTab csFirstTab csNaTab codeVB">
<a>VB</a>
</div>
<div class="codeSnippetTab csNaTab codeCsharp">
<a href="javascript: CodeSnippet_SetLanguage('Csharp');">C#</a>
</div>
<div class="codeSnippetTab csNaTab codeFsharp">
<a href="javascript: CodeSnippet_SetLanguage('Fsharp');">F#</a>
</div>
<div class="codeSnippetTab csActiveTab codeCpp">
<a href="javascript: CodeSnippet_SetLanguage('Cpp');">C++</a>
</div>
<div class="codeSnippetTab csLastTab csNaTab codeJScript">
<a href="javascript: CodeSnippet_SetLanguage('JScript');">JScript</a>
</div>
<div class="codeSnippetTabRightCorner">
</div>
<div style="clear:both;">
</div>
</div>
<div class="codeSnippetCodeCollection">
<div class="codeSnippetToolbar">
<a title="Copy to clipboard." href="javascript:void(0)" onclick="CopyCode(this);">Copy</a>
</div>
<div class="codeSnippetCode codeCpp">
<pre xml:space="preserve" class="brush: cpp">public ref class FastExcel : public <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.idisposable">IDisposable</a></pre>
</div>
<div class="codeSnippetCode codeNA">
<pre xml:space="preserve">This language is not supported or no code example is available.</pre>
</div>
</div>
</div>
<div class="codeSnippetContainer">
<div class="codeSnippetTabs">
<div class="codeSnippetTabLeftCorner">
</div>
<div class="codeSnippetTab csFirstTab csNaTab codeVB">
<a>VB</a>
</div>
<div class="codeSnippetTab csNaTab codeCsharp">
<a href="javascript: CodeSnippet_SetLanguage('Csharp');">C#</a>
</div>
<div class="codeSnippetTab csNaTab codeFsharp">
<a href="javascript: CodeSnippet_SetLanguage('Fsharp');">F#</a>
</div>
<div class="codeSnippetTab csNaTab codeCpp">
<a href="javascript: CodeSnippet_SetLanguage('Cpp');">C++</a>
</div>
<div class="codeSnippetTab csActiveTab csLastTab codeJScript">
<a href="javascript: CodeSnippet_SetLanguage('JScript');">JScript</a>
</div>
<div class="codeSnippetTabRightCornerActive">
</div>
<div style="clear:both;">
</div>
</div>
<div class="codeSnippetCodeCollection">
<div class="codeSnippetToolbar">
<a title="Copy to clipboard." href="javascript:void(0)" onclick="CopyCode(this);">Copy</a>
</div>
<div class="codeSnippetCode codeJScript">
<pre xml:space="preserve" class="brush: js">public class FastExcel&nbsp;<br /> implements <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.idisposable">IDisposable</a></pre>
</div>
<div class="codeSnippetCode codeNA">
<pre xml:space="preserve">This language is not supported or no code example is available.</pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="section_container">
<div class="section_heading">
<span><a href="javascript:void(0)" title="Collapse" onclick="toggleSection(this);">Constructors</a></span>
<div>&nbsp;</div>
</div>
<div id="ConstructorsSection" class="section">
<table class="memberListTable">
<tr>
<th></th>
<th>
Name
</th>
<th>
Description
</th>
</tr>
<tr class="
">
<td>
<img alt="Public constructor" title="Public constructor" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004CD.html">FastExcel(FileInfo, bool)</a>
</td>
<td>
/// Update an existing excel file
///
</td>
</tr>
<tr class="
">
<td>
<img alt="Public constructor" title="Public constructor" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004CE.html">FastExcel(FileInfo, FileInfo)</a>
</td>
<td>
/// Create a new excel file from a template
///
</td>
</tr>
<tr class="
">
<td>
<img alt="Public constructor" title="Public constructor" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004CF.html">FastExcel(Stream)</a>
</td>
<td>
/// Update an existing excel file stream
///
</td>
</tr>
<tr class="
">
<td>
<img alt="Public constructor" title="Public constructor" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004D0.html">FastExcel(Stream, Stream, bool, bool)</a>
</td>
<td>
/// Create a new excel file from a template
///
</td>
</tr>
</table>
<a href="#mainBody">
Top
</a>
</div>
</div>
<div class="section_container">
<div class="section_heading">
<span><a href="javascript:void(0)" title="Collapse" onclick="toggleSection(this);">Properties</a></span>
<div>&nbsp;</div>
</div>
<div id="PropertiesSection" class="section">
<table class="memberListTable">
<tr>
<th></th>
<th>
Name
</th>
<th>
Description
</th>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000004CA.html">ExcelFile</a>
</td>
<td>
/// Output excel file
///
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000004CC.html">ReadOnly</a>
</td>
<td>
/// Is the excel file read only
///
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000004CB.html">TemplateFile</a>
</td>
<td>
/// The template excel file
///
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000004DC.html">Worksheets</a>
</td>
<td>
List of worksheets, loaded on first access of property
</td>
</tr>
</table>
<a href="#mainBody">
Top
</a>
</div>
</div>
<div class="section_container">
<div class="section_heading">
<span><a href="javascript:void(0)" title="Collapse" onclick="toggleSection(this);">Methods</a></span>
<div>&nbsp;</div>
</div>
<div id="MethodsSection" class="section">
<table class="memberListTable">
<tr>
<th></th>
<th>
Name
</th>
<th>
Description
</th>
</tr>
<tr class="
">
<td>
<img alt="Protected method" title="Protected method" src="msdn2019/protmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004D3.html">Dispose(bool)</a>
</td>
<td>
/// Main disposal function
///
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004D2.html">Dispose()</a>
</td>
<td>
/// Saves any pending changes to the Excel stream and adds/updates associated files if needed
///
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004D6.html">GetCellByDefinedName(string, Nullable&lt;Int32&gt;)</a>
</td>
<td>
Returns cell by defined name
If theres more than one, this is the first one.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004D4.html">GetCellRangesByDefinedName(string, Nullable&lt;Int32&gt;)</a>
</td>
<td>
Retrieves ranges of cells by their defined name
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004D7.html">GetCellsByColumnName(string, int, Nullable&lt;Int32&gt;)</a>
</td>
<td>
Returns all cells in a column by name, within optional row range
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004D5.html">GetCellsByDefinedName(string, Nullable&lt;Int32&gt;)</a>
</td>
<td>
Gets all cells by defined name
Like GetCellRangesByCellName, but just retreives all cells in a single list
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004D1.html">GetWorksheetIndexFromName(string)</a>
</td>
<td>
/// Retrieves the index for given worksheet name
///
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004D8.html">Read(int, int)</a>
</td>
<td>
/// Read a sheet by sheet number
///
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004D9.html">Read(string, int)</a>
</td>
<td>
/// Read a sheet by sheet name
///
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004DA.html">Update(Worksheet, int)</a>
</td>
<td>
/// Update the worksheet
///
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004DB.html">Update(Worksheet, string)</a>
</td>
<td>
/// Update the worksheet
///
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004E4.html">Write(DataTable, string)</a>
</td>
<td>
Write a excel from datatable
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004DD.html">Write(Worksheet)</a>
</td>
<td>
Write data to a sheet
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004DE.html">Write(Worksheet, int, int)</a>
</td>
<td>
Write data to a sheet
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004DF.html">Write(Worksheet, string, int)</a>
</td>
<td>
Write data to a sheet
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004E2.html">Write&lt;T&gt;(IEnumerable&lt;T&gt;, int, bool)</a>
</td>
<td>
Write a list of objects to a sheet
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004E0.html">Write&lt;T&gt;(IEnumerable&lt;T&gt;, int, int)</a>
</td>
<td>
Write a list of objects to a sheet
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004E3.html">Write&lt;T&gt;(IEnumerable&lt;T&gt;, string, bool)</a>
</td>
<td>
Write a list of objects to a sheet
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000004E1.html">Write&lt;T&gt;(IEnumerable&lt;T&gt;, string, int)</a>
</td>
<td>
Write a list of objects to a sheet
</td>
</tr>
</table>
<a href="#mainBody">
Top
</a>
</div>
</div>
<div class="section_container">
<div class="section_heading">
<span><a href="javascript:void(0)" title="Collapse" onclick="toggleSection(this);">Extension Methods</a></span>
<div>&nbsp;</div>
</div>
<div id="ExtensionMethodsSection" class="section">
<table class="memberListTable">
<tr>
<th></th>
<th>
Name
</th>
<th>
Description
</th>
</tr>
<tr class="
inheritedMember
">
<td>
<img alt="Public extension method" title="Public extension method" src="msdn2019/pubextensionmethod.png"></img>
</td>
<td>
<a href="topic_000000000000033D.html">NameOf(this object)</a>
</td>
<td>
(Defined by <a target="_top" href="topic_000000000000033B.html" onclick="this.target='';return true;">NLogHelper</a>).
</td>
</tr>
</table>
<a href="#mainBody">
Top
</a>
</div>
</div>
<!-- Classes -->
<!-- Classes End -->
<!-- Standard Modules -->
<!-- Standard Modules End -->
<div class="section_container">
<div class="section_heading">
<span><a href="javascript:void(0)" title="Collapse" onclick="toggleSection(this);">Applies to</a></span>
<div>&nbsp;</div>
</div>
<div id="frameworksSection" class="section">
<h4 class="subHeading">.NET Framework</h4>Supported in: 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8<br />
</div>
</div>
<div class="section_container">
<div class="section_heading">
<span><a href="javascript:void(0)" title="Collapse" onclick="toggleSection(this);">See Also</a></span>
<div>&nbsp;</div>
</div>
<div id="seeAlsoSection" class="section">
<div>
<a href="topic_00000000000004AC.html">FastExcel Namespace</a><br />
</div>
</div>
</div>
</div>
<div id="internal-toc-area">
<div id="internal-toc-container" class="stickthis">
<h3 id="internal-toc-heading">In this article</h3>
<span id="internal-toc-definition-localized-text">Definition</span>
</div>
</div>
</div>
<div id="footer">
<div id="footer-container">
<p>Generated with <a target="_top" href="http://www.helixoft.com/vsdocman/overview.html">VSdocman</a></p>
</div>
</div>
</div>
</body>
</html>