ScaffoldColumnAttribute Class

ScaffoldColumnAttribute Class

 

Specifies whether a class or data column uses scaffolding.

Namespace:   System.ComponentModel.DataAnnotations
Assembly:  System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)

System.Object
  System.Attribute
    System.ComponentModel.DataAnnotations.ScaffoldColumnAttribute

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

NameDescription
System_CAPS_pubmethodScaffoldColumnAttribute(Boolean)

Initializes a new instance of ScaffoldColumnAttribute using the Scaffold property.

NameDescription
System_CAPS_pubpropertyScaffold

Gets or sets the value that specifies whether scaffolding is enabled.

System_CAPS_pubpropertyTypeId

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethodEquals(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIsDefaultAttribute()

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)

System_CAPS_pubmethodMatch(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfoCount(UInt32)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

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.

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(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

[C#]

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

}

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

    [ScaffoldColumn(false)]
    public object ThumbnailPhotoFileName;


}

To compile the example code, you need the following:

  • Visual Studio 2008 Service Pack 1 or Visual Developer 2008 Express Edition Service Pack 1.

  • 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 the CodePlex site. Make sure that you install the correct version of the sample database for the version of SQL Server that you are running (SQL Server 2005 or SQL Server 2008).

  • 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.

Universal Windows Platform
Available since 10
.NET Framework
Available since 3.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft