341 lines
18 KiB
XML
341 lines
18 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="SettingsProperty" FullName="System.Configuration.SettingsProperty">
|
|
<TypeSignature Language="C#" Value="public class SettingsProperty" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SettingsProperty extends System.Object" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System</AssemblyName>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>
|
|
<see cref="T:System.Configuration.SettingsProperty" /> is used to describe settings properties of a class derived from <see cref="T:System.Configuration.SettingsBase" />. The Settings API allows a collection of settings properties to be grouped into a common language runtime class. </para>
|
|
<para>When persisting settings, the <see cref="T:System.Configuration.SettingsBase" /> base class asks for a collection of <see cref="T:System.Configuration.SettingsProperty" /> objects, grouped in a collection of type <see cref="T:System.Configuration.SettingsPropertyCollection" />. It does this by calling its own Properties member. Inherited classes should return a collection of properties to persist.</para>
|
|
<para>Each <see cref="T:System.Configuration.SettingsProperty" /> object includes metadata about the property, including the following:</para>
|
|
<list type="bullet">
|
|
<item>
|
|
<para>Name.</para>
|
|
</item>
|
|
<item>
|
|
<para>Default value.</para>
|
|
</item>
|
|
<item>
|
|
<para>Property type.</para>
|
|
</item>
|
|
<item>
|
|
<para>Serialization method.</para>
|
|
</item>
|
|
<item>
|
|
<para>Provider to use for persistence.</para>
|
|
</item>
|
|
<item>
|
|
<para>Other arbitrary attributes that are context and provider specific.</para>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Used internally as the class that represents metadata about an individual configuration property.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public SettingsProperty (System.Configuration.SettingsProperty propertyToCopy);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Configuration.SettingsProperty propertyToCopy) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="propertyToCopy" Type="System.Configuration.SettingsProperty" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Configuration.SettingsProperty" /> class, based on the supplied parameter.</para>
|
|
</summary>
|
|
<param name="propertyToCopy">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />Specifies a copy of an existing <see cref="T:System.Configuration.SettingsProperty" /> object.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public SettingsProperty (string name);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="name" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Configuration.SettingsProperty" /> class. based on the supplied parameter.</para>
|
|
</summary>
|
|
<param name="name">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />Specifies the name of an existing <see cref="T:System.Configuration.SettingsProperty" /> object.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public SettingsProperty (string name, Type propertyType, System.Configuration.SettingsProvider provider, bool isReadOnly, object defaultValue, System.Configuration.SettingsSerializeAs serializeAs, System.Configuration.SettingsAttributeDictionary attributes, bool throwOnErrorDeserializing, bool throwOnErrorSerializing);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, class System.Type propertyType, class System.Configuration.SettingsProvider provider, bool isReadOnly, object defaultValue, valuetype System.Configuration.SettingsSerializeAs serializeAs, class System.Configuration.SettingsAttributeDictionary attributes, bool throwOnErrorDeserializing, bool throwOnErrorSerializing) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="name" Type="System.String" />
|
|
<Parameter Name="propertyType" Type="System.Type" />
|
|
<Parameter Name="provider" Type="System.Configuration.SettingsProvider" />
|
|
<Parameter Name="isReadOnly" Type="System.Boolean" />
|
|
<Parameter Name="defaultValue" Type="System.Object" />
|
|
<Parameter Name="serializeAs" Type="System.Configuration.SettingsSerializeAs" />
|
|
<Parameter Name="attributes" Type="System.Configuration.SettingsAttributeDictionary" />
|
|
<Parameter Name="throwOnErrorDeserializing" Type="System.Boolean" />
|
|
<Parameter Name="throwOnErrorSerializing" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates a new instance of the <see cref="T:System.Configuration.SettingsProperty" /> class based on the supplied parameters.</para>
|
|
</summary>
|
|
<param name="name">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Configuration.SettingsProperty" /> object.</param>
|
|
<param name="propertyType">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The type of <see cref="T:System.Configuration.SettingsProperty" /> object.</param>
|
|
<param name="provider">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Configuration.SettingsProvider" /> object to use for persistence.</param>
|
|
<param name="isReadOnly">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Boolean" /> value specifying whether the <see cref="T:System.Configuration.SettingsProperty" /> object is read-only.</param>
|
|
<param name="defaultValue">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The default value of the <see cref="T:System.Configuration.SettingsProperty" /> object.</param>
|
|
<param name="serializeAs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Configuration.SettingsSerializeAs" /> object. This object is an enumeration used to set the serialization scheme for storing application settings.</param>
|
|
<param name="attributes">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Configuration.SettingsAttributeDictionary" /> object.</param>
|
|
<param name="throwOnErrorDeserializing">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A Boolean value specifying whether an error will be thrown when the property is unsuccessfully deserialized.</param>
|
|
<param name="throwOnErrorSerializing">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A Boolean value specifying whether an error will be thrown when the property is unsuccessfully serialized.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Attributes">
|
|
<MemberSignature Language="C#" Value="public virtual System.Configuration.SettingsAttributeDictionary Attributes { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Configuration.SettingsAttributeDictionary Attributes" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Configuration.SettingsAttributeDictionary</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns a collection of attributes used to describe a <see cref="T:System.Configuration.SettingsProperty" /> object.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets a <see cref="T:System.Configuration.SettingsAttributeDictionary" /> object containing the attributes of the <see cref="T:System.Configuration.SettingsProperty" /> object.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DefaultValue">
|
|
<MemberSignature Language="C#" Value="public virtual object DefaultValue { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance object DefaultValue" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Object</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the default value of the <see cref="T:System.Configuration.SettingsProperty" /> object.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IsReadOnly">
|
|
<MemberSignature Language="C#" Value="public virtual bool IsReadOnly { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool IsReadOnly" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The default is false.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value specifying whether a <see cref="T:System.Configuration.SettingsProperty" /> object is read-only. </para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Name">
|
|
<MemberSignature Language="C#" Value="public virtual string Name { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
|
|
<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.SettingsProperty.Name" /> cannot be an empty string or null. If the <see cref="T:System.Configuration.SettingsProperty" /> does not exist in the data provider, nothing can be returned.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the name of the <see cref="T:System.Configuration.SettingsProperty" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PropertyType">
|
|
<MemberSignature Language="C#" Value="public virtual Type PropertyType { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Type PropertyType" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Type</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the type for the <see cref="T:System.Configuration.SettingsProperty" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Provider">
|
|
<MemberSignature Language="C#" Value="public virtual System.Configuration.SettingsProvider Provider { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Configuration.SettingsProvider Provider" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Configuration.SettingsProvider</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the provider for the <see cref="T:System.Configuration.SettingsProperty" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SerializeAs">
|
|
<MemberSignature Language="C#" Value="public virtual System.Configuration.SettingsSerializeAs SerializeAs { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Configuration.SettingsSerializeAs SerializeAs" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Configuration.SettingsSerializeAs</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="T:System.Configuration.SettingsSerializeAs" /> object is an enumeration used as the serialization scheme to store application settings.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a <see cref="T:System.Configuration.SettingsSerializeAs" /> object for the <see cref="T:System.Configuration.SettingsProperty" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ThrowOnErrorDeserializing">
|
|
<MemberSignature Language="C#" Value="public bool ThrowOnErrorDeserializing { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool ThrowOnErrorDeserializing" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value specifying whether an error will be thrown when the property is unsuccessfully deserialized.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ThrowOnErrorSerializing">
|
|
<MemberSignature Language="C#" Value="public bool ThrowOnErrorSerializing { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool ThrowOnErrorSerializing" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value specifying whether an error will be thrown when the property is unsuccessfully serialized.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |