Apq
/
Apq.Cfg
mirror of https://gitee.com/apq/Apq.Cfg.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
							<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
      <title>Class RequiredRule | Apq.Cfg API </title>
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <meta name="title" content="Class RequiredRule | Apq.Cfg API ">
      
      <meta name="description" content="必填验证规则">
      <link rel="icon" href="../favicon.svg">
      <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="../images/logo-small.svg" alt="Apq.Cfg">
            Apq.Cfg
          </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="Apq.Cfg.Validation.Rules.RequiredRule">


  <h1 id="Apq_Cfg_Validation_Rules_RequiredRule" data-uid="Apq.Cfg.Validation.Rules.RequiredRule" class="text-break">
Class RequiredRule  
  </h1>

  <div class="facts text-secondary">
    <dl><dt>Namespace</dt><dd><a class="xref" href="Apq.html">Apq</a>.<a class="xref" href="Apq.Cfg.html">Cfg</a>.<a class="xref" href="Apq.Cfg.Validation.html">Validation</a>.<a class="xref" href="Apq.Cfg.Validation.Rules.html">Rules</a></dd></dl>
  <dl><dt>Assembly</dt><dd>Apq.Cfg.dll</dd></dl>
  </div>

  <div class="markdown summary"><p>必填验证规则</p>
</div>
  <div class="markdown conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public sealed class RequiredRule : IValidationRule</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">RequiredRule</span></div>
    </dd>
  </dl>

  <dl class="typelist implements">
    <dt>Implements</dt>
    <dd>
      <div><a class="xref" href="Apq.Cfg.Validation.IValidationRule.html">IValidationRule</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.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 class="section" id="constructors">Constructors
</h2>


  <a id="Apq_Cfg_Validation_Rules_RequiredRule__ctor_" data-uid="Apq.Cfg.Validation.Rules.RequiredRule.#ctor*"></a>

  <h3 id="Apq_Cfg_Validation_Rules_RequiredRule__ctor_System_String_System_String_" data-uid="Apq.Cfg.Validation.Rules.RequiredRule.#ctor(System.String,System.String)">
  RequiredRule(string, string?)
  
  </h3>

  <div class="markdown level1 summary"><p>创建必填验证规则</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public RequiredRule(string key, string? errorMessage = null)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
    <dd><p>配置键</p>
</dd>
    <dt><code>errorMessage</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
    <dd><p>自定义错误消息</p>
</dd>
  </dl>


  <h2 class="section" id="properties">Properties
</h2>


  <a id="Apq_Cfg_Validation_Rules_RequiredRule_ErrorMessage_" data-uid="Apq.Cfg.Validation.Rules.RequiredRule.ErrorMessage*"></a>

  <h3 id="Apq_Cfg_Validation_Rules_RequiredRule_ErrorMessage" data-uid="Apq.Cfg.Validation.Rules.RequiredRule.ErrorMessage">
  ErrorMessage
  
  </h3>

  <div class="markdown level1 summary"><p>自定义错误消息</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string? ErrorMessage { 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>


  <a id="Apq_Cfg_Validation_Rules_RequiredRule_Key_" data-uid="Apq.Cfg.Validation.Rules.RequiredRule.Key*"></a>

  <h3 id="Apq_Cfg_Validation_Rules_RequiredRule_Key" data-uid="Apq.Cfg.Validation.Rules.RequiredRule.Key">
  Key
  
  </h3>

  <div class="markdown level1 summary"><p>要验证的配置键</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string Key { 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>


  <a id="Apq_Cfg_Validation_Rules_RequiredRule_Name_" data-uid="Apq.Cfg.Validation.Rules.RequiredRule.Name*"></a>

  <h3 id="Apq_Cfg_Validation_Rules_RequiredRule_Name" data-uid="Apq.Cfg.Validation.Rules.RequiredRule.Name">
  Name
  
  </h3>

  <div class="markdown level1 summary"><p>规则名称</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string Name { 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="Apq_Cfg_Validation_Rules_RequiredRule_Validate_" data-uid="Apq.Cfg.Validation.Rules.RequiredRule.Validate*"></a>

  <h3 id="Apq_Cfg_Validation_Rules_RequiredRule_Validate_System_String_" data-uid="Apq.Cfg.Validation.Rules.RequiredRule.Validate(System.String)">
  Validate(string?)
  
  </h3>

  <div class="markdown level1 summary"><p>验证配置值</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public ValidationError? Validate(string? value)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
    <dd><p>配置值</p>
</dd>
  </dl>

  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="Apq.Cfg.Validation.ValidationError.html">ValidationError</a></dt>
    <dd><p>验证错误，如果验证通过返回 null</p>
</dd>
  </dl>


</article>


      </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">
          Apq.Cfg - .NET 统一配置组件库 (基于 .NET 10.0，兼容 .NET 8.0)
        </div>
      </div>
    </footer>
  </body>
</html>