UIHintAttribute Class
Specifies the template or user control that Dynamic Data uses to display a data field.
Namespace: System.ComponentModel.DataAnnotations
Assembly: System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)
The UIHintAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
   | UIHintAttribute(String) | Initializes a new instance of the UIHintAttribute class by using a specified user control. |
| UIHintAttribute(String, String) | Initializes a new instance of the UIHintAttribute class using the specified user control and specified presentation layer. |
| UIHintAttribute(String, String, Object[]) | Initializes a new instance of the UIHintAttribute class by using the specified user control, presentation layer, and control parameters. |
| Name | Description | |
|---|---|---|
| ControlParameters | Gets or sets the DynamicControlParameter object to use to retrieve values from any data source. |
| PresentationLayer | Gets or sets the presentation layer that uses the UIHintAttribute class. |
| TypeId | Gets the unique identifier for the attribute. (Overrides Attribute.TypeId.) |
| UIHint | Gets or sets the name of the field template to use to display the data field. |
| Name | Description | |
|---|---|---|
| Equals | Gets a value that indicates whether this instance is equal to the specified object. (Overrides Attribute.Equals(Object).) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Gets the hash code for the current instance of the attribute. (Overrides Attribute.GetHashCode().) |
| 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 | 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.) |
| Name | Description | |
|---|---|---|
| _Attribute.GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
| _Attribute.GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
| _Attribute.GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
| _Attribute.Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
A Visual Studio project with source code is available to accompany this topic: Download.
MVC uses the UIHintAttribute class to associate a model with a data field. Dynamic Data uses the UIHintAttribute class to associate a user control with a data field. Dynamic Data uses the UIHint property to determine which user control to use in order to display a data field.
For more information about how to use attributes, see Extending Metadata Using Attributes.
The following example shows how to use the UIHintAttribute attribute to specify the name of a custom field template that will handle the display and editing of a data field.
For a complete example, see How to: Customize Data Field Display in the Data Model.
using System; using System.Web.DynamicData; using System.ComponentModel.DataAnnotations; [MetadataType(typeof(ProductMetadata))] public partial class Product { } public partial class ProductMetadata { [UIHint("UnitsInStock")] [Range(100, 10000, ErrorMessage = "Units in stock should be between {1} and {2}.")] public object UnitsInStock; }
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
