HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.WpfPlus.Disp.WpfDispUtil.html
2026-02-17 15:51:23 +08:00

332 lines
11 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class WpfDispUtil | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class WpfDispUtil | HiAPI-C# 2025 ">
<meta name="description" content="Registers WPF as the display framework for , supporting multiple windows identified by key.">
<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 &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<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="ManagedReference">
<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="Hi.WpfPlus.Disp.WpfDispUtil">
<h1 id="Hi_WpfPlus_Disp_WpfDispUtil" data-uid="Hi.WpfPlus.Disp.WpfDispUtil" class="text-break">
Class WpfDispUtil
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.WpfPlus.html">WpfPlus</a>.<a class="xref" href="Hi.WpfPlus.Disp.html">Disp</a></dd></dl>
<dl><dt>Assembly</dt><dd>Hi.WpfPlus.dll</dd></dl>
</div>
<div class="markdown summary"><p>Registers WPF as the display framework for <a class="xref" href="Hi.Disp.DispFrameUtil.html">DispFrameUtil</a>,
supporting multiple windows identified by key.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class WpfDispUtil</code></pre>
</div>
<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">WpfDispUtil</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<h2 id="Hi_WpfPlus_Disp_WpfDispUtil_remarks">Remarks</h2>
<div class="markdown level0 remarks"><p>
Usage pattern: call <a class="xref" href="Hi.Disp.DispFrameUtil.html#Hi_Disp_DispFrameUtil_Call_System_String_Hi_Disp_IDisplayee___">Call(string, params IDisplayee[])</a> to queue display content,
then call <a class="xref" href="Hi.WpfPlus.Disp.WpfDispUtil.html#Hi_WpfPlus_Disp_WpfDispUtil_RunApplication">RunApplication()</a> to start the WPF application and show windows.
</p>
<p>
Each unique key creates a separate <a class="xref" href="Hi.WpfPlus.Disp.RenderingWindow.html">RenderingWindow</a>.
Calling <a class="xref" href="Hi.Disp.DispFrameUtil.html#Hi_Disp_DispFrameUtil_Call_System_String_Hi_Disp_IDisplayee___">Call(string, params IDisplayee[])</a> with the same key updates the existing window.
</p>
<example>
<pre><code class="lang-csharp">// Queue display content (before or after Run)
DispFrameUtil.CallDispFrame("Window1", displayee1);
DispFrameUtil.CallDispFrame("Window2", displayee2);
// Start the WPF application (blocks until all windows are closed)
DispFrameWpf.Run();</code></pre>
</example>
</div>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_WpfPlus_Disp_WpfDispUtil_Call_" data-uid="Hi.WpfPlus.Disp.WpfDispUtil.Call*"></a>
<h3 id="Hi_WpfPlus_Disp_WpfDispUtil_Call_System_String_Hi_Disp_IDisplayee___" data-uid="Hi.WpfPlus.Disp.WpfDispUtil.Call(System.String,Hi.Disp.IDisplayee[])">
Call(string, params IDisplayee[])
</h3>
<div class="markdown level1 summary"><p>Configures the display engine with the specified displayees for the given title.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static DispEngineConfig Call(string title, params IDisplayee[] displayees)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>title</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The title/key to identify the display window.</p>
</dd>
<dt><code>displayees</code> <a class="xref" href="Hi.Disp.IDisplayee.html">IDisplayee</a>[]</dt>
<dd><p>The displayees to be configured.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Disp.DispEngineConfig.html">DispEngineConfig</a></dt>
<dd><p>The display engine configuration.</p>
</dd>
</dl>
<a id="Hi_WpfPlus_Disp_WpfDispUtil_Init_" data-uid="Hi.WpfPlus.Disp.WpfDispUtil.Init*"></a>
<h3 id="Hi_WpfPlus_Disp_WpfDispUtil_Init" data-uid="Hi.WpfPlus.Disp.WpfDispUtil.Init">
Init()
</h3>
<div class="markdown level1 summary"><p>Initializes the display engine.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Init()</code></pre>
</div>
<a id="Hi_WpfPlus_Disp_WpfDispUtil_RunApplication_" data-uid="Hi.WpfPlus.Disp.WpfDispUtil.RunApplication*"></a>
<h3 id="Hi_WpfPlus_Disp_WpfDispUtil_RunApplication" data-uid="Hi.WpfPlus.Disp.WpfDispUtil.RunApplication">
RunApplication()
</h3>
<div class="markdown level1 summary"><p>Starts the WPF application and shows all configured windows.
Blocks until all windows are closed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void RunApplication()</code></pre>
</div>
<a id="Hi_WpfPlus_Disp_WpfDispUtil_RunApplication_" data-uid="Hi.WpfPlus.Disp.WpfDispUtil.RunApplication*"></a>
<h3 id="Hi_WpfPlus_Disp_WpfDispUtil_RunApplication_System_String_Hi_Disp_IDisplayee___" data-uid="Hi.WpfPlus.Disp.WpfDispUtil.RunApplication(System.String,Hi.Disp.IDisplayee[])">
RunApplication(string, params IDisplayee[])
</h3>
<div class="markdown level1 summary"><p>Configures the display engine with the specified displayees and starts the WPF application.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void RunApplication(string title, params IDisplayee[] displayees)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>title</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The title/key to identify the display window.</p>
</dd>
<dt><code>displayees</code> <a class="xref" href="Hi.Disp.IDisplayee.html">IDisplayee</a>[]</dt>
<dd><p>The displayees to be configured.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
</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>