UIHintAttribute Class

Definition

Namespace:

System.ComponentModel.DataAnnotations

Assembly:

System.ComponentModel.Annotations.dll

Source:

UIHintAttribute.cs

Specifies the template or user control that Dynamic Data uses to display a data field.

public ref class UIHintAttribute : Attribute

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

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

Public Class UIHintAttribute
Inherits Attribute

Inheritance

Object

Attribute

UIHintAttribute

Attributes

AttributeUsageAttribute

Examples

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;
}

Imports System.Web.DynamicData
Imports System.ComponentModel.DataAnnotations


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

End Class

Partial Public Class ProductMetadata
    <UIHint("UnitsInStock")> _
    <Range(100, 10000)> _
    Public UnitsInStock As Object
End Class

Remarks

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

Constructors

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.

Properties

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	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)
UIHint	Gets or sets the name of the field template to use to display the data field.

Methods

Equals(Object)	Gets a value that indicates whether this instance is equal to the specified object.
GetHashCode()	Gets the hash code for the current instance of the 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)

See also

• How to: Customize Data Field Display in the Data Model