ModelMetadata ModelMetadata ModelMetadata ModelMetadata Class

Definition

Provides a container for metadata for a model.

public ref class ModelMetadata
public class ModelMetadata
type ModelMetadata = class
Public Class ModelMetadata
Inheritance
ModelMetadataModelMetadataModelMetadataModelMetadata
Derived

Remarks

The word model is used differently in the context of this class than it is typically used elsewhere. In an ASP.NET Web Forms application, the ModelType attribute of a data-bound control specifies the type of a data element that the data control is bound to. This type is typically referred to as the model, and it typically corresponds to a row in a database table. The properties of the model typically correspond to columns of the table.

A ModelMetadata object can provide metadata for the model itself or for a property of the model, or for a property of a complex property. When the ModelMetadata object pertains to a property, the word model refers to the property, and the word container refers to the model.

For example, the model might be Contact, which has Name and Age properties, and the Name property might be a complex property composed of FirstName and LastName. When the ModelMetadata object pertains to the Contact object, the model type is Contact and there is no container. When the ModelMetadata object pertains to the Name property, the model type is Name and the container type is Contact. When the ModelMetadata object pertains to the FirstName property, the model type is FirstName and the container type is Name.

Constructors

ModelMetadata(ModelMetadataProvider, Type, Func<Object>, Type, String) ModelMetadata(ModelMetadataProvider, Type, Func<Object>, Type, String) ModelMetadata(ModelMetadataProvider, Type, Func<Object>, Type, String) ModelMetadata(ModelMetadataProvider, Type, Func<Object>, Type, String)

Initializes a new instance of the ModelMetadata class.

Fields

DefaultOrder DefaultOrder DefaultOrder DefaultOrder

An integer value that is always set to 10000.

Properties

AdditionalValues AdditionalValues AdditionalValues AdditionalValues

Gets a collection that contains additional metadata about the model.

ContainerType ContainerType ContainerType ContainerType

Gets the type of the container.

ConvertEmptyStringToNull ConvertEmptyStringToNull ConvertEmptyStringToNull ConvertEmptyStringToNull

Gets or sets a value that determines whether empty strings that are submitted in forms should be converted to null.

DataTypeName DataTypeName DataTypeName DataTypeName

Gets or sets the name of the data type.

Description Description Description Description

Gets or sets text that describes the model.

DisplayFormatString DisplayFormatString DisplayFormatString DisplayFormatString

Gets or sets a format string that should be applied when the model is displayed in display mode (as opposed to in edit mode).

DisplayName DisplayName DisplayName DisplayName

Gets or sets the text to use in UI when the name of the model is displayed.

EditFormatString EditFormatString EditFormatString EditFormatString

Gets or sets the format string to use in UI in edit mode.

HideSurroundingHtml HideSurroundingHtml HideSurroundingHtml HideSurroundingHtml

Gets or sets a value that determines whether surrounding HTML should be hidden.

IsComplexType IsComplexType IsComplexType IsComplexType

Gets a value that specifies whether the model is a complex type.

IsNullableValueType IsNullableValueType IsNullableValueType IsNullableValueType

Gets a value that specifies whether the model is a nullable value type.

IsReadOnly IsReadOnly IsReadOnly IsReadOnly

Gets or sets a value that specifies whether the model can be updated.

IsRequired IsRequired IsRequired IsRequired

Gets or sets a value that specifies whether the property is required.

Model Model Model Model

Gets or sets the model object.

ModelType ModelType ModelType ModelType

Gets the type of the model.

NullDisplayText NullDisplayText NullDisplayText NullDisplayText

Gets the string that should be displayed when the model is null.

Order Order Order Order

Gets or sets an integer that indicates the order in which to display this property relative to other properties.

Properties Properties Properties Properties

Gets a collection of model metadata objects that describe the properties of the model.

PropertyName PropertyName PropertyName PropertyName

Gets the name of the property.

Provider Provider Provider Provider

Gets or sets the provider object for this metadata.

RequestValidationEnabled RequestValidationEnabled RequestValidationEnabled RequestValidationEnabled

Gets or sets a value that specifies whether request validation is enabled.

ShortDisplayName ShortDisplayName ShortDisplayName ShortDisplayName

Gets or sets a short version of the display name.

ShowForDisplay ShowForDisplay ShowForDisplay ShowForDisplay

Gets or sets a value that specifies whether the model should be displayed in the UI in display mode (as opposed to edit mode).

ShowForEdit ShowForEdit ShowForEdit ShowForEdit

Gets or sets a value that specifies whether the property should be displayed in edit mode (as opposed to display mode).

SimpleDisplayText SimpleDisplayText SimpleDisplayText SimpleDisplayText

Gets or sets text to display for the model when the model represents a complex object

TemplateHint TemplateHint TemplateHint TemplateHint

Gets or sets a value that indicates what template (data control) should be used in UI for the model.

Watermark Watermark Watermark Watermark

Gets or sets watermark text for a text box.

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetDisplayName() GetDisplayName() GetDisplayName() GetDisplayName()

Returns text to display as the name of the model in UI.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetSimpleDisplayText() GetSimpleDisplayText() GetSimpleDisplayText() GetSimpleDisplayText()

Returns text to display for the model when the model represents a complex object.

GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetValidators(ModelBindingExecutionContext) GetValidators(ModelBindingExecutionContext) GetValidators(ModelBindingExecutionContext) GetValidators(ModelBindingExecutionContext)

Returns a collection of validators that apply to the model.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to