90 lines
4.5 KiB
XML
90 lines
4.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="SettingsDescriptionAttribute" FullName="System.Configuration.SettingsDescriptionAttribute">
|
|
<TypeSignature Language="C#" Value="public sealed class SettingsDescriptionAttribute : Attribute" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SettingsDescriptionAttribute extends System.Attribute" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System</AssemblyName>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Attribute</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.AttributeUsage(System.AttributeTargets.Property)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Configuration.SettingsDescriptionAttribute" /> is intended to assist both design time tools and administrative run time tools in identifying and describing the associated configuration property.</para>
|
|
<para>This attribute is optional and can only be applied at the individual configuration property level.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Provides a string that describes an individual configuration property. This class cannot be inherited.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public SettingsDescriptionAttribute (string description);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string description) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="description" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Although the description has a theoretical maximum length of the <see cref="T:System.String" /> class, whose length is represented by a <see cref="T:System.Int32" />, the following two practical considerations will limit the size of the <paramref name="description" /> parameter:</para>
|
|
<list type="bullet">
|
|
<item>
|
|
<para>Large text descriptions are difficult to display in a user interface (UI) and difficult for the user to read.</para>
|
|
</item>
|
|
<item>
|
|
<para>Settings providers may enforce overall usage quotas and are required to enforce user configuration quotas.</para>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes an instance of the <see cref="T:System.Configuration.SettingsDescriptionAttribute" /> class.</para>
|
|
</summary>
|
|
<param name="description">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.String" /> used as descriptive text.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Description">
|
|
<MemberSignature Language="C#" Value="public string Description { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Description" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Configuration.SettingsDescriptionAttribute.Description" /> property is set by the <see cref="M:System.Configuration.SettingsDescriptionAttribute.#ctor(System.String)" /> constructor.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the descriptive text for the associated configuration property.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |