PrimaryLabelAttribute Class

Defines an attribute that will define the field name that best represents the row identification to a user.

Inheritance Hierarchy

SystemObject
SystemAttribute
GSF.ComponentModel.DataAnnotationsPrimaryLabelAttribute

Namespace: GSF.ComponentModel.DataAnnotations
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.205-beta+5ef4169f3b1079d8b163dd363614f656bd140924

Syntax

C++

JavaScript

Copy

[AttributeUsageAttribute(AttributeTargets.Class)]
public sealed class PrimaryLabelAttribute : Attribute

<AttributeUsageAttribute(AttributeTargets.Class)>
Public NotInheritable Class PrimaryLabelAttribute
	Inherits Attribute

[AttributeUsageAttribute(AttributeTargets::Class)]
public ref class PrimaryLabelAttribute sealed : public Attribute

[<SealedAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Class)>]
type PrimaryLabelAttribute = 
    class
        inherit Attribute
    end

GSF.ComponentModel.DataAnnotations.PrimaryLabelAttribute = function();

Type.createClass(
	'GSF.ComponentModel.DataAnnotations.PrimaryLabelAttribute',
	Attribute);

View Source

The PrimaryLabelAttribute type exposes the following members.

Constructors

	Name	Description
	PrimaryLabelAttribute	Creates a new PrimaryLabelAttribute.

Top

Properties

	Name	Description
	FieldName	Field name used as primary label.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Top

Methods

	Name	Description
	Equals	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Remarks

An example of when this would be used is during a record deletion confirmation, e.g: Are you sure you want to delete "PrimaryLabel.FieldName.Value"?

Reference

GSF.ComponentModel.DataAnnotations Namespace