update 20240812

This commit is contained in:
Stefan Hutter
2024-08-12 16:35:06 +02:00
parent 43c44e0aad
commit fc8811829d
7922 changed files with 205978 additions and 91947 deletions

View File

@@ -4,7 +4,7 @@
<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.Write&lt;T&gt; (IEnumerable&lt;T&gt;, Int32, Boolean) Method</title>
<title>FastExcel Class</title>
<link rel="stylesheet" type="text/css" href="msdn2019/toc.css" />
<script src="msdn2019/toc.js"></script>
@@ -74,11 +74,11 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<div id="mainBody">
<h1 class="title">FastExcel.Write&lt;T&gt; (IEnumerable&lt;T&gt;, Int32, Boolean) Method</h1>
<h1 class="title">FastExcel Class</h1>
<div class="metadata">
Namespace:
<a href="topic_0000000000000493.html">FastExcel</a>
<a href="topic_00000000000004AC.html">FastExcel</a>
@@ -89,7 +89,8 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
<summary-info>Write a list of objects to a sheet</summary-info>
<summary-info>/// Fast Excel
///</summary-info>
@@ -139,7 +140,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<div class="codeSnippetCode codeVB">
<pre xml:space="preserve" class="brush: vb">Public Sub Write(Of _&nbsp;<br /> <i>T</i>)( _&nbsp;<br /> ByVal <i>objectList</i> As <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>(Of T), _&nbsp;<br /> ByVal <i>sheetNumber</i> As <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">Integer</a>, _&nbsp;<br /> ByVal <i>usePropertiesAsHeadings</i> As <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.boolean">Boolean</a> _&nbsp;<br />)</pre>
<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>
@@ -178,7 +179,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<div class="codeSnippetCode codeCsharp">
<pre xml:space="preserve" class="brush: csharp">public <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.void">void</a> Write&lt;T&gt;(&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;T&gt; <i>objectList</i>,&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">int</a> <i>sheetNumber</i>,&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.boolean">bool</a> <i>usePropertiesAsHeadings</i>&nbsp;<br />)</pre>
<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>
@@ -218,7 +219,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<div class="codeSnippetCode codeCpp">
<pre xml:space="preserve" class="brush: cpp">generic&lt;typename T&gt;&nbsp;<br />public: &nbsp;<br /><a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.void">void</a> Write(&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;T&gt;^ <i>objectList</i>,&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">int</a> <i>sheetNumber</i>,&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.boolean">bool</a> <i>usePropertiesAsHeadings</i>&nbsp;<br />) </pre>
<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>
@@ -257,7 +258,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<div class="codeSnippetCode codeJScript">
<pre xml:space="preserve" class="brush: js">JScript does not support generic types and methods.</pre>
<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>
@@ -267,65 +268,6 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<h4 class="subHeading">
Type Parameters</h4><dl paramName="T" class="parameterList">
<dt>
<span class="parameter">
T
</span>
</dt>
<dd>
</dd>
</dl>
<p>
Row Object
</p>
<p />
<h4 class="subHeading">
Parameters</h4><dl paramName="objectList" class="parameterList">
<dt>
<span class="parameter">
objectList
</span>
</dt>
<dd>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;T&gt;
</dd>
</dl>
<p>
IEnumerable list of objects
</p>
<dl paramName="sheetNumber" class="parameterList">
<dt>
<span class="parameter">
sheetNumber
</span>
</dt>
<dd>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">int</a>
</dd>
</dl>
<p>
The number of the sheet starting at 1
</p>
<dl paramName="usePropertiesAsHeadings" class="parameterList">
<dt>
<span class="parameter">
usePropertiesAsHeadings
</span>
</dt>
<dd>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.boolean">bool</a>
</dd>
</dl>
<p>
Use property names from object list as headings
</p>
<p />
@@ -346,6 +288,843 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
<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 -->
@@ -406,6 +1185,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</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>
@@ -414,14 +1194,10 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
<div id="seeAlsoSection" class="section">
<div>
<a href="topic_00000000000004B0.html">FastExcel Class</a><br />
<a href="topic_00000000000004AC.html">FastExcel Namespace</a><br />
<a href="topic_0000000000000493.html">FastExcel Namespace</a><br />
</div>
</div>