174 lines
7.7 KiB
HTML
174 lines
7.7 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Message Section on Main Panel | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Message Section on Main Panel | HiAPI-C# 2025 ">
|
|
|
|
|
|
<link rel="icon" href="../../../img/HiAPI.favicon.ico">
|
|
<link rel="stylesheet" href="../../../public/docfx.min.css">
|
|
<link rel="stylesheet" href="../../../public/main.css">
|
|
<meta name="docfx:navrel" content="../../../toc.html">
|
|
<meta name="docfx:tocrel" content="../toc.html">
|
|
|
|
<meta name="docfx:rel" content="../../../">
|
|
|
|
|
|
|
|
<meta name="loc:inThisArticle" content="In this article">
|
|
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
|
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
|
<meta name="loc:tocFilter" content="Filter by title">
|
|
<meta name="loc:nextArticle" content="Next">
|
|
<meta name="loc:prevArticle" content="Previous">
|
|
<meta name="loc:themeLight" content="Light">
|
|
<meta name="loc:themeDark" content="Dark">
|
|
<meta name="loc:themeAuto" content="Auto">
|
|
<meta name="loc:changeTheme" content="Change theme">
|
|
<meta name="loc:copy" content="Copy">
|
|
<meta name="loc:downloadPdf" content="Download PDF">
|
|
|
|
<script type="module" src="./../../../public/docfx.min.js"></script>
|
|
|
|
<script>
|
|
const theme = localStorage.getItem('theme') || 'auto'
|
|
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
|
</script>
|
|
|
|
</head>
|
|
|
|
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
|
<header class="bg-body border-bottom">
|
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
|
<div class="container-xxl flex-nowrap">
|
|
<a class="navbar-brand" href="../../../index.html">
|
|
<img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
|
|
|
|
</a>
|
|
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
|
<i class="bi bi-three-dots"></i>
|
|
</button>
|
|
<div class="collapse navbar-collapse" id="navpanel">
|
|
<div id="navbar">
|
|
<form class="search" role="search" id="search">
|
|
<i class="bi bi-search"></i>
|
|
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="container-xxl">
|
|
<div class="toc-offcanvas">
|
|
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
|
<div class="offcanvas-header">
|
|
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
|
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
|
</div>
|
|
<div class="offcanvas-body">
|
|
<nav class="toc" id="toc"></nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="content">
|
|
<div class="actionbar">
|
|
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
|
<i class="bi bi-list"></i>
|
|
</button>
|
|
|
|
<nav id="breadcrumb"></nav>
|
|
</div>
|
|
|
|
<article data-uid="">
|
|
<h1 id="message-section-on-main-panel">Message Section on Main Panel</h1>
|
|
|
|
<h2 id="initialize--with-message-section">Initialize <a class="xref" href="../../../api/Hi.Common.Messages.MessageKit.html">MessageKit</a>.<a class="xref" href="../../../api/Hi.Common.Messages.MessageKit.html#Hi_Common_Messages_MessageKit_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.MessageKit.html#Hi_Common_Messages_MessageKit_Default">Default</a>.<a class="xref" href="../../../api/Hi.Common.Messages.MessageKit.html#Hi_Common_Messages_MessageKit_OnAdding">OnAdding</a>.</p>
|
|
<p>The event contains:</p>
|
|
<ul>
|
|
<li>update the text content of <code>Brief Message Text Field</code></li>
|
|
<li>Append the message to log file (create if not existed) <code>$"logs/log-{DateTime.Now:yyyy-MM-dd}.txt"</code></li>
|
|
</ul>
|
|
<div class="TIP">
|
|
<h5>Tip</h5>
|
|
<ul>
|
|
<li>Handle the situation that logs over one day.</li>
|
|
<li>Check if passing argument of <a class="xref" href="../../../api/Hi.Common.Messages.MessageKit.html#Hi_Common_Messages_MessageKit_OnAdding">OnAdding</a> 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>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>
|
|
<h2 id="wpf-application-layout">WPF Application Layout</h2>
|
|
<ul>
|
|
<li>Message Section Bottom Bar
|
|
<ul>
|
|
<li>Brief Message Text Field</li>
|
|
<li>Show Log Button</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="TIP">
|
|
<h5>Tip</h5>
|
|
<p>The text field should be selectable to let user easy to copy the message.</p>
|
|
</div>
|
|
<h2 id="web-page-application-layout">Web Page Application Layout</h2>
|
|
<ul>
|
|
<li>Message Section Stacking Toast
|
|
<ul>
|
|
<li>Brief Message Text Field</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p>Enable toast Auto-Hide only if the message level is low.</p>
|
|
<div class="NOTE">
|
|
<h5>Note</h5>
|
|
<p>The convention of web page is not like WPF panel. Use Boostrap or Bootstrap-like toast. They are much appropriate than the fixed bottom bar on WPF.</p>
|
|
</div>
|
|
<h3 id="log-page-layout">Log Page Layout</h3>
|
|
<ul>
|
|
<li>Head Line
|
|
<ul>
|
|
<li>Log Label</li>
|
|
<li>Show Log Button</li>
|
|
<li>Download Log Button</li>
|
|
</ul>
|
|
</li>
|
|
<li>Log TextArea</li>
|
|
</ul>
|
|
<h2 id="behavior-of-show-log-button">Behavior of Show Log Button</h2>
|
|
<p>Call an editor (or reader, bootstrap modal like poping block) to show the current log.</p>
|
|
<div class="TIP">
|
|
<h5>Tip</h5>
|
|
<p>Handle the situation that the current log file does not exist. It may occurs if no message has added.</p>
|
|
</div>
|
|
|
|
</article>
|
|
|
|
<div class="contribution d-print-none">
|
|
</div>
|
|
|
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
|
|
|
</div>
|
|
|
|
<div class="affix">
|
|
<nav id="affix"></nav>
|
|
</div>
|
|
</main>
|
|
|
|
<div class="container-xxl search-results" id="search-results"></div>
|
|
|
|
<footer class="border-top text-secondary">
|
|
<div class="container-xxl">
|
|
<div class="flex-fill">
|
|
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|