Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

UIHintAttribute Class

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

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

Namespace:  System.ComponentModel.DataAnnotations
Assemblies:   System.ComponentModel.Annotations (in System.ComponentModel.Annotations.dll)
  System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)

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

The UIHintAttribute type exposes the following members.

  NameDescription
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsUIHintAttribute(String)Initializes a new instance of the UIHintAttribute class by using a specified user control.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsUIHintAttribute(String, String)Initializes a new instance of the UIHintAttribute class using the specified user control and specified presentation layer.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsUIHintAttribute(String, String, Object[])Initializes a new instance of the UIHintAttribute class by using the specified user control, presentation layer, and control parameters.
Top

  NameDescription
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsControlParametersGets or sets the DynamicControlParameter object to use to retrieve values from any data source.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsPresentationLayerGets or sets the presentation layer that uses the UIHintAttribute class.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public propertyTypeIdGets the unique identifier for the attribute. (Overrides Attribute.TypeId.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsUIHintGets or sets the name of the field template to use to display the data field.
Top

  NameDescription
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEqualsGets a value that indicates whether this instance is equal to the specified object. (Overrides Attribute.Equals(Object).)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetHashCodeGets the hash code for the current instance of the attribute. (Overrides Attribute.GetHashCode().)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

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;

}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5 SP1

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Windows 8.1, Windows Server 2012 R2, 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft