660 lines
25 KiB
HTML
660 lines
25 KiB
HTML
<!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 class 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 "{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="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 class 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 static 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>
|
|
|
|
|
|
|
|
|
|
<h2 id="Hi_Common_XmlUtils_XFactory_remarks">Remarks</h2>
|
|
<div class="markdown level0 remarks"><p>Generator functions must be added to <a class="xref" href="Hi.Common.XmlUtils.XFactory.html#Hi_Common_XmlUtils_XFactory_Regs">Regs</a> to enable the factory to create objects from XML.</p>
|
|
</div>
|
|
|
|
|
|
<h2 class="section" id="properties">Properties
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Common_XmlUtils_XFactory_Regs_" data-uid="Hi.Common.XmlUtils.XFactory.Regs*"></a>
|
|
|
|
<h3 id="Hi_Common_XmlUtils_XFactory_Regs" data-uid="Hi.Common.XmlUtils.XFactory.Regs">
|
|
Regs
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets or sets the dictionary mapping XML element names to generator functions with relative file path.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Dictionary<string, XFactory.GenByXElementDelegate> Regs { 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.collections.generic.dictionary-2">Dictionary</a><<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.GenByXElementDelegate.html">GenByXElementDelegate</a>></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_Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenByChild``1(System.Xml.Linq.XElement,System.String,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
|
GenByChild<T>(XElement, string, GenMode, params object[])
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Generates an object of type T from a child element of the provided XML element.
|
|
This overload discards the relative file path output.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static T GenByChild<T>(XElement src, string baseDirectory, GenMode genMode, params object[] res) 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><p>The parent XML element containing the child to process</p>
|
|
</dd>
|
|
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>The base directory for resolving paths</p>
|
|
</dd>
|
|
<dt><code>genMode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
|
<dd><p>The generation mode to use</p>
|
|
</dd>
|
|
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
|
<dd><p>Additional parameters for generation</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><span class="xref">T</span></dt>
|
|
<dd><p>The generated object of type T, or null if generation fails</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Type Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>T</code></dt>
|
|
<dd><p>The type of object to generate</p>
|
|
</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__Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenByChild``1(System.Xml.Linq.XElement,System.String,System.String@,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
|
GenByChild<T>(XElement, string, out string, GenMode, params object[])
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Generates an object of type T from a 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<T>(XElement src, string baseDirectory, out string relFile, GenMode genMode, params object[] res) 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><p>The parent XML element containing the child to process</p>
|
|
</dd>
|
|
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>The base directory for resolving paths</p>
|
|
</dd>
|
|
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>Output parameter that receives the relative file path if src is a file reference, or null otherwise</p>
|
|
</dd>
|
|
<dt><code>genMode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
|
<dd><p>The generation mode to use</p>
|
|
</dd>
|
|
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
|
<dd><p>Additional parameters for generation</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><span class="xref">T</span></dt>
|
|
<dd><p>The generated object of type T, or null if generation fails</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Type Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>T</code></dt>
|
|
<dd><p>The type of object to generate</p>
|
|
</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_Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenByFile``1(System.String,System.String,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
|
GenByFile<T>(string, string, GenMode, params 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<T>(string baseDirectory, string relFile, GenMode genMode, params object[] res) 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><p>The base directory for resolving paths</p>
|
|
</dd>
|
|
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>The relative file path to the XML file</p>
|
|
</dd>
|
|
<dt><code>genMode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
|
<dd><p>The generation mode to use</p>
|
|
</dd>
|
|
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
|
<dd><p>Additional parameters for generation</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><span class="xref">T</span></dt>
|
|
<dd><p>The generated object of type T, or null if generation fails</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Type Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>T</code></dt>
|
|
<dd><p>The type of object to generate</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Common_XmlUtils_XFactory_GenXmlFileSourceByChild_" data-uid="Hi.Common.XmlUtils.XFactory.GenXmlFileSourceByChild*"></a>
|
|
|
|
<h3 id="Hi_Common_XmlUtils_XFactory_GenXmlFileSourceByChild__1_System_Xml_Linq_XElement_System_String_Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenXmlFileSourceByChild``1(System.Xml.Linq.XElement,System.String,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
|
GenXmlFileSourceByChild<T>(XElement, string, GenMode, params object[])
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Generates an XML source and file 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 XmlSourceAndFile<T> GenXmlFileSourceByChild<T>(XElement src, string baseDirectory, GenMode genMode, params object[] res) 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><p>The parent XML element containing the child to process</p>
|
|
</dd>
|
|
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>The base directory for resolving paths</p>
|
|
</dd>
|
|
<dt><code>genMode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
|
<dd><p>The generation mode to use</p>
|
|
</dd>
|
|
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
|
<dd><p>Additional parameters for generation</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Common.XmlUtils.XmlSourceAndFile-1.html">XmlSourceAndFile</a><T></dt>
|
|
<dd><p>An XmlSourceAndFile object containing the generated object and its file path</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Type Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>T</code></dt>
|
|
<dd><p>The type of object to generate, must implement IMakeXmlSource</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Common_XmlUtils_XFactory_GenXmlFileSourceByFile_" data-uid="Hi.Common.XmlUtils.XFactory.GenXmlFileSourceByFile*"></a>
|
|
|
|
<h3 id="Hi_Common_XmlUtils_XFactory_GenXmlFileSourceByFile__1_System_String_System_String_Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenXmlFileSourceByFile``1(System.String,System.String,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
|
GenXmlFileSourceByFile<T>(string, string, GenMode, params object[])
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Generates an XML source and file 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 XmlSourceAndFile<T> GenXmlFileSourceByFile<T>(string baseDirectory, string relFile, GenMode genMode, params object[] res) 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><p>The base directory for resolving paths</p>
|
|
</dd>
|
|
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>The relative file path to the XML file</p>
|
|
</dd>
|
|
<dt><code>genMode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
|
<dd><p>The generation mode to use</p>
|
|
</dd>
|
|
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
|
<dd><p>Additional parameters for generation</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Common.XmlUtils.XmlSourceAndFile-1.html">XmlSourceAndFile</a><T></dt>
|
|
<dd><p>An XmlSourceAndFile object containing the generated object and its file path</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Type Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>T</code></dt>
|
|
<dd><p>The type of object to generate, must implement IMakeXmlSource</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Common_XmlUtils_XFactory_GenXmlSourceAndFile_" data-uid="Hi.Common.XmlUtils.XFactory.GenXmlSourceAndFile*"></a>
|
|
|
|
<h3 id="Hi_Common_XmlUtils_XFactory_GenXmlSourceAndFile__1_System_Xml_Linq_XElement_System_String_Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.GenXmlSourceAndFile``1(System.Xml.Linq.XElement,System.String,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
|
GenXmlSourceAndFile<T>(XElement, string, GenMode, params object[])
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Generates an XML source and file object of type T from an XML element.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static XmlSourceAndFile<T> GenXmlSourceAndFile<T>(XElement src, string baseDirectory, GenMode genMode, params object[] res) 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><p>The source XML element</p>
|
|
</dd>
|
|
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>The base directory for resolving paths</p>
|
|
</dd>
|
|
<dt><code>genMode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
|
<dd><p>The generation mode to use</p>
|
|
</dd>
|
|
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
|
<dd><p>Additional parameters for generation</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Common.XmlUtils.XmlSourceAndFile-1.html">XmlSourceAndFile</a><T></dt>
|
|
<dd><p>An XmlSourceAndFile object containing the generated object and its file path</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Type Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>T</code></dt>
|
|
<dd><p>The type of object to generate, must implement IMakeXmlSource</p>
|
|
</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_Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.Gen``1(System.Xml.Linq.XElement,System.String,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
|
Gen<T>(XElement, string, GenMode, params object[])
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Generates an object of type T from an XML element with specified generation mode.
|
|
This overload discards the relative file path output.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static T Gen<T>(XElement src, string baseDirectory, GenMode mode, params object[] res) 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><p>The source XML element</p>
|
|
</dd>
|
|
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>The base directory for resolving paths</p>
|
|
</dd>
|
|
<dt><code>mode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
|
<dd><p>The generation mode to use</p>
|
|
</dd>
|
|
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
|
<dd><p>Additional parameters for generation</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><span class="xref">T</span></dt>
|
|
<dd><p>The generated object of type T, or null if generation fails</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Type Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>T</code></dt>
|
|
<dd><p>The type of object to generate</p>
|
|
</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__Hi_Common_XmlUtils_GenMode_System_Object___" data-uid="Hi.Common.XmlUtils.XFactory.Gen``1(System.Xml.Linq.XElement,System.String,System.String@,Hi.Common.XmlUtils.GenMode,System.Object[])">
|
|
Gen<T>(XElement, string, out string, GenMode, params object[])
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Generates an object of type T from an XML element with specified generation mode.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static T Gen<T>(XElement src, string baseDirectory, out string relFile, GenMode mode, params object[] res) 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><p>The source XML element</p>
|
|
</dd>
|
|
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>The base directory for resolving paths</p>
|
|
</dd>
|
|
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
|
<dd><p>Output parameter that receives the relative file path if src is a file reference, or null otherwise</p>
|
|
</dd>
|
|
<dt><code>mode</code> <a class="xref" href="Hi.Common.XmlUtils.GenMode.html">GenMode</a></dt>
|
|
<dd><p>The generation mode to use</p>
|
|
</dd>
|
|
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
|
<dd><p>Additional parameters for generation</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><span class="xref">T</span></dt>
|
|
<dd><p>The generated object of type T, or null if generation fails</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Type Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>T</code></dt>
|
|
<dd><p>The type of object to generate</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>
|