HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundSelector.html
2025-07-18 15:38:28 +08:00

668 lines
21 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class BoundSelector | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class BoundSelector | HiAPI-C# 2025 ">
<meta name="description" content="Mark on source command line for managing step.">
<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.Numerical.StepSelectionUtils.BoundSelector">
<h1 id="Hi_Numerical_StepSelectionUtils_BoundSelector" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector" class="text-break">
Class BoundSelector
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Numerical.html">Numerical</a>.<a class="xref" href="Hi.Numerical.StepSelectionUtils.html">StepSelectionUtils</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Mark on source command line for managing step.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class BoundSelector : IFileLineIndex, IGetFileLineIndex, IMakeXmlSource</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">BoundSelector</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.Common.FileLines.IFileLineIndex.html">IFileLineIndex</a></div>
<div><a class="xref" href="Hi.Common.FileLines.IGetFileLineIndex.html">IGetFileLineIndex</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></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 class="section" id="constructors">Constructors
</h2>
<a id="Hi_Numerical_StepSelectionUtils_BoundSelector__ctor_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.#ctor*"></a>
<h3 id="Hi_Numerical_StepSelectionUtils_BoundSelector__ctor_Hi_Numerical_StepSelectionUtils_BoundAnchorMode_Hi_Numerical_StepSelectionUtils_IStepShift_Hi_Common_FileLines_FileLineIndex_System_Int32_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.#ctor(Hi.Numerical.StepSelectionUtils.BoundAnchorMode,Hi.Numerical.StepSelectionUtils.IStepShift,Hi.Common.FileLines.FileLineIndex,System.Int32)">
BoundSelector(BoundAnchorMode, IStepShift, FileLineIndex, int)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Numerical.StepSelectionUtils.BoundSelector.html">BoundSelector</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BoundSelector(BoundAnchorMode anchorMode, IStepShift shift, FileLineIndex fileLineIndex, int boundStepIndex)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>anchorMode</code> <a class="xref" href="Hi.Numerical.StepSelectionUtils.BoundAnchorMode.html">BoundAnchorMode</a></dt>
<dd><p>The anchor mode for the bound.</p>
</dd>
<dt><code>shift</code> <a class="xref" href="Hi.Numerical.StepSelectionUtils.IStepShift.html">IStepShift</a></dt>
<dd><p>The step shift to apply.</p>
</dd>
<dt><code>fileLineIndex</code> <a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a></dt>
<dd><p>The file line index.</p>
</dd>
<dt><code>boundStepIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The step index at the boundary.</p>
</dd>
</dl>
<a id="Hi_Numerical_StepSelectionUtils_BoundSelector__ctor_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.#ctor*"></a>
<h3 id="Hi_Numerical_StepSelectionUtils_BoundSelector__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.#ctor(System.Xml.Linq.XElement,System.String)">
BoundSelector(XElement, string)
</h3>
<div class="markdown level1 summary"><p>Ctor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BoundSelector(XElement src, string baseDirectory)</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>XML source element</p>
</dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Base directory for resolving relative paths</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Numerical_StepSelectionUtils_BoundSelector_BoundStepIndex_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.BoundStepIndex*"></a>
<h3 id="Hi_Numerical_StepSelectionUtils_BoundSelector_BoundStepIndex" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.BoundStepIndex">
BoundStepIndex
</h3>
<div class="markdown level1 summary"><p>If locale on begin, the step index should be the first step of the line;
if locale on end, the step index should be the last step of the line.
i.e. the index is inclusive.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int BoundStepIndex { 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.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_StepSelectionUtils_BoundSelector_FileIndex_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.FileIndex*"></a>
<h3 id="Hi_Numerical_StepSelectionUtils_BoundSelector_FileIndex" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.FileIndex">
FileIndex
</h3>
<div class="markdown level1 summary"><p>File Index.
Start on 0.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int FileIndex { 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.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_StepSelectionUtils_BoundSelector_FileLineIndex_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.FileLineIndex*"></a>
<h3 id="Hi_Numerical_StepSelectionUtils_BoundSelector_FileLineIndex" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.FileLineIndex">
FileLineIndex
</h3>
<div class="markdown level1 summary"><p>Gets or sets the file line index.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FileLineIndex FileLineIndex { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_StepSelectionUtils_BoundSelector_FileNo_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.FileNo*"></a>
<h3 id="Hi_Numerical_StepSelectionUtils_BoundSelector_FileNo" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.FileNo">
FileNo
</h3>
<div class="markdown level1 summary"><p>Gets or sets the file number.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int FileNo { 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.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_StepSelectionUtils_BoundSelector_KeyAnchorMode_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.KeyAnchorMode*"></a>
<h3 id="Hi_Numerical_StepSelectionUtils_BoundSelector_KeyAnchorMode" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.KeyAnchorMode">
KeyAnchorMode
</h3>
<div class="markdown level1 summary"><p>Gets or sets the key anchor mode that determines how the boundary is anchored.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BoundAnchorMode KeyAnchorMode { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.StepSelectionUtils.BoundAnchorMode.html">BoundAnchorMode</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_StepSelectionUtils_BoundSelector_LineIndex_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.LineIndex*"></a>
<h3 id="Hi_Numerical_StepSelectionUtils_BoundSelector_LineIndex" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.LineIndex">
LineIndex
</h3>
<div class="markdown level1 summary"><p>Line Index.
Start on 0.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int LineIndex { 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.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_StepSelectionUtils_BoundSelector_LineNo_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.LineNo*"></a>
<h3 id="Hi_Numerical_StepSelectionUtils_BoundSelector_LineNo" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.LineNo">
LineNo
</h3>
<div class="markdown level1 summary"><p>Gets or sets the line number.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int LineNo { 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.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_StepSelectionUtils_BoundSelector_Shift_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.Shift*"></a>
<h3 id="Hi_Numerical_StepSelectionUtils_BoundSelector_Shift" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.Shift">
Shift
</h3>
<div class="markdown level1 summary"><p>Gets or sets the shift to apply to the step index.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IStepShift Shift { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Numerical.StepSelectionUtils.IStepShift.html">IStepShift</a></dt>
<dd></dd>
</dl>
<a id="Hi_Numerical_StepSelectionUtils_BoundSelector_XName_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.XName*"></a>
<h3 id="Hi_Numerical_StepSelectionUtils_BoundSelector_XName" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.XName">
XName
</h3>
<div class="markdown level1 summary"><p>Name for XML IO.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string XName { 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.string">string</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Numerical_StepSelectionUtils_BoundSelector_GetFileLineIndex_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.GetFileLineIndex*"></a>
<h3 id="Hi_Numerical_StepSelectionUtils_BoundSelector_GetFileLineIndex" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.GetFileLineIndex">
GetFileLineIndex()
</h3>
<div class="markdown level1 summary"><p>Get <a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FileLineIndex GetFileLineIndex()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a></dt>
<dd><p><a class="xref" href="Hi.Common.FileLines.FileLineIndex.html">FileLineIndex</a></p>
</dd>
</dl>
<a id="Hi_Numerical_StepSelectionUtils_BoundSelector_MakeXmlSource_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.MakeXmlSource*"></a>
<h3 id="Hi_Numerical_StepSelectionUtils_BoundSelector_MakeXmlSource_System_String_System_String_" data-uid="Hi.Numerical.StepSelectionUtils.BoundSelector.MakeXmlSource(System.String,System.String)">
MakeXmlSource(string, string)
</h3>
<div class="markdown level1 summary"><p>Creates an XML representation of the object.
This method may also generate additional resources such as related files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile)</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 relative 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 for the XML source</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>An XML element representing the object's state</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>