linux-packaging-mono/mcs/class/System/Documentation/en/System.Configuration/SettingsGroupDescriptionAttribute.xml
Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

84 lines
4.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<Type Name="SettingsGroupDescriptionAttribute" FullName="System.Configuration.SettingsGroupDescriptionAttribute">
<TypeSignature Language="C#" Value="public sealed class SettingsGroupDescriptionAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SettingsGroupDescriptionAttribute 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.Class)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An application settings class, derived from <see cref="T:System.Configuration.ApplicationSettingsBase" />, defines one or more properties that belong to the same application property group. <see cref="T:System.Configuration.SettingsGroupDescriptionAttribute" /> is an optional attribute that you can use to provide descriptive text for a settings property group. This text is intended to assist both design-time tools and administrative run-time tools in identifying and describing the associated property group.</para>
<block subset="none" type="note">
<para>This attribute can only be applied at the wrapper class level.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides a string that describes an application settings property group. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SettingsGroupDescriptionAttribute (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 theoretical maximum length of the <paramref name="description" /> parameter is constrained by the upper bounds of an <see cref="T:System.Int32" />, practical limits, determined by usability and quota limitations imposed by the settings provider, will be much smaller. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.SettingsGroupDescriptionAttribute" /> class.</para>
</summary>
<param name="description">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> containing the descriptive text for the application settings group.</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.SettingsGroupDescriptionAttribute.Description" /> property value is set in the <see cref="M:System.Configuration.SettingsGroupDescriptionAttribute.#ctor(System.String)" /> constructor.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The descriptive text for the application settings properties group.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>