HiNC-Deploy/HiNC-2025-win-desktop-Deploy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tune

Browse Source
This commit is contained in:
iamboss
2025-09-15 16:51:51 +08:00
parent 6a4e515562
commit a69e02dd26
29 changed files with 319 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files
App/wwwroot/HiAPI-docsite/api/Hi.Numerical.FilePlayers.CsvRunnerConfig.html
+164 -4
View File
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class CsvRunnerConfig | HiAPI-C# 2025 ">
<meta name="description" content="Configuration class for CSV Runner.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,11 +97,12 @@ Class CsvRunnerConfig
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Configuration class for CSV Runner.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class CsvRunnerConfig</code></pre>
<pre><code class="lang-csharp hljs">public class CsvRunnerConfig : IMakeXmlSource</code></pre>
</div>
@@ -115,6 +116,12 @@ Class CsvRunnerConfig
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
@@ -173,6 +180,70 @@ Class CsvRunnerConfig
<h2 class="section" id="constructors">Constructors
</h2>
<a id="Hi_Numerical_FilePlayers_CsvRunnerConfig__ctor_" data-uid="Hi.Numerical.FilePlayers.CsvRunnerConfig.#ctor*"></a>
<h3 id="Hi_Numerical_FilePlayers_CsvRunnerConfig__ctor" data-uid="Hi.Numerical.FilePlayers.CsvRunnerConfig.#ctor">
CsvRunnerConfig()
</h3>
<div class="markdown level1 summary"><p>Default constructor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CsvRunnerConfig()</code></pre>
</div>
<a id="Hi_Numerical_FilePlayers_CsvRunnerConfig__ctor_" data-uid="Hi.Numerical.FilePlayers.CsvRunnerConfig.#ctor*"></a>
<h3 id="Hi_Numerical_FilePlayers_CsvRunnerConfig__ctor_System_Xml_Linq_XElement_" data-uid="Hi.Numerical.FilePlayers.CsvRunnerConfig.#ctor(System.Xml.Linq.XElement)">
CsvRunnerConfig(XElement)
</h3>
<div class="markdown level1 summary"><p>Constructor from XML.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CsvRunnerConfig(XElement src)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>XML element</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
@@ -375,7 +446,9 @@ Class CsvRunnerConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Parsing dictionary for custom field parsing.
Note: This dictionary cannot be serialized to XML as it contains functions.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -495,6 +568,93 @@ Class CsvRunnerConfig
<a id="Hi_Numerical_FilePlayers_CsvRunnerConfig_XName_" data-uid="Hi.Numerical.FilePlayers.CsvRunnerConfig.XName*"></a>
<h3 id="Hi_Numerical_FilePlayers_CsvRunnerConfig_XName" data-uid="Hi.Numerical.FilePlayers.CsvRunnerConfig.XName">
XName
</h3>
<div class="markdown level1 summary"><p>Name for XML IO.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string XName { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Numerical_FilePlayers_CsvRunnerConfig_MakeXmlSource_" data-uid="Hi.Numerical.FilePlayers.CsvRunnerConfig.MakeXmlSource*"></a>
<h3 id="Hi_Numerical_FilePlayers_CsvRunnerConfig_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.Numerical.FilePlayers.CsvRunnerConfig.MakeXmlSource(System.String,System.String,System.Boolean)">
MakeXmlSource(string, string, bool)
</h3>
<div class="markdown level1 summary"><p>Creates an XML representation of the object.
This method may also generate additional resources such as related files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The base directory for resolving relative paths</p>
</dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path for the XML source</p>
</dd>
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>if true, the extended file creation is suppressed.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>An XML element representing the object's state</p>
</dd>
</dl>
<h4 class="section" id="Hi_Numerical_FilePlayers_CsvRunnerConfig_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
Since the folder can be moving with the configuration file.</p>
</div>
</article>