This commit is contained in:
2025-12-18 11:09:45 +08:00
parent 5e28ac1fa7
commit 32ff8b45e3
62 changed files with 2436 additions and 1551 deletions
@@ -185,6 +185,37 @@ Host class for HiNC functionality that provides project management, path resolut
</h2>
<a id="Hi_HiNcKits_HiNcHost__ctor_" data-uid="Hi.HiNcKits.HiNcHost.#ctor*"></a>
<h3 id="Hi_HiNcKits_HiNcHost__ctor_Hi_MachiningProcs_ProxyProjectService_" data-uid="Hi.HiNcKits.HiNcHost.#ctor(Hi.MachiningProcs.ProxyProjectService)">
HiNcHost(ProxyProjectService)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public HiNcHost(ProxyProjectService proxyProjectService)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>proxyProjectService</code> <a class="xref" href="Hi.MachiningProcs.ProxyProjectService.html">ProxyProjectService</a></dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_HiNcHost__ctor_" data-uid="Hi.HiNcKits.HiNcHost.#ctor*"></a>
<h3 id="Hi_HiNcKits_HiNcHost__ctor_System_String_System_Int32_System_String_" data-uid="Hi.HiNcKits.HiNcHost.#ctor(System.String,System.Int32,System.String)">
@@ -291,10 +322,10 @@ Host class for HiNC functionality that provides project management, path resolut
</h2>
<a id="Hi_HiNcKits_HiNcHost_AdminDir_" data-uid="Hi.HiNcKits.HiNcHost.AdminDir*"></a>
<a id="Hi_HiNcKits_HiNcHost_AdminDirectory_" data-uid="Hi.HiNcKits.HiNcHost.AdminDirectory*"></a>
<h3 id="Hi_HiNcKits_HiNcHost_AdminDir" data-uid="Hi.HiNcKits.HiNcHost.AdminDir">
AdminDir
<h3 id="Hi_HiNcKits_HiNcHost_AdminDirectory" data-uid="Hi.HiNcKits.HiNcHost.AdminDirectory">
AdminDirectory
</h3>
@@ -303,7 +334,7 @@ Host class for HiNC functionality that provides project management, path resolut
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string AdminDir { get; }</code></pre>
<pre><code class="lang-csharp hljs">public string AdminDirectory { get; set; }</code></pre>
</div>
@@ -419,39 +450,6 @@ Host class for HiNC functionality that provides project management, path resolut
<a id="Hi_HiNcKits_HiNcHost_DirectoryRoute_" data-uid="Hi.HiNcKits.HiNcHost.DirectoryRoute*"></a>
<h3 id="Hi_HiNcKits_HiNcHost_DirectoryRoute" data-uid="Hi.HiNcKits.HiNcHost.DirectoryRoute">
DirectoryRoute
</h3>
<div class="markdown level1 summary"><p>The <a class="xref" href="Hi.Common.PathUtils.BaseAndSubDirectory.html#Hi_Common_PathUtils_BaseAndSubDirectory_BaseDirectory">BaseDirectory</a> is admin directory.
The <a class="xref" href="Hi.Common.PathUtils.BaseAndSubDirectory.html#Hi_Common_PathUtils_BaseAndSubDirectory_SubDirectory">SubDirectory</a> is current applied project directory.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BaseAndSubDirectory DirectoryRoute { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.PathUtils.BaseAndSubDirectory.html">BaseAndSubDirectory</a></dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_HiNcHost_MachiningProject_" data-uid="Hi.HiNcKits.HiNcHost.MachiningProject*"></a>
<h3 id="Hi_HiNcKits_HiNcHost_MachiningProject" data-uid="Hi.HiNcKits.HiNcHost.MachiningProject">
@@ -459,8 +457,7 @@ The <a class="xref" href="Hi.Common.PathUtils.BaseAndSubDirectory.html#Hi_Common
</h3>
<div class="markdown level1 summary"><p>Gets the current MachiningProject instance.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -516,10 +513,10 @@ The <a class="xref" href="Hi.Common.PathUtils.BaseAndSubDirectory.html#Hi_Common
<a id="Hi_HiNcKits_HiNcHost_ProjectDir_" data-uid="Hi.HiNcKits.HiNcHost.ProjectDir*"></a>
<a id="Hi_HiNcKits_HiNcHost_ProjectDirectory_" data-uid="Hi.HiNcKits.HiNcHost.ProjectDirectory*"></a>
<h3 id="Hi_HiNcKits_HiNcHost_ProjectDir" data-uid="Hi.HiNcKits.HiNcHost.ProjectDir">
ProjectDir
<h3 id="Hi_HiNcKits_HiNcHost_ProjectDirectory" data-uid="Hi.HiNcKits.HiNcHost.ProjectDirectory">
ProjectDirectory
</h3>
@@ -528,7 +525,7 @@ The <a class="xref" href="Hi.Common.PathUtils.BaseAndSubDirectory.html#Hi_Common
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ProjectDir { get; }</code></pre>
<pre><code class="lang-csharp hljs">public string ProjectDirectory { get; }</code></pre>
</div>
@@ -612,38 +609,6 @@ The <a class="xref" href="Hi.Common.PathUtils.BaseAndSubDirectory.html#Hi_Common
<a id="Hi_HiNcKits_HiNcHost_ProjectPathRoute_" data-uid="Hi.HiNcKits.HiNcHost.ProjectPathRoute*"></a>
<h3 id="Hi_HiNcKits_HiNcHost_ProjectPathRoute" data-uid="Hi.HiNcKits.HiNcHost.ProjectPathRoute">
ProjectPathRoute
</h3>
<div class="markdown level1 summary"><p>Gets the project path route.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public PathRoute ProjectPathRoute { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.PathUtils.PathRoute.html">PathRoute</a></dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_HiNcHost_ProjectRelativeDirectory_" data-uid="Hi.HiNcKits.HiNcHost.ProjectRelativeDirectory*"></a>
<h3 id="Hi_HiNcKits_HiNcHost_ProjectRelativeDirectory" data-uid="Hi.HiNcKits.HiNcHost.ProjectRelativeDirectory">
@@ -676,6 +641,37 @@ The <a class="xref" href="Hi.Common.PathUtils.BaseAndSubDirectory.html#Hi_Common
<a id="Hi_HiNcKits_HiNcHost_RelativeProjectPath_" data-uid="Hi.HiNcKits.HiNcHost.RelativeProjectPath*"></a>
<h3 id="Hi_HiNcKits_HiNcHost_RelativeProjectPath" data-uid="Hi.HiNcKits.HiNcHost.RelativeProjectPath">
RelativeProjectPath
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string RelativeProjectPath { 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>
<a id="Hi_HiNcKits_HiNcHost_ResourceDir_" data-uid="Hi.HiNcKits.HiNcHost.ResourceDir*"></a>
<h3 id="Hi_HiNcKits_HiNcHost_ResourceDir" data-uid="Hi.HiNcKits.HiNcHost.ResourceDir">
@@ -779,7 +775,7 @@ The <a class="xref" href="Hi.Common.PathUtils.BaseAndSubDirectory.html#Hi_Common
</h3>
<div class="markdown level1 summary"><p>Relative directory from <a class="xref" href="Hi.HiNcKits.HiNcHost.html#Hi_HiNcKits_HiNcHost_AdminDir">AdminDir</a> for resource.</p>
<div class="markdown level1 summary"><p>Relative directory from <a class="xref" href="Hi.HiNcKits.HiNcHost.html#Hi_HiNcKits_HiNcHost_AdminDirectory">AdminDirectory</a> for resource.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -1209,7 +1205,7 @@ The <a class="xref" href="Hi.Common.PathUtils.BaseAndSubDirectory.html#Hi_Common
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task LoadProjectByRelativePath(string relativeFilePathFromAdminRoot)</code></pre>
<pre><code class="lang-csharp hljs">public void LoadProjectByRelativePath(string relativeFilePathFromAdminRoot)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -1219,12 +1215,6 @@ The <a class="xref" href="Hi.Common.PathUtils.BaseAndSubDirectory.html#Hi_Common
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd><p>A task representing the asynchronous operation</p>
</dd>
</dl>
@@ -1314,12 +1304,12 @@ The <a class="xref" href="Hi.Common.PathUtils.BaseAndSubDirectory.html#Hi_Common
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SaveAsProject(string relativeFilePathFromAdminRoot)</code></pre>
<pre><code class="lang-csharp hljs">public void SaveAsProject(string relativeFilePath)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relativeFilePathFromAdminRoot</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dt><code>relativeFilePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path from the admin directory root</p>
</dd>
</dl>
@@ -1342,7 +1332,7 @@ The <a class="xref" href="Hi.Common.PathUtils.BaseAndSubDirectory.html#Hi_Common
</h3>
<div class="markdown level1 summary"><p>Save project by <a class="xref" href="Hi.HiNcKits.HiNcHost.html#Hi_HiNcKits_HiNcHost_ProjectPathRoute">ProjectPathRoute</a>.</p>
<div class="markdown level1 summary"><p>Save project in the current path.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -1406,37 +1396,6 @@ The <a class="xref" href="Hi.Common.PathUtils.BaseAndSubDirectory.html#Hi_Common
<h3 id="Hi_HiNcKits_HiNcHost_OnMachiningProjectDisposing" data-uid="Hi.HiNcKits.HiNcHost.OnMachiningProjectDisposing">
OnMachiningProjectDisposing
</h3>
<div class="markdown level1 summary"><p>Event raised when the MachiningProject is about to be disposed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Func&lt;MachiningProject, Task&gt; OnMachiningProjectDisposing</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;<a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="Hi_HiNcKits_HiNcHost_OnShownMessageBoard" data-uid="Hi.HiNcKits.HiNcHost.OnShownMessageBoard">
OnShownMessageBoard