DaNike
/
BeatSaber-IPA-Reloaded
mirror of https://github.com/bsmg/BeatSaber-IPA-Reloaded.git

﻿<!DOCTYPE html><!--[if IE]><![endif]--><html>    <head>    <meta charset="utf-8">    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">    <title>Class SerializedNameAttribute   </title>    <meta name="viewport" content="width=device-width">    <meta name="title" content="Class SerializedNameAttribute   ">    <meta name="generator" content="docfx 2.59.4.0">        <link rel="shortcut icon" href="../favicon.ico">    <link rel="stylesheet" href="../styles/docfx.vendor.css">    <link rel="stylesheet" href="../styles/docfx.css">    <link rel="stylesheet" href="../styles/main.css">    <link rel="stylesheet" href="../styles/fix.css">    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">     <meta property="docfx:navrel" content="../toc.html">    <meta property="docfx:tocrel" content="toc.html">        <meta property="docfx:rel" content="../">    <meta property="docfx:newtab" content="true">  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">    <div id="wrapper">      <header>                <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">          <div class="container">            <div class="navbar-header">              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">                <span class="sr-only">Toggle navigation</span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>              </button>                            <a class="navbar-brand" href="../index.html">                <img id="logo" class="svg" src="../logo.svg" alt="">              </a>            </div>            <div class="collapse navbar-collapse" id="navbar">              <form class="navbar-form navbar-right" role="search" id="search">                <div class="form-group">                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">                </div>              </form>            </div>          </div>        </nav>                <div class="subnav navbar navbar-default">          <div class="container hide-when-search" id="breadcrumb">            <ul class="breadcrumb">              <li></li>            </ul>          </div>        </div>      </header>      <div class="container body-content">                <div id="search-results">          <div class="search-list">Search Results for <span></span></div>          <div class="sr-items">            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>          </div>          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>        </div>      </div>      <div role="main" class="container body-content hide-when-search">                <div class="sidenav hide-when-search">          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>          <div class="sidetoggle collapse" id="sidetoggle">            <div id="sidetoc"></div>          </div>        </div>        <div class="article row grid-right">          <div class="col-md-10">            <article class="content wrap" id="_content" data-uid="IPA.Config.Stores.Attributes.SerializedNameAttribute">      <h1 id="IPA_Config_Stores_Attributes_SerializedNameAttribute" data-uid="IPA.Config.Stores.Attributes.SerializedNameAttribute" class="text-break">Class SerializedNameAttribute  </h1>  <div class="markdown level0 summary"><p>Specifies a name for the serialized field or property in an object being wrapped by<a class="xref" href="IPA.Config.Stores.GeneratedStore.html#IPA_Config_Stores_GeneratedStore_Generated__1_IPA_Config_Config_System_Boolean_">Generated&lt;T&gt;(Config, Boolean)</a> that is different from the member name itself.</p></div>  <div class="markdown level0 conceptual"></div>  <div class="inheritance">    <h5>Inheritance</h5>    <div class="level0"><span class="xref">System.Object</span></div>    <div class="level1"><span class="xref">System.Attribute</span></div>    <div class="level2"><span class="xref">SerializedNameAttribute</span></div>  </div>  <div class="implements">    <h5>Implements</h5>    <div><span class="xref">System.Runtime.InteropServices._Attribute</span></div>  </div>  <div class="inheritedMembers">    <h5>Inherited Members</h5>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)</span>    </div>    <div>      <span class="xref">System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)</span>    </div>    <div>      <span class="xref">System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.IsDefined(System.Reflection.Module, System.Type)</span>    </div>    <div>      <span class="xref">System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)</span>    </div>    <div>      <span class="xref">System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)</span>    </div>    <div>      <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)</span>    </div>    <div>      <span class="xref">System.Attribute.Equals(System.Object)</span>    </div>    <div>      <span class="xref">System.Attribute.GetHashCode()</span>    </div>    <div>      <span class="xref">System.Attribute.Match(System.Object)</span>    </div>    <div>      <span class="xref">System.Attribute.IsDefaultAttribute()</span>    </div>    <div>      <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetTypeInfoCount(System.UInt32)</span>    </div>    <div>      <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetTypeInfo(System.UInt32, System.UInt32, System.IntPtr)</span>    </div>    <div>      <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetIDsOfNames(System.Guid, System.IntPtr, System.UInt32, System.UInt32, System.IntPtr)</span>    </div>    <div>      <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.Invoke(System.UInt32, System.Guid, System.UInt32, System.Int16, System.IntPtr, System.IntPtr, System.IntPtr, System.IntPtr)</span>    </div>    <div>      <span class="xref">System.Attribute.TypeId</span>    </div>    <div>      <span class="xref">System.Object.ToString()</span>    </div>    <div>      <span class="xref">System.Object.Equals(System.Object, System.Object)</span>    </div>    <div>      <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>    </div>    <div>      <span class="xref">System.Object.GetType()</span>    </div>    <div>      <span class="xref">System.Object.MemberwiseClone()</span>    </div>  </div>  <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.Stores.Attributes.html">IPA.Config.Stores.Attributes</a></h6>  <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>  <h5 id="IPA_Config_Stores_Attributes_SerializedNameAttribute_syntax">Syntax</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false, Inherited = true)]public sealed class SerializedNameAttribute : Attribute, _Attribute</code></pre>  </div>  <h5 id="IPA_Config_Stores_Attributes_SerializedNameAttribute_examples"><strong>Examples</strong></h5>  <p>When serializing the following object, we might get the JSON that follows.<pre><code>public class PluginConfig{    public virtual bool BooleanField { get; set; } = true;}</code></pre><pre><code>{    &quot;BooleanField&quot;: true}</code></pre></p><p>However, if we were to add a <a class="xref" href="IPA.Config.Stores.Attributes.SerializedNameAttribute.html">SerializedNameAttribute</a> to that field, we would get the following.<pre><code>public class PluginConfig{    [SerializedName(&quot;bool&quot;)]    public virtual bool BooleanField { get; set; } = true;}</code></pre><pre><code>{    &quot;bool&quot;: true}</code></pre></p>
  <h3 id="constructors">Constructors  </h3>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Attributes_SerializedNameAttribute__ctor_System_String_.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Attributes.SerializedNameAttribute.%23ctor(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/a81bad951faa2996c93ab866290a8f11e87270ce/IPA.Loader/Config/Stores/Attributes.cs/#L143">View Source</a>  </span>  <a id="IPA_Config_Stores_Attributes_SerializedNameAttribute__ctor_" data-uid="IPA.Config.Stores.Attributes.SerializedNameAttribute.#ctor*"></a>  <h4 id="IPA_Config_Stores_Attributes_SerializedNameAttribute__ctor_System_String_" data-uid="IPA.Config.Stores.Attributes.SerializedNameAttribute.#ctor(System.String)">SerializedNameAttribute(String)</h4>  <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="IPA.Config.Stores.Attributes.SerializedNameAttribute.html">SerializedNameAttribute</a> with the given <a class="xref" href="IPA.Config.Stores.Attributes.SerializedNameAttribute.html#IPA_Config_Stores_Attributes_SerializedNameAttribute_Name">Name</a>.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public SerializedNameAttribute(string name)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><span class="xref">System.String</span></td>        <td><span class="parametername">name</span></td>        <td><p>the value to assign to <a class="xref" href="IPA.Config.Stores.Attributes.SerializedNameAttribute.html#IPA_Config_Stores_Attributes_SerializedNameAttribute_Name">Name</a></p></td>      </tr>    </tbody>  </table>  <h3 id="properties">Properties  </h3>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Attributes_SerializedNameAttribute_Name.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Attributes.SerializedNameAttribute.Name%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/a81bad951faa2996c93ab866290a8f11e87270ce/IPA.Loader/Config/Stores/Attributes.cs/#L137">View Source</a>  </span>  <a id="IPA_Config_Stores_Attributes_SerializedNameAttribute_Name_" data-uid="IPA.Config.Stores.Attributes.SerializedNameAttribute.Name*"></a>  <h4 id="IPA_Config_Stores_Attributes_SerializedNameAttribute_Name" data-uid="IPA.Config.Stores.Attributes.SerializedNameAttribute.Name">Name</h4>  <div class="markdown level1 summary"><p>Gets the name to replace the member name with.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public string Name { get; }</code></pre>  </div>  <h5 class="propertyValue">Property Value</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><span class="xref">System.String</span></td>        <td></td>      </tr>    </tbody>  </table>  <h3 id="implements">Implements</h3>  <div>      <span class="xref">System.Runtime.InteropServices._Attribute</span>  </div>  <h3 id="extensionmethods">Extension Methods</h3>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__2___0_System_String___1_">ReflectionUtil.SetField&lt;T, U&gt;(T, String, U)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField&lt;U, T&gt;(T, String)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__2___0_System_String___1_">ReflectionUtil.SetProperty&lt;T, U&gt;(T, String, U)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetProperty__2___1_System_String_">ReflectionUtil.GetProperty&lt;U, T&gt;(T, String)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;U, T&gt;(T, String, Object[])</a>  </div></article>          </div>                    <div class="hidden-sm col-md-2" role="complementary">            <div class="sideaffix">              <div class="contribution">                <ul class="nav">                  <li>                    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Attributes_SerializedNameAttribute.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Attributes.SerializedNameAttribute%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>                  </li>                  <li>                    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/a81bad951faa2996c93ab866290a8f11e87270ce/IPA.Loader/Config/Stores/Attributes.cs/#L131" class="contribution-link">View Source</a>                  </li>                </ul>              </div>              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">                <h5>In This Article</h5>                <div></div>              </nav>            </div>          </div>        </div>      </div>            <footer>        <div class="grad-bottom"></div>        <div class="footer">          <div class="container">            <span class="pull-right">              <a href="#top">Back to top</a>            </span>                        <span>Generated by <strong>DocFX</strong></span>          </div>        </div>      </footer>    </div>        <script type="text/javascript" src="../styles/docfx.vendor.js"></script>    <script type="text/javascript" src="../styles/docfx.js"></script>    <script type="text/javascript" src="../styles/main.js"></script>  </body></html>