ScaffoldTableAttribute Class

Reference

Definition

Namespace:: System.ComponentModel.DataAnnotations

Assembly:: System.ComponentModel.DataAnnotations.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Specifies whether a class or data table uses scaffolding.

public ref class ScaffoldTableAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false)]
public class ScaffoldTableAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false)>]
type ScaffoldTableAttribute = class
    inherit Attribute

Public Class ScaffoldTableAttribute
Inherits Attribute

Inheritance: Object

Attribute
ScaffoldTableAttribute

Attributes: AttributeUsageAttribute

Examples

The following code example hides the ErrorLog Table in AdventureWorksLT database by applying the scaffold attribute to the ErrorLog partial class that represents the ErrorLog table. The scaffold property is set to false.

[MetadataType (typeof(ErrorLogMetadata))]  
[ScaffoldTable(false)]  
public partial class ErrorLog  
{  

}  

public class ErrorLogMetadata  
{  

}

<MetadataType(GetType(ErrorLogMetadata))> _   
<ScaffoldTable(False)>   
Public Partial Class ErrorLog   

End Class   

Public Class ErrorLogMetadata  

End Class

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 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 of individual tables in a Dynamic Data Web Site. Scaffolding enhances the ASP.NET page framework by dynamically displaying pages based on the data model with no physical pages required.

Scaffolding provides the following:

Minimal or no code to create a data-driven Web application.
Quick development time.
Pages that are fully functional, including display, insert, edit, delete, sorting, and paging functionalities.
Built-in data validation 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 tables in a data model by applying this attribute to the partial class that represents the table.

Constructors

ScaffoldTableAttribute(Boolean)

Initializes a new instance of ScaffoldTableAttribute 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)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute)
_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)
_Attribute.GetTypeInfoCount(UInt32)	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object. (Inherited from Attribute)

Applies to

Share via