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
@@ -2,11 +2,11 @@
<html>
<head>
<meta charset="utf-8">
<title>Class AppConfig | HiAPI-C# 2025 </title>
<title>Class UserConfig | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class AppConfig | HiAPI-C# 2025 ">
<meta name="title" content="Class UserConfig | HiAPI-C# 2025 ">
<meta name="description" content="User Configuration">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -84,12 +84,12 @@
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.HiNcKits.AppConfig">
<article data-uid="Hi.HiNcKits.UserConfig">
<h1 id="Hi_HiNcKits_UserConfig" data-uid="Hi.HiNcKits.AppConfig" class="text-break">
Class AppConfig
<h1 id="Hi_HiNcKits_UserConfig" data-uid="Hi.HiNcKits.UserConfig" class="text-break">
Class UserConfig
</h1>
<div class="facts text-secondary">
@@ -97,11 +97,12 @@ Class AppConfig
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>User Configuration</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class AppConfig : IMakeXmlSource</code></pre>
<pre><code class="lang-csharp hljs">public class UserConfig : IMakeXmlSource</code></pre>
</div>
@@ -111,7 +112,7 @@ Class AppConfig
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">AppConfig</span></div>
<div><span class="xref">UserConfig</span></div>
</dd>
</dl>
@@ -183,10 +184,10 @@ Class AppConfig
</h2>
<a id="Hi_HiNcKits_UserConfig__ctor_" data-uid="Hi.HiNcKits.AppConfig.#ctor*"></a>
<a id="Hi_HiNcKits_UserConfig__ctor_" data-uid="Hi.HiNcKits.UserConfig.#ctor*"></a>
<h3 id="Hi_HiNcKits_UserConfig__ctor" data-uid="Hi.HiNcKits.AppConfig.#ctor">
AppConfig()
<h3 id="Hi_HiNcKits_UserConfig__ctor" data-uid="Hi.HiNcKits.UserConfig.#ctor">
UserConfig()
</h3>
@@ -195,7 +196,7 @@ Class AppConfig
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AppConfig()</code></pre>
<pre><code class="lang-csharp hljs">public UserConfig()</code></pre>
</div>
@@ -210,19 +211,19 @@ Class AppConfig
<a id="Hi_HiNcKits_UserConfig__ctor_" data-uid="Hi.HiNcKits.AppConfig.#ctor*"></a>
<a id="Hi_HiNcKits_UserConfig__ctor_" data-uid="Hi.HiNcKits.UserConfig.#ctor*"></a>
<h3 id="Hi_HiNcKits_UserConfig__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.HiNcKits.AppConfig.#ctor(System.Xml.Linq.XElement,System.String)">
AppConfig(XElement, string)
<h3 id="Hi_HiNcKits_UserConfig__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.HiNcKits.UserConfig.#ctor(System.Xml.Linq.XElement,System.String)">
UserConfig(XElement, string)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.AppConfig.html">AppConfig</a> class from XML data.</p>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.UserConfig.html">UserConfig</a> class from XML data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AppConfig(XElement src, string baseDirectory)</code></pre>
<pre><code class="lang-csharp hljs">public UserConfig(XElement src, string baseDirectory)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -250,9 +251,9 @@ Class AppConfig
</h2>
<a id="Hi_HiNcKits_UserConfig_DisplayedStepPresentKeyList_" data-uid="Hi.HiNcKits.AppConfig.DisplayedStepPresentKeyList*"></a>
<a id="Hi_HiNcKits_UserConfig_DisplayedStepPresentKeyList_" data-uid="Hi.HiNcKits.UserConfig.DisplayedStepPresentKeyList*"></a>
<h3 id="Hi_HiNcKits_UserConfig_DisplayedStepPresentKeyList" data-uid="Hi.HiNcKits.AppConfig.DisplayedStepPresentKeyList">
<h3 id="Hi_HiNcKits_UserConfig_DisplayedStepPresentKeyList" data-uid="Hi.HiNcKits.UserConfig.DisplayedStepPresentKeyList">
DisplayedStepPresentKeyList
</h3>
@@ -282,9 +283,43 @@ Class AppConfig
<a id="Hi_HiNcKits_UserConfig_EquipmentWorkpieceSetupDisplayeeConfig_" data-uid="Hi.HiNcKits.AppConfig.EquipmentWorkpieceSetupDisplayeeConfig*"></a>
<a id="Hi_HiNcKits_UserConfig_EnableFullControl_" data-uid="Hi.HiNcKits.UserConfig.EnableFullControl*"></a>
<h3 id="Hi_HiNcKits_UserConfig_EquipmentWorkpieceSetupDisplayeeConfig" data-uid="Hi.HiNcKits.AppConfig.EquipmentWorkpieceSetupDisplayeeConfig">
<h3 id="Hi_HiNcKits_UserConfig_EnableFullControl" data-uid="Hi.HiNcKits.UserConfig.EnableFullControl">
EnableFullControl
</h3>
<div class="markdown level1 summary"><p>Enable Full control of the application.
Eanble System.Diagnostics.Process in GUI Script Command.
Not used yet.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool EnableFullControl { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_UserConfig_EquipmentWorkpieceSetupDisplayeeConfig_" data-uid="Hi.HiNcKits.UserConfig.EquipmentWorkpieceSetupDisplayeeConfig*"></a>
<h3 id="Hi_HiNcKits_UserConfig_EquipmentWorkpieceSetupDisplayeeConfig" data-uid="Hi.HiNcKits.UserConfig.EquipmentWorkpieceSetupDisplayeeConfig">
EquipmentWorkpieceSetupDisplayeeConfig
</h3>
@@ -314,9 +349,9 @@ Class AppConfig
<a id="Hi_HiNcKits_UserConfig_FixtureSetupDisplayeeConfig_" data-uid="Hi.HiNcKits.AppConfig.FixtureSetupDisplayeeConfig*"></a>
<a id="Hi_HiNcKits_UserConfig_FixtureSetupDisplayeeConfig_" data-uid="Hi.HiNcKits.UserConfig.FixtureSetupDisplayeeConfig*"></a>
<h3 id="Hi_HiNcKits_UserConfig_FixtureSetupDisplayeeConfig" data-uid="Hi.HiNcKits.AppConfig.FixtureSetupDisplayeeConfig">
<h3 id="Hi_HiNcKits_UserConfig_FixtureSetupDisplayeeConfig" data-uid="Hi.HiNcKits.UserConfig.FixtureSetupDisplayeeConfig">
FixtureSetupDisplayeeConfig
</h3>
@@ -346,14 +381,15 @@ Class AppConfig
<a id="Hi_HiNcKits_UserConfig_GraphicCacheLowerLimitMb_" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheLowerLimitMb*"></a>
<a id="Hi_HiNcKits_UserConfig_GraphicCacheLowerLimitMb_" data-uid="Hi.HiNcKits.UserConfig.GraphicCacheLowerLimitMb*"></a>
<h3 id="Hi_HiNcKits_UserConfig_GraphicCacheLowerLimitMb" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheLowerLimitMb">
<h3 id="Hi_HiNcKits_UserConfig_GraphicCacheLowerLimitMb" data-uid="Hi.HiNcKits.UserConfig.GraphicCacheLowerLimitMb">
GraphicCacheLowerLimitMb
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the lower limit of graphic cache in megabytes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -377,14 +413,15 @@ Class AppConfig
<a id="Hi_HiNcKits_UserConfig_GraphicCacheMb_" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheMb*"></a>
<a id="Hi_HiNcKits_UserConfig_GraphicCacheMb_" data-uid="Hi.HiNcKits.UserConfig.GraphicCacheMb*"></a>
<h3 id="Hi_HiNcKits_UserConfig_GraphicCacheMb" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheMb">
<h3 id="Hi_HiNcKits_UserConfig_GraphicCacheMb" data-uid="Hi.HiNcKits.UserConfig.GraphicCacheMb">
GraphicCacheMb
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the graphic cache size in megabytes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -408,14 +445,15 @@ Class AppConfig
<a id="Hi_HiNcKits_UserConfig_GraphicCacheUpperLimitMb_" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheUpperLimitMb*"></a>
<a id="Hi_HiNcKits_UserConfig_GraphicCacheUpperLimitMb_" data-uid="Hi.HiNcKits.UserConfig.GraphicCacheUpperLimitMb*"></a>
<h3 id="Hi_HiNcKits_UserConfig_GraphicCacheUpperLimitMb" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheUpperLimitMb">
<h3 id="Hi_HiNcKits_UserConfig_GraphicCacheUpperLimitMb" data-uid="Hi.HiNcKits.UserConfig.GraphicCacheUpperLimitMb">
GraphicCacheUpperLimitMb
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the upper limit of graphic cache in megabytes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -439,14 +477,15 @@ Class AppConfig
<a id="Hi_HiNcKits_UserConfig_LanguageCode_" data-uid="Hi.HiNcKits.AppConfig.LanguageCode*"></a>
<a id="Hi_HiNcKits_UserConfig_LanguageCode_" data-uid="Hi.HiNcKits.UserConfig.LanguageCode*"></a>
<h3 id="Hi_HiNcKits_UserConfig_LanguageCode" data-uid="Hi.HiNcKits.AppConfig.LanguageCode">
<h3 id="Hi_HiNcKits_UserConfig_LanguageCode" data-uid="Hi.HiNcKits.UserConfig.LanguageCode">
LanguageCode
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the language code for the application UI.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -470,14 +509,15 @@ Class AppConfig
<a id="Hi_HiNcKits_UserConfig_ShowPhysicsOptions_" data-uid="Hi.HiNcKits.AppConfig.ShowPhysicsOptions*"></a>
<a id="Hi_HiNcKits_UserConfig_ShowPhysicsOptions_" data-uid="Hi.HiNcKits.UserConfig.ShowPhysicsOptions*"></a>
<h3 id="Hi_HiNcKits_UserConfig_ShowPhysicsOptions" data-uid="Hi.HiNcKits.AppConfig.ShowPhysicsOptions">
<h3 id="Hi_HiNcKits_UserConfig_ShowPhysicsOptions" data-uid="Hi.HiNcKits.UserConfig.ShowPhysicsOptions">
ShowPhysicsOptions
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show physics options in the UI.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -501,9 +541,9 @@ Class AppConfig
<a id="Hi_HiNcKits_UserConfig_XName_" data-uid="Hi.HiNcKits.AppConfig.XName*"></a>
<a id="Hi_HiNcKits_UserConfig_XName_" data-uid="Hi.HiNcKits.UserConfig.XName*"></a>
<h3 id="Hi_HiNcKits_UserConfig_XName" data-uid="Hi.HiNcKits.AppConfig.XName">
<h3 id="Hi_HiNcKits_UserConfig_XName" data-uid="Hi.HiNcKits.UserConfig.XName">
XName
</h3>
@@ -537,9 +577,9 @@ Class AppConfig
</h2>
<a id="Hi_HiNcKits_UserConfig_MakeXmlSource_" data-uid="Hi.HiNcKits.AppConfig.MakeXmlSource*"></a>
<a id="Hi_HiNcKits_UserConfig_MakeXmlSource_" data-uid="Hi.HiNcKits.UserConfig.MakeXmlSource*"></a>
<h3 id="Hi_HiNcKits_UserConfig_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.HiNcKits.AppConfig.MakeXmlSource(System.String,System.String,System.Boolean)">
<h3 id="Hi_HiNcKits_UserConfig_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.HiNcKits.UserConfig.MakeXmlSource(System.String,System.String,System.Boolean)">
MakeXmlSource(string, string, bool)
</h3>