Article
11/18/2011

DisplayColumnAttribute Class

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

Designates the property to display, the property to use for sorting, and the sort order when a table is used as a parent table in a foreign key relationship.

Inheritance Hierarchy

System.Object
System.Attribute
System.ComponentModel.DataAnnotations.DisplayColumnAttribute

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, Inherited := True, AllowMultiple := False)> _
Public Class DisplayColumnAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Class, Inherited = true, AllowMultiple = false)]
public class DisplayColumnAttribute : Attribute

The DisplayColumnAttribute type exposes the following members.

Constructors

	Name	Description
	DisplayColumnAttribute(String)	Initializes a new instance of the DisplayColumnAttribute class with the specified column to display.
	DisplayColumnAttribute(String, String)	Initializes a new instance of the DisplayColumnAttribute class with the specified display column and the specified sort column.
	DisplayColumnAttribute(String, String, Boolean)	Initializes a new instance of the DisplayColumnAttribute class with the specified display column, sort column, and sort order.

Top

Properties

	Name	Description
	DisplayColumn	Gets the name of the column to the display.
	SortColumn	Gets the name of the column to use for sorting.
	SortDescending	Gets a value that indicates whether the data is sorted in descending order.

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 DisplayColumnAttribute attribute to an entity class to specify the behavior for a class with a foreign key relationship to another class. You apply this attribute to the class that acts as the parent in the foreign key relationship. You can specify the property to use for displaying the foreign key relationship, the property to use for sorting, and the sort order. The properties you specify are properties within the parent class, not the related class.

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.

Share via