ModelMetadata Class
TOC
Collapse the table of content
Expand the table of content

ModelMetadata Class

.NET Framework (current version)
 

Provides a container for metadata for a model.

Namespace:   System.Web.ModelBinding
Assembly:  System.Web (in System.Web.dll)


public class ModelMetadata

NameDescription
System_CAPS_pubmethodModelMetadata(ModelMetadataProvider, Type, Func<Object>, Type, String)

Initializes a new instance of the ModelMetadata class.

NameDescription
System_CAPS_pubpropertyAdditionalValues

Gets a collection that contains additional metadata about the model.

System_CAPS_pubpropertyContainerType

Gets the type of the container.

System_CAPS_pubpropertyConvertEmptyStringToNull

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

System_CAPS_pubpropertyDataTypeName

Gets or sets the name of the data type.

System_CAPS_pubpropertyDescription

Gets or sets text that describes the model.

System_CAPS_pubpropertyDisplayFormatString

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

System_CAPS_pubpropertyDisplayName

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

System_CAPS_pubpropertyEditFormatString

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

System_CAPS_pubpropertyHideSurroundingHtml

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

System_CAPS_pubpropertyIsComplexType

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

System_CAPS_pubpropertyIsNullableValueType

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

System_CAPS_pubpropertyIsReadOnly

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

System_CAPS_pubpropertyIsRequired

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

System_CAPS_pubpropertyModel

Gets or sets the model object.

System_CAPS_pubpropertyModelType

Gets the type of the model.

System_CAPS_pubpropertyNullDisplayText

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

System_CAPS_pubpropertyOrder

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

System_CAPS_pubpropertyProperties

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

System_CAPS_pubpropertyPropertyName

Gets the name of the property.

System_CAPS_protpropertyProvider

Gets or sets the provider object for this metadata.

System_CAPS_pubpropertyRequestValidationEnabled

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

System_CAPS_pubpropertyShortDisplayName

Gets or sets a short version of the display name.

System_CAPS_pubpropertyShowForDisplay

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

System_CAPS_pubpropertyShowForEdit

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

System_CAPS_pubpropertySimpleDisplayText

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

System_CAPS_pubpropertyTemplateHint

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

System_CAPS_pubpropertyWatermark

Gets or sets watermark text for a text box.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from 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_pubmethodGetDisplayName()

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

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_protmethodGetSimpleDisplayText()

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

System_CAPS_pubmethodGetType()

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

System_CAPS_pubmethodGetValidators(ModelBindingExecutionContext)

Returns a collection of validators that apply to the model.

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_pubfieldSystem_CAPS_staticDefaultOrder

An integer value that is always set to 10000.

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.

.NET Framework
Available since 4.5

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:
© 2016 Microsoft