linux-packaging-mono/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/ScaffoldColumnAttribute.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="ScaffoldColumnAttribute" FullName="System.ComponentModel.DataAnnotations.ScaffoldColumnAttribute">
  <TypeSignature Language="C#" Value="public class ScaffoldColumnAttribute : Attribute" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ScaffoldColumnAttribute extends System.Attribute" />
  <AssemblyInfo>
    <AssemblyName>System.ComponentModel.DataAnnotations</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Attribute</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName>System.AttributeUsage(System.AttributeTargets.Property | System.AttributeTargets.Field | System.AttributeTargets.All, AllowMultiple=false)</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Scaffolding is the mechanism for generating web page templates based on database schemas. ASP.NET Dynamic Data uses scaffolding to generate Web-based UI that lets a user to view and update a database. This class uses the <see cref="P:System.ComponentModel.DataAnnotations.ScaffoldColumnAttribute.Scaffold" /> property to enable scaffolding in a Dynamic Data Web Site. </para>
      <para>Scaffolding enhances ASP.NET page framework by dynamically displaying pages based on the data model with no physical pages required.</para>
      <para>Scaffolding provides the following capabilities:</para>
      <list type="bullet">
        <item>
          <para>Minimal or no code to create a data-driven Web application.</para>
        </item>
        <item>
          <para>Quick development time.</para>
        </item>
        <item>
          <para>Pages that are fully functional and include display, insert, edit, delete, sorting, and paging functionalities.</para>
        </item>
        <item>
          <para>Built-in data validation that is based on the database schema.</para>
        </item>
        <item>
          <para>Filters that are created for each foreign key or Boolean fields.</para>
        </item>
      </list>
      <para>This class can be used to enable or disable scaffolding of data columns in a data model by applying this attribute to the appropriate data field object in the class that represents the table.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Specifies whether a class or data column uses scaffolding.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ScaffoldColumnAttribute (bool scaffold);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool scaffold) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="scaffold" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>You can set <paramref name="scaffold" /> to true for the entire data model to expose all data columns in the database for CRUD (Create, Read, Update and Delete) operations by setting <paramref name="scaffold" /> to true in the Global.asax file or expose individual data columns in a data table to CRUD operations by setting <paramref name="scaffold" /> to true in the partial class.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of <see cref="T:System.ComponentModel.DataAnnotations.ScaffoldColumnAttribute" /> using the <see cref="P:System.ComponentModel.DataAnnotations.ScaffoldColumnAttribute.Scaffold" /> property.</para>
        </summary>
        <param name="scaffold">
          <attribution license="cc4" from="Microsoft" modified="false" />The value that specifies whether scaffolding is enabled.</param>
      </Docs>
    </Member>
    <Member MemberName="Scaffold">
      <MemberSignature Language="C#" Value="public bool Scaffold { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool Scaffold" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.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>You can use this property to enable scaffolding in individual data columns in a data model. If you set this property to true in the global.asax file, the entire data model will expose all data columns in the database for CRUD (Create, Read, Update and Delete) operations.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the value that specifies whether scaffolding is enabled.</para>
        </summary>
      </Docs>
    </Member>
  </Members>
</Type>