RangeAttribute Class

.NET Framework (current version)
 

Specifies the numeric range constraints for the value of a data field.

Namespace:   System.ComponentModel.DataAnnotations
Assembly:  System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)

System.Object
  System.Attribute
    System.ComponentModel.DataAnnotations.ValidationAttribute
      System.ComponentModel.DataAnnotations.RangeAttribute

C#
C++
F#
VB
Copy 
<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field Or AttributeTargets.Parameter,
	AllowMultiple := False)>
Public Class RangeAttribute
	Inherits ValidationAttribute

NameDescription
System_CAPS_pubmethodRangeAttribute(Double, Double)

Initializes a new instance of the RangeAttribute class by using the specified minimum and maximum values.

System_CAPS_pubmethodRangeAttribute(Int32, Int32)

Initializes a new instance of the RangeAttribute class by using the specified minimum and maximum values.

System_CAPS_pubmethodRangeAttribute(Type, String, String)

Initializes a new instance of the RangeAttribute class by using the specified minimum and maximum values and the specific type.

NameDescription
System_CAPS_pubpropertyErrorMessage

Gets or sets an error message to associate with a validation control if validation fails.(Inherited from ValidationAttribute.)

System_CAPS_pubpropertyErrorMessageResourceName

Gets or sets the error message resource name to use in order to look up the ErrorMessageResourceType property value if validation fails.(Inherited from ValidationAttribute.)

System_CAPS_pubpropertyErrorMessageResourceType

Gets or sets the resource type to use for error-message lookup if validation fails.(Inherited from ValidationAttribute.)

System_CAPS_protpropertyErrorMessageString

Gets the localized validation error message.(Inherited from ValidationAttribute.)

System_CAPS_pubpropertyMaximum

Gets the maximum allowed field value.

System_CAPS_pubpropertyMinimum

Gets the minimum allowed field value.

System_CAPS_pubpropertyOperandType

Gets the type of the data field whose value must be validated.

System_CAPS_pubpropertyRequiresValidationContext

Gets a value that indicates whether the attribute requires validation context.(Inherited from ValidationAttribute.)

System_CAPS_pubpropertyTypeId

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethodEquals(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)

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

Formats the error message that is displayed when range validation fails.(Overrides ValidationAttribute.FormatErrorMessage(String).)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

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

System_CAPS_pubmethodGetValidationResult(Object, ValidationContext)

Checks whether the specified value is valid with respect to the current validation attribute.(Inherited from ValidationAttribute.)

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

Checks that the value of the data field is in the specified range.(Overrides ValidationAttribute.IsValid(Object).)

System_CAPS_protmethodIsValid(Object, ValidationContext)

Validates the specified value with respect to the current validation attribute.(Inherited from ValidationAttribute.)

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

System_CAPS_pubmethodValidate(Object, String)

Validates the specified object.(Inherited from ValidationAttribute.)

System_CAPS_pubmethodValidate(Object, ValidationContext)

Validates the specified object.(Inherited from ValidationAttribute.)

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

Exception Condition

When you apply this attribute to a data field, you must follow the guidelines for how to use validation attributes. For more information, see ASP.NET Dynamic Data Guidelines.

The following example shows how to use the RangeAttribute to customize formatting for a data field. The example performs the following steps:

  • Implements a metadata partial class and the associated metadata class.

  • In the associated metadata class, it applies the RangeAttribute attribute to obtain the following results:

    • Apply the attribute to a data field of type integer.

    • Apply the attribute to an integer data field and define a custom validation error message.

    • Apply the attribute to a DateTime data field and define a custom validation error message.

C#
VB
Copy 
Imports System
Imports System.Web.DynamicData
Imports System.ComponentModel.DataAnnotations
Imports System.ComponentModel

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

End Class


Public Class ProductMetaData

    <Range(10, 1000, _
           ErrorMessage:="Value for {0} must be between {1} and {2}.")> _
    Public Weight As Object

    <Range(300, 3000)> _
    Public ListPrice As Object

    <Range(GetType(DateTime), "1/2/2004", "3/4/2004", _
           ErrorMessage:="Value for {0} must be between {1} and {2}")> _
    Public SellEndDate As Object

End Class

To compile the example, you need the following:

  • Microsoft Visual Studio 2008 Service Pack 1 or Visual Web Developer 2008 Express Edition SP1.

  • A data-driven Web site. This enables you to create a data context for the database and the class that contains the data field to customize. For more information, see Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding.

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: