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-12-06 02:38:22 +08:00
parent 9de88d2db0
commit 8e6a52be15
28 changed files with 204 additions and 176 deletions
Download Patch File Download Diff File Expand all files Collapse all files
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/general-rules.html
+1 -1
View File
@@ -92,7 +92,7 @@
<p>You MUST read the cited hyperlink before you do the job. ASK if you think the hyperlink is not work.</p>
</div>
<h2 id="handle-message-and-exception">Handle Message and Exception</h2>
<p>If message is well-managed, apply &lt;xref:Hi.Common.Messages.MessageKit&gt; to show the message; if the message is <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a>, apply <a class="xref" href="../../../api/Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a class="xref" href="../../../api/Hi.Common.ExceptionUtil.html#Hi_Common_ExceptionUtil_ShowException_System_Exception_System_Object_">ShowException(Exception, object)</a> to show the exception for detail treatment. The messages are shown in <a href="message-section-on-main-panel.html">Message Section on Main Panel</a>.</p>
<p>If message is well-managed, apply <a class="xref" href="../../../api/Hi.Common.Messages.MessageHost.html">MessageHost</a> to show the message; if the message is <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a>, apply <a class="xref" href="../../../api/Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a class="xref" href="../../../api/Hi.Common.ExceptionUtil.html#Hi_Common_ExceptionUtil_ShowException_System_Exception_System_Object_">ShowException(Exception, object)</a> to show the exception for detail treatment. The messages are shown in <a href="message-section-on-main-panel.html">Message Section on Main Panel</a>.</p>
<p>For examples of message and exception handling patterns:</p>
<ol>
<li>Normal message handling:</li>
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/main-panel.html
+3 -3
View File
@@ -156,11 +156,11 @@ Users can refresh the log content or download the current day's log file for off
<p>The <code>Project</code> Menu Managing <a class="xref" href="../../../api/Hi.MachiningProcs.MachiningProject.html">MachiningProject</a>.</p>
<p>To <code>New</code> (create), <code>Save</code> and <code>Save As</code> the <a class="xref" href="../../../api/Hi.MachiningProcs.MachiningProject.html">MachiningProject</a>, See <a class="xref" href="../../sample/Sample.Machining.DemoBuildGeomOnlyMachiningProject.html">DemoBuildGeomOnlyMachiningProject</a> for the example.</p>
<p>To <code>Load</code> <a class="xref" href="../../../api/Hi.MachiningProcs.MachiningProject.html">MachiningProject</a>, See <a class="xref" href="../../sample/Sample.Machining.DemoUseMachiningProject.html">DemoUseMachiningProject</a> for the example.</p>
<p>Show message for the actions result (successed or has exception) by &lt;xref:Hi.Common.Messages.MessageKit&gt;.</p>
<p>Show message for the actions result (successed or has exception) by <a class="xref" href="../../../api/Hi.Common.Messages.MessageHost.html">MessageHost</a>.</p>
<div class="TIP">
<h5>Tip</h5>
<p>Recommmand using static function of &lt;xref:Hi.Common.Messages.MessageKit&gt; to do the job.
Read document of &lt;xref:Hi.Common.Messages.MessageKit&gt; to ensure the proper usage.</p>
<p>Recommmand using static function of <a class="xref" href="../../../api/Hi.Common.Messages.MessageHost.html">MessageHost</a> to do the job.
Read document of <a class="xref" href="../../../api/Hi.Common.Messages.MessageHost.html">MessageHost</a> to ensure the proper usage.</p>
</div>
<p>On project loaded (<code>Navigation Menu</code>/<code>Project</code>/<code>Load MenuItem</code>)
, set the Player.Panel.RenderingCanvas.DispEngine to <a class="xref" href="../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SetViewToIsometricView">SetViewToIsometricView()</a>.</p>
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/message-section-on-main-panel.html
+3 -3
View File
@@ -87,8 +87,8 @@
<article data-uid="">
<h1 id="message-section-on-main-panel">Message Section on Main Panel</h1>
<h2 id="initialize--with-message-section">Initialize &lt;xref:Hi.Common.Messages.MessageKit&gt;.&lt;xref:Hi.Common.Messages.MessageKit.Default&gt; with Message Section</h2>
<p>To show and save the message on <code>Brief Message Text Field</code>, add event to &lt;xref:Hi.Common.Messages.MessageKit.Default&gt;.&lt;xref:Hi.Common.Messages.MessageKit.OnAdding&gt;.</p>
<h2 id="initialize--with-message-section">Initialize <a class="xref" href="../../../api/Hi.Common.Messages.MessageHost.html">MessageHost</a>.<a class="xref" href="../../../api/Hi.Common.Messages.MessageHost.html#Hi_Common_Messages_MessageHost_Default">Default</a> with Message Section</h2>
<p>To show and save the message on <code>Brief Message Text Field</code>, add event to <a class="xref" href="../../../api/Hi.Common.Messages.MessageHost.html#Hi_Common_Messages_MessageHost_Default">Default</a>.<code>OnAdding</code>.</p>
<p>The event contains:</p>
<ul>
<li>update the text content of <code>Brief Message Text Field</code></li>
@@ -98,7 +98,7 @@
<h5>Tip</h5>
<ul>
<li>Handle the situation that logs over one day.</li>
<li>Check if passing argument of &lt;xref:Hi.Common.Messages.MessageKit.OnAdding&gt; is <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a>. If the it is Exception, update text content by <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a>.<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.message">Message</a> but log to file with the full Exception information.</li>
<li>Check if passing argument of <code>OnAdding</code> event is <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a>. If the it is Exception, update text content by <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.message">Message</a> but log to file with the full Exception information.</li>
<li>Consider <a class="xref" href="../../../api/Hi.Common.Messages.MessageFlag.html">MessageFlag</a> to set the behavior of Message Section. For example, apply alert style if passing argument is exception. The <a class="xref" href="../../../api/Hi.Common.Messages.MessageFlag.html#Hi_Common_Messages_MessageFlag_Info">Info</a> (and the other flags that the priority lower than it) should only record in the logs but not shows in the Message Section.</li>
</ul>
</div>