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.FileLines.FileLineIndex.html
iamboss 4556281c0a tune
2025-12-22 23:35:40 +08:00

825 lines
26 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class FileLineIndex | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class FileLineIndex | HiAPI-C# 2025 ">
<meta name="description" content="Represents a location in a file by its file index and line number.">
<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.FileLines.FileLineIndex">
<h1 id="Hi_Common_FileLines_FileLineIndex" data-uid="Hi.Common.FileLines.FileLineIndex" class="text-break">
Class FileLineIndex
</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.FileLines.html">FileLines</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"><p>Represents a location in a file by its file index and line number.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class FileLineIndex : IFileLineIndex, IGetFileLineIndex, IComparable&lt;IFileLineIndex&gt;, IMakeXmlSource, IToXElement</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">FileLineIndex</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="https://learn.microsoft.com/dotnet/api/system.icomparable-1">IComparable</a>&lt;<a class="xref" href="Hi.Common.FileLines.IFileLineIndex.html">IFileLineIndex</a>&gt;</div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IToXElement.html">IToXElement</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-system-object)">object.Equals(object, object)</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>
</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.Geom.MathUtil.html#Hi_Geom_MathUtil_Clamp__1___0___0___0_">MathUtil.Clamp&lt;T&gt;(T, T, T)</a>
</div>
<div>
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_GetFileNo_Hi_Common_FileLines_IFileLineIndex_">FileLineUtil.GetFileNo(IFileLineIndex)</a>
</div>
<div>
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_GetLineNo_Hi_Common_FileLines_IFileLineIndex_">FileLineUtil.GetLineNo(IFileLineIndex)</a>
</div>
<div>
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_MixedIndex_Hi_Common_FileLines_IFileLineIndex_">FileLineUtil.MixedIndex(IFileLineIndex)</a>
</div>
<div>
<a class="xref" href="Hi.Common.FileLines.FileLineUtil.html#Hi_Common_FileLines_FileLineUtil_MixedIndex_Hi_Common_FileLines_IGetFileLineIndex_">FileLineUtil.MixedIndex(IGetFileLineIndex)</a>
</div>
<div>
<a class="xref" href="Hi.Common.XmlUtils.XmlUtil.html#Hi_Common_XmlUtils_XmlUtil_MakeXmlSourceFile_Hi_Common_XmlUtils_IMakeXmlSource_System_String_System_Boolean_">XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Common.XmlUtils.XmlUtil.html#Hi_Common_XmlUtils_XmlUtil_MakeXmlSourceWithRebaseFile_Hi_Common_XmlUtils_IMakeXmlSource_System_String_System_String_System_Boolean_">XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Common.XmlUtils.XmlUtil.html#Hi_Common_XmlUtils_XmlUtil_SaveToByteArrayAsync_Hi_Common_XmlUtils_IMakeXmlSource_System_String_">XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string)</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_Common_FileLines_FileLineIndex__ctor_" data-uid="Hi.Common.FileLines.FileLineIndex.#ctor*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex__ctor" data-uid="Hi.Common.FileLines.FileLineIndex.#ctor">
FileLineIndex()
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the FileLineIndex class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FileLineIndex()</code></pre>
</div>
<a id="Hi_Common_FileLines_FileLineIndex__ctor_" data-uid="Hi.Common.FileLines.FileLineIndex.#ctor*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex__ctor_Hi_Common_FileLines_IFileLineIndex_" data-uid="Hi.Common.FileLines.FileLineIndex.#ctor(Hi.Common.FileLines.IFileLineIndex)">
FileLineIndex(IFileLineIndex)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the FileLineIndex class by copying another instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FileLineIndex(IFileLineIndex src)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="Hi.Common.FileLines.IFileLineIndex.html">IFileLineIndex</a></dt>
<dd><p>The source FileLineIndex to copy from</p>
</dd>
</dl>
<a id="Hi_Common_FileLines_FileLineIndex__ctor_" data-uid="Hi.Common.FileLines.FileLineIndex.#ctor*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex__ctor_System_Int32_System_Int32_" data-uid="Hi.Common.FileLines.FileLineIndex.#ctor(System.Int32,System.Int32)">
FileLineIndex(int, int)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the FileLineIndex class with specified indices.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FileLineIndex(int fileIndex, int lineIndex)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>fileIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The zero-based file index</p>
</dd>
<dt><code>lineIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The zero-based line index</p>
</dd>
</dl>
<a id="Hi_Common_FileLines_FileLineIndex__ctor_" data-uid="Hi.Common.FileLines.FileLineIndex.#ctor*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex__ctor_System_Xml_Linq_XElement_" data-uid="Hi.Common.FileLines.FileLineIndex.#ctor(System.Xml.Linq.XElement)">
FileLineIndex(XElement)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the FileLineIndex class from an XML element.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FileLineIndex(XElement src)</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 XML element containing the file and line indices</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Common_FileLines_FileLineIndex_FileIndex_" data-uid="Hi.Common.FileLines.FileLineIndex.FileIndex*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex_FileIndex" data-uid="Hi.Common.FileLines.FileLineIndex.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_Common_FileLines_FileLineIndex_FileNo_" data-uid="Hi.Common.FileLines.FileLineIndex.FileNo*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex_FileNo" data-uid="Hi.Common.FileLines.FileLineIndex.FileNo">
FileNo
</h3>
<div class="markdown level1 summary"><p>Gets or sets the one-based file number (FileIndex + 1)</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_Common_FileLines_FileLineIndex_LineIndex_" data-uid="Hi.Common.FileLines.FileLineIndex.LineIndex*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex_LineIndex" data-uid="Hi.Common.FileLines.FileLineIndex.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_Common_FileLines_FileLineIndex_LineNo_" data-uid="Hi.Common.FileLines.FileLineIndex.LineNo*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex_LineNo" data-uid="Hi.Common.FileLines.FileLineIndex.LineNo">
LineNo
</h3>
<div class="markdown level1 summary"><p>Gets or sets the one-based line number (LineIndex + 1)</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_Common_FileLines_FileLineIndex_XName_" data-uid="Hi.Common.FileLines.FileLineIndex.XName*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex_XName" data-uid="Hi.Common.FileLines.FileLineIndex.XName">
XName
</h3>
<div class="markdown level1 summary"><p>Gets the XML element name used for serialization.</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_Common_FileLines_FileLineIndex_CompareTo_" data-uid="Hi.Common.FileLines.FileLineIndex.CompareTo*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex_CompareTo_Hi_Common_FileLines_IFileLineIndex_" data-uid="Hi.Common.FileLines.FileLineIndex.CompareTo(Hi.Common.FileLines.IFileLineIndex)">
CompareTo(IFileLineIndex)
</h3>
<div class="markdown level1 summary"><p>Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int CompareTo(IFileLineIndex other)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>other</code> <a class="xref" href="Hi.Common.FileLines.IFileLineIndex.html">IFileLineIndex</a></dt>
<dd><p>An object to compare with this instance.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>A value that indicates the relative order of the objects being compared. The return value has these meanings:</p>
<table><thead><tr><th class="term"> Value</th><th class="description"> Meaning</th></tr></thead><tbody><tr><td class="term"> Less than zero</td><td class="description"> This instance precedes <code class="paramref">other</code> in the sort order.</td></tr><tr><td class="term"> Zero</td><td class="description"> This instance occurs in the same position in the sort order as <code class="paramref">other</code>.</td></tr><tr><td class="term"> Greater than zero</td><td class="description"> This instance follows <code class="paramref">other</code> in the sort order.</td></tr></tbody></table>
</dd>
</dl>
<a id="Hi_Common_FileLines_FileLineIndex_Equals_" data-uid="Hi.Common.FileLines.FileLineIndex.Equals*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex_Equals_System_Object_" data-uid="Hi.Common.FileLines.FileLineIndex.Equals(System.Object)">
Equals(object)
</h3>
<div class="markdown level1 summary"><p>Determines whether the specified object is equal to the current object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool Equals(object obj)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>The object to compare with the current object.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the specified object is equal to the current object; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
</dl>
<a id="Hi_Common_FileLines_FileLineIndex_GetFileLineIndex_" data-uid="Hi.Common.FileLines.FileLineIndex.GetFileLineIndex*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex_GetFileLineIndex" data-uid="Hi.Common.FileLines.FileLineIndex.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_Common_FileLines_FileLineIndex_GetHashCode_" data-uid="Hi.Common.FileLines.FileLineIndex.GetHashCode*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex_GetHashCode" data-uid="Hi.Common.FileLines.FileLineIndex.GetHashCode">
GetHashCode()
</h3>
<div class="markdown level1 summary"><p>Serves as the default hash function.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>A hash code for the current object.</p>
</dd>
</dl>
<a id="Hi_Common_FileLines_FileLineIndex_MakeXmlSource_" data-uid="Hi.Common.FileLines.FileLineIndex.MakeXmlSource*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.Common.FileLines.FileLineIndex.MakeXmlSource(System.String,System.String,System.Boolean)">
MakeXmlSource(string, string, bool)
</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, bool exhibitionOnly)</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>
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>if true, the extended file creation is suppressed.</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>
<h4 class="section" id="Hi_Common_FileLines_FileLineIndex_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
Since the folder can be moving with the configuration file.</p>
</div>
<a id="Hi_Common_FileLines_FileLineIndex_ToString_" data-uid="Hi.Common.FileLines.FileLineIndex.ToString*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex_ToString" data-uid="Hi.Common.FileLines.FileLineIndex.ToString">
ToString()
</h3>
<div class="markdown level1 summary"><p>Returns a string that represents the current object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>A string that represents the current object.</p>
</dd>
</dl>
<a id="Hi_Common_FileLines_FileLineIndex_ToUserString_" data-uid="Hi.Common.FileLines.FileLineIndex.ToUserString*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex_ToUserString" data-uid="Hi.Common.FileLines.FileLineIndex.ToUserString">
ToUserString()
</h3>
<div class="markdown level1 summary"><p>Returns a user-friendly string representation of the file and line numbers.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ToUserString()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>A string in the format &ldquo;(FileNo:X,LineNo:Y)&rdquo;</p>
</dd>
</dl>
<a id="Hi_Common_FileLines_FileLineIndex_ToXElement_" data-uid="Hi.Common.FileLines.FileLineIndex.ToXElement*"></a>
<h3 id="Hi_Common_FileLines_FileLineIndex_ToXElement" data-uid="Hi.Common.FileLines.FileLineIndex.ToXElement">
ToXElement()
</h3>
<div class="markdown level1 summary"><p>Converts the current instance to an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public XElement ToXElement()</code></pre>
</div>
<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 <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a> representing this index.</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>
Reference in New Issue View Git Blame Copy Permalink