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)

System.Object
  System.Attribute
    System.ComponentModel.DataAnnotations.UIHintAttribute

<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field,
	AllowMultiple := True)>
Public Class UIHintAttribute
	Inherits Attribute

NameDescription
System_CAPS_pubmethodUIHintAttribute(String)

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

System_CAPS_pubmethodUIHintAttribute(String, String)

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

System_CAPS_pubmethodUIHintAttribute(String, String, Object())

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

NameDescription
System_CAPS_pubpropertyControlParameters

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

System_CAPS_pubpropertyPresentationLayer

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

System_CAPS_pubpropertyTypeId

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

System_CAPS_pubpropertyUIHint

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

NameDescription
System_CAPS_pubmethodEquals(Object)

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

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

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

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

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

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

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

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: