Article
11/18/2011

EditableAttribute Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Specifies whether users should be able to change the value of the entity property.

Inheritance Hierarchy

System.Object
System.Attribute
System.ComponentModel.DataAnnotations.EditableAttribute

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field, AllowMultiple := False,  _
    Inherited := True)> _
Public NotInheritable Class EditableAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = false, 
    Inherited = true)]
public sealed class EditableAttribute : Attribute

The EditableAttribute type exposes the following members.

Constructors

	Name	Description
	EditableAttribute	Initializes a new instance of the EditableAttribute class.

Top

Properties

	Name	Description
	AllowEdit	Gets a value that indicates whether a client application should allow users to change the value of the property.
	AllowInitialValue	Gets or sets a value that indicates whether users should be able to set a value for the property when adding a new record in the data set.

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

You apply the EditableAttribute attribute to an entity property to indicate whether the property is intended for editing by a user in a client application. The AllowEdit property indicates whether users should be allowed to change the existing value of a property. The AllowInitialValue property indicates whether users should be allowed to set a value for the property when inserting a new record. Setting either property to false does not functionally prevent the value from being edited or set to an initial value. You use this attribute to communicate to the client application how the property should be handled.

When creating a new instance of the EditableAttribute class, you provide a parameter value that is assigned to the AllowEdit property. Because you typically want both properties to contain the same value, the AllowInitialValue property is set to the value of AllowEdit in the class constructor. You can modify this behavior by explicitly setting the value of the AllowInitialValue property.

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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

Partager via