1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="DataSetFieldSchema" FullName="System.Web.UI.Design.DataSetFieldSchema">
<TypeSignature Language="C#" Value="public sealed class DataSetFieldSchema : System.Web.UI.Design.IDataSourceFieldSchema" />
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Web.UI.Design.IDataSourceFieldSchema</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> class to get the properties of a data field using a <see cref="T:System.Data.DataColumn" />. You can discover the structure of a data field by using the following properties in this class: <see cref="P:System.Web.UI.Design.DataSetFieldSchema.DataType" />, <see cref="P:System.Web.UI.Design.DataSetFieldSchema.IsReadOnly" />, <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Length" />, <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Name" />, and <see cref="P:System.Web.UI.Design.DataSetFieldSchema.IsUnique" />. In addition, you can use the <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Identity" /> property to determine if a data column is set for <see cref="P:System.Data.DataColumn.AutoIncrement" />, or the <see cref="P:System.Web.UI.Design.DataSetFieldSchema.PrimaryKey" /> property to determine if a data column is in the primary key.</para>
<para>The <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> class is used by custom control designer components to provide information about a data field at design time. </para>
<para>To examine the components of data using a <see cref="T:System.Data.DataSet" />, use the following classes.</para>
<list type="bullet">
<item>
<para>
<see cref="T:System.Web.UI.Design.DataSetSchema" />
</para>
</item>
<item>
<para>
<see cref="T:System.Web.UI.Design.DataSetViewSchema" />
</para>
</item>
<item>
<para>
<see cref="T:System.Web.UI.Design.DataSetFieldSchema" />
</para>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents the structure, or schema, of a data field.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DataSetFieldSchema (System.Data.DataColumn column);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="column" Type="System.Data.DataColumn" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> class to examine the properties of a data field using a <see cref="T:System.Data.DataColumn" /> object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> class using a specified <see cref="T:System.Data.DataColumn" />.</para>
</summary>
<param name="column">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Data.DataColumn" /> object that the <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> object describes.</param>
</Docs>
</Member>
<Member MemberName="DataType">
<MemberSignature Language="C#" Value="public Type DataType { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the type of data stored in the data field.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Identity">
<MemberSignature Language="C#" Value="public bool Identity { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Identity" /> property corresponds to the <see cref="P:System.Data.DataColumn.AutoIncrement" /> property of a <see cref="T:System.Data.DataColumn" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether the value of the data field automatically increments for each new row added to the table or view.</para>
</summary>
</Docs>
</Member>
<Member MemberName="IsReadOnly">
<MemberSignature Language="C#" Value="public bool IsReadOnly { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether the <see cref="T:System.Data.DataColumn" /> is read-only.</para>
</summary>
</Docs>
</Member>
<Member MemberName="IsUnique">
<MemberSignature Language="C#" Value="public bool IsUnique { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.Design.DataSetFieldSchema.IsUnique" /> property corresponds to the <see cref="P:System.Data.DataColumn.Unique" /> property of a <see cref="T:System.Data.DataColumn" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether values in the data field are required to be unique.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Length">
<MemberSignature Language="C#" Value="public int Length { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Length" /> property corresponds to the <see cref="P:System.Data.DataColumn.MaxLength" /> property of a <see cref="T:System.Data.DataColumn" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating the size of data that can be stored in the data field.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Name" /> property corresponds to the <see cref="P:System.Data.DataColumn.ColumnName" /> property of a <see cref="T:System.Data.DataColumn" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the data field.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Nullable">
<MemberSignature Language="C#" Value="public bool Nullable { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Nullable" /> property corresponds to the <see cref="P:System.Data.DataColumn.AllowDBNull" /> property of a <see cref="T:System.Data.DataColumn" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether the data field can accept null values.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Precision">
<MemberSignature Language="C#" Value="public int Precision { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Precision" /> property is required by the <see cref="T:System.Web.UI.Design.IDataSourceFieldSchema" /> interface, but is not used by the <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the maximum number of digits used to represent a numerical value in the data field.</para>
</summary>
</Docs>
</Member>
<Member MemberName="PrimaryKey">
<MemberSignature Language="C#" Value="public bool PrimaryKey { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether the data field is in the primary key for the containing table or view.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Scale">
<MemberSignature Language="C#" Value="public int Scale { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.Design.DataSetFieldSchema.Scale" /> property is required by the <see cref="T:System.Web.UI.Design.IDataSourceFieldSchema" /> interface, but is not used by the <see cref="T:System.Web.UI.Design.DataSetFieldSchema" /> class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the number of decimal places to which numerical values in the data field are resolved.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>
|