ScaffoldColumnAttribute Class

Definition

Namespace:

System.ComponentModel.DataAnnotations

Assembly:

System.ComponentModel.Annotations.dll

Source:

ScaffoldColumnAttribute.cs

Specifies whether a class or data column uses scaffolding.

public ref class ScaffoldColumnAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)]
public class ScaffoldColumnAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)>]
type ScaffoldColumnAttribute = class
    inherit Attribute

Public Class ScaffoldColumnAttribute
Inherits Attribute

Inheritance

Object

Attribute

ScaffoldColumnAttribute

Attributes

AttributeUsageAttribute

Examples

The following code example exposes the ProductID column of the Products table in the AdventureWorksLT data base by applying the scaffold property to the ProductID object in the Products partial class and setting it to true. It hides the ThumbnailPhotoFileName column by applying the scaffold property to the ThumbnailPhotoFileName object and setting it to false.

[MetadataType(typeof(ProductMetadata))]  
public partial class Product  
{  

}  

public class ProductMetadata  
{  
    [ScaffoldColumn(true)]  
    public object ProductID;  

    [ScaffoldColumn(false)]  
    public object ThumbnailPhotoFileName;  

}  

<MetadataType(GetType(ProductMetadata))>  
Public Partial Class Product   

End Class   

Public Class ProductMetadata   
    <ScaffoldColumn(True)>  
    Public ProductID As Object   

    <ScaffoldColumn(False)>   
    Public ThumbnailPhotoFileName As Object  

End Class  

To compile the example code, you need the following:

• Any edition of Visual Studio 2010 or later.

• The AdventureWorksLT sample database. For information about how to download and install the SQL Server sample database, see Microsoft SQL Server Product Samples: Database on GitHub. Make sure that you install the correct version of the sample database for the version of SQL Server that you are running.

• A Dynamic Data Web site. This enables you to create a data context for the database and the class that contains the data field to customize and the methods to override. In addition, it creates the environment in which to use the page described before. For more information, see Walkthrough: Creating a New Dynamic Data Web Site Using Scaffolding.

Remarks

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 Scaffold property to enable scaffolding in a Dynamic Data Web Site.

Scaffolding enhances ASP.NET page framework by dynamically displaying pages based on the data model with no physical pages required.

Scaffolding provides the following capabilities:

• Minimal or no code to create a data-driven Web application.

• Quick development time.

• Pages that are fully functional and include display, insert, edit, delete, sorting, and paging functionalities.

• Built-in data validation that is based on the database schema.

• Filters that are created for each foreign key or Boolean fields.

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.

Constructors

ScaffoldColumnAttribute(Boolean)

Initializes a new instance of ScaffoldColumnAttribute using the Scaffold property.

Properties

Scaffold	Gets or sets the value that specifies whether scaffolding is enabled.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)