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)

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModel.DataAnnotationsUIHintAttribute

Syntax
[AttributeUsageAttribute(AttributeTargets.Property | AttributeTargets.Field, 
	AllowMultiple = true)]
public class UIHintAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Property | AttributeTargets::Field, 
	AllowMultiple = true)]
public ref class UIHintAttribute : Attribute
[<AttributeUsageAttribute(AttributeTargets.Property | AttributeTargets.Field,
    AllowMultiple = true)>]
type UIHintAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field,
	AllowMultiple := True)>
Public Class UIHintAttribute
	Inherits Attribute
Constructors
NameDescription
System_CAPS_pubmethod UIHintAttribute

Initializes a new instance of the UIHintAttribute class by using a specified user control.

System_CAPS_pubmethod UIHintAttribute

Initializes a new instance of the UIHintAttribute class using the specified user control and specified presentation layer.

System_CAPS_pubmethod UIHintAttribute

Initializes a new instance of the UIHintAttribute class by using the specified user control, presentation layer, and control parameters.

Properties
NameDescription
System_CAPS_pubproperty

Gets or sets the DynamicControlParameter object to use to retrieve values from any data source.

System_CAPS_pubproperty

Gets or sets the presentation layer that uses the UIHintAttribute class.

System_CAPS_pubproperty

Gets the unique identifier for the attribute.(Overrides .)

System_CAPS_pubproperty

Gets or sets the name of the field template to use to display the data field.

Methods
NameDescription
System_CAPS_pubmethod Equals

Gets a value that indicates whether this instance is equal to the specified object.(Overrides AttributeEquals.)

System_CAPS_protmethod Finalize

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_pubmethod GetHashCode

Gets the hash code for the current instance of the attribute.(Overrides AttributeGetHashCode.)

System_CAPS_pubmethod GetType

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

System_CAPS_pubmethod 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.)

System_CAPS_pubmethod Match

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

System_CAPS_protmethod MemberwiseClone

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

System_CAPS_pubmethod ToString

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

Explicit Interface Implementations
NameDescription
System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetIDsOfNames

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

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfo

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

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfoCount

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

System_CAPS_pubinterface System_CAPS_privmethod _AttributeInvoke

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

Remarks

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

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
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
Version Information
Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 3.0
Thread Safety

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