HiNC-Deploy/HiNC-2025-win-desktop-Deploy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.XFactory.html

706 lines
29 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class XFactory | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class XFactory | HiAPI-C# 2025 ">
<meta name="description" content="Factory for generating objects from XML elements using registered generator functions.">
<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.Common.XmlUtils.XFactory">
<h1 id="Hi_Common_XmlUtils_XFactory" data-uid="Hi.Common.XmlUtils.XFactory" class="text-break">
Class XFactory
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a>.<a class="xref" href="Hi.Common.XmlUtils.html">XmlUtils</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"><p>Factory for generating objects from XML elements using registered generator
functions.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class XFactory</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">XFactory</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>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(TSelf, params object[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
</div>
<div>
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
</div>
<div>
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
</div>
</dd></dl>
<h2 id="Hi_Common_XmlUtils_XFactory_remarks">Remarks</h2>
<div class="markdown level0 remarks"><p>
Each <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a> instance owns its own <a class="xref" href="Hi.Common.XmlUtils.XFactory.html#Hi_Common_XmlUtils_XFactory_Generators">Generators</a>
registry. A process-wide <a class="xref" href="Hi.Common.XmlUtils.XFactory.html#Hi_Common_XmlUtils_XFactory_Default">Default</a> singleton serves the common
case (single shared factory across the simulation pipeline); other instances
can be created for test isolation or parallel pipelines that need disjoint
registries.
</p>
<p>
Types that participate in XML round-trip expose a
<code>public static void Reg(XFactory factory = null)</code> method that adds
themselves (and chains <code>Reg(factory)</code> on dependents) to the given
factory's <a class="xref" href="Hi.Common.XmlUtils.XFactory.html#Hi_Common_XmlUtils_XFactory_Generators">Generators</a>. Boot roots (e.g.
<code>LocalProjectService.Reg()</code>) call the top-level <code>Reg()</code> once at
startup with the default factory.
</p>
<p>
The static <code>Gen&lt;T&gt;</code> / <code>GenByChild&lt;T&gt;</code> /
<code>GenByFile&lt;T&gt;</code> entry points always read from
<a class="xref" href="Hi.Common.XmlUtils.XFactory.html#Hi_Common_XmlUtils_XFactory_Default">Default</a>. Callers that need to deserialize from a custom
factory's registry must look up the delegate via
<code>factory.Generators[xname]</code> directly.
</p>
</div>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Common_XmlUtils_XFactory_Default_" data-uid="Hi.Common.XmlUtils.XFactory.Default*"></a>
<h3 id="Hi_Common_XmlUtils_XFactory_Default" data-uid="Hi.Common.XmlUtils.XFactory.Default">
Default
</h3>
<div class="markdown level1 summary"><p>Process-wide default factory used by the static <code>Gen&lt;T&gt;</code>
family. <code>Reg</code>-style methods register here when called with
no explicit factory argument.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static XFactory Default { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a></dt>
<dd></dd>
</dl>
<a id="Hi_Common_XmlUtils_XFactory_Generators_" data-uid="Hi.Common.XmlUtils.XFactory.Generators*"></a>
<h3 id="Hi_Common_XmlUtils_XFactory_Generators" data-uid="Hi.Common.XmlUtils.XFactory.Generators">
Generators
</h3>
<div class="markdown level1 summary"><p>XML-name → generator-function map for this factory instance. Populated
by each type's <code>Reg(this)</code> call.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;string, XFactory.XGeneratorDelegate&gt; Generators { 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.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a>.<a class="xref" href="Hi.Common.XmlUtils.XFactory.XGeneratorDelegate.html">XGeneratorDelegate</a>&gt;</dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Common_XmlUtils_XFactory_GenByChild_" data-uid="Hi.Common.XmlUtils.XFactory.GenByChild*"></a>
<h3 id="Hi_Common_XmlUtils_XFactory_GenByChild__1_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenByChild``1(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Boolean,System.Object[])">
GenByChild&lt;T&gt;(XElement, string, IProgress&lt;object&gt;, bool, object[])
</h3>
<div class="markdown level1 summary"><p>Generates an object of type T from the first child element (discards relative file path).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static T GenByChild&lt;T&gt;(XElement src, string baseDirectory, IProgress&lt;object&gt; progress, bool enableRebase = true, object[] res = null) where T : class</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd></dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd></dd>
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">T</span></dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd></dd>
</dl>
<a id="Hi_Common_XmlUtils_XFactory_GenByChild_" data-uid="Hi.Common.XmlUtils.XFactory.GenByChild*"></a>
<h3 id="Hi_Common_XmlUtils_XFactory_GenByChild__1_System_Xml_Linq_XElement_System_String_System_String__System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenByChild``1(System.Xml.Linq.XElement,System.String,System.String@,System.IProgress{System.Object},System.Boolean,System.Object[])">
GenByChild&lt;T&gt;(XElement, string, out string, IProgress&lt;object&gt;, bool, object[])
</h3>
<div class="markdown level1 summary"><p>Generates an object of type T from the first child element of the provided XML element.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static T GenByChild&lt;T&gt;(XElement src, string baseDirectory, out string relFile, IProgress&lt;object&gt; progress, bool enableRebase = true, object[] res = null) where T : class</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd></dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd></dd>
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">T</span></dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd></dd>
</dl>
<a id="Hi_Common_XmlUtils_XFactory_GenByFile_" data-uid="Hi.Common.XmlUtils.XFactory.GenByFile*"></a>
<h3 id="Hi_Common_XmlUtils_XFactory_GenByFile__1_System_String_System_String_System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenByFile``1(System.String,System.String,System.IProgress{System.Object},System.Boolean,System.Object[])">
GenByFile&lt;T&gt;(string, string, IProgress&lt;object&gt;, bool, object[])
</h3>
<div class="markdown level1 summary"><p>Generates an object of type T from an XML file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static T GenByFile&lt;T&gt;(string baseDirectory, string relFile, IProgress&lt;object&gt; progress, bool enableRebase = true, object[] res = null) where T : class</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd></dd>
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">T</span></dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd></dd>
</dl>
<a id="Hi_Common_XmlUtils_XFactory_GenFileRefSourceByChild_" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSourceByChild*"></a>
<h3 id="Hi_Common_XmlUtils_XFactory_GenFileRefSourceByChild__1_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSourceByChild``1(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Boolean,System.Object[])">
GenFileRefSourceByChild&lt;T&gt;(XElement, string, IProgress&lt;object&gt;, bool, object[])
</h3>
<div class="markdown level1 summary"><p>Generates a <a class="xref" href="Hi.Common.XmlUtils.FileRefSource-1.html">FileRefSource&lt;T&gt;</a> from the first child element.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static FileRefSource&lt;T&gt; GenFileRefSourceByChild&lt;T&gt;(XElement src, string baseDirectory, IProgress&lt;object&gt; progress, bool enableRebase = true, object[] res = null) where T : class, IMakeXmlSource</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd></dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd></dd>
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.XmlUtils.FileRefSource-1.html">FileRefSource</a>&lt;T&gt;</dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd></dd>
</dl>
<a id="Hi_Common_XmlUtils_XFactory_GenFileRefSourceByFile_" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSourceByFile*"></a>
<h3 id="Hi_Common_XmlUtils_XFactory_GenFileRefSourceByFile__1_System_String_System_String_System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSourceByFile``1(System.String,System.String,System.IProgress{System.Object},System.Boolean,System.Object[])">
GenFileRefSourceByFile&lt;T&gt;(string, string, IProgress&lt;object&gt;, bool, object[])
</h3>
<div class="markdown level1 summary"><p>Generates a <a class="xref" href="Hi.Common.XmlUtils.FileRefSource-1.html">FileRefSource&lt;T&gt;</a> from an XML file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static FileRefSource&lt;T&gt; GenFileRefSourceByFile&lt;T&gt;(string baseDirectory, string relFile, IProgress&lt;object&gt; progress, bool enableRebase = true, object[] res = null) where T : class, IMakeXmlSource</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd></dd>
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.XmlUtils.FileRefSource-1.html">FileRefSource</a>&lt;T&gt;</dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd></dd>
</dl>
<a id="Hi_Common_XmlUtils_XFactory_GenFileRefSource_" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSource*"></a>
<h3 id="Hi_Common_XmlUtils_XFactory_GenFileRefSource__1_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenFileRefSource``1(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Boolean,System.Object[])">
GenFileRefSource&lt;T&gt;(XElement, string, IProgress&lt;object&gt;, bool, object[])
</h3>
<div class="markdown level1 summary"><p>Generates a <a class="xref" href="Hi.Common.XmlUtils.FileRefSource-1.html">FileRefSource&lt;T&gt;</a> from an XML element.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static FileRefSource&lt;T&gt; GenFileRefSource&lt;T&gt;(XElement src, string baseDirectory, IProgress&lt;object&gt; progress, bool enableRebase = true, object[] res = null) where T : class, IMakeXmlSource</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd></dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd></dd>
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.XmlUtils.FileRefSource-1.html">FileRefSource</a>&lt;T&gt;</dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd></dd>
</dl>
<a id="Hi_Common_XmlUtils_XFactory_Gen_" data-uid="Hi.Common.XmlUtils.XFactory.Gen*"></a>
<h3 id="Hi_Common_XmlUtils_XFactory_Gen__1_System_Xml_Linq_XElement_System_String_System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.Gen``1(System.Xml.Linq.XElement,System.String,System.IProgress{System.Object},System.Boolean,System.Object[])">
Gen&lt;T&gt;(XElement, string, IProgress&lt;object&gt;, bool, object[])
</h3>
<div class="markdown level1 summary"><p>Generates an object of type T from an XML element (discards relative file path).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static T Gen&lt;T&gt;(XElement src, string baseDirectory, IProgress&lt;object&gt; progress, bool enableRebase = true, object[] res = null) where T : class</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd></dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd></dd>
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">T</span></dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd></dd>
</dl>
<a id="Hi_Common_XmlUtils_XFactory_Gen_" data-uid="Hi.Common.XmlUtils.XFactory.Gen*"></a>
<h3 id="Hi_Common_XmlUtils_XFactory_Gen__1_System_Xml_Linq_XElement_System_String_System_String__System_IProgress_System_Object__System_Boolean_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.Gen``1(System.Xml.Linq.XElement,System.String,System.String@,System.IProgress{System.Object},System.Boolean,System.Object[])">
Gen&lt;T&gt;(XElement, string, out string, IProgress&lt;object&gt;, bool, object[])
</h3>
<div class="markdown level1 summary"><p>Generates an object of type T from an XML element using <a class="xref" href="Hi.Common.XmlUtils.XFactory.html#Hi_Common_XmlUtils_XFactory_Default">Default</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static T Gen&lt;T&gt;(XElement src, string baseDirectory, out string relFile, IProgress&lt;object&gt; progress, bool enableRebase = true, object[] res = null) where T : class</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd></dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>progress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd></dd>
<dt><code>enableRebase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">T</span></dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd></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>
Reference in New Issue View Git Blame Copy Permalink