DataObjectFieldAttribute Класс

Определение

Предоставляет метаданные для свойства, представляющего поле данных.Provides metadata for a property representing a data field. Этот класс не наследуется.This class cannot be inherited.

public ref class DataObjectFieldAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Property)]
public sealed class DataObjectFieldAttribute : Attribute
type DataObjectFieldAttribute = class
    inherit Attribute
Public NotInheritable Class DataObjectFieldAttribute
Inherits Attribute
Наследование
DataObjectFieldAttribute
Атрибуты

Примеры

В следующем примере кода показано, DataObjectFieldAttribute как можно применить к общедоступному свойству для указания метаданных, связанных со свойством.The following code example demonstrates how you can apply the DataObjectFieldAttribute to a publicly exposed property to identify metadata associated with the property. В этом примере NorthwindEmployee тип предоставляет три свойства данных: EmployeeID, FirstNameи LastName.In this example the NorthwindEmployee type exposes three data properties: EmployeeID, FirstName, and LastName. Атрибут применяется ко всем трем свойствам, однако EmployeeID только атрибут property указывает, что это первичный ключ для строки данных. DataObjectFieldAttributeThe DataObjectFieldAttribute attribute is applied to all three properties; however, only the EmployeeID property attribute indicates it is the primary key for the data row.

public class NorthwindEmployee
{
  public NorthwindEmployee() { }

  private int _employeeID;
  [DataObjectFieldAttribute(true, true, false)]
  public int EmployeeID
  {
    get { return _employeeID; }
    set { _employeeID = value; }
  }

  private string _firstName = String.Empty;
  [DataObjectFieldAttribute(false, false, true)]
  public string FirstName
  {
    get { return _firstName; }
    set { _firstName = value; }
  }

  private string _lastName = String.Empty;
  [DataObjectFieldAttribute(false, false, true)]
  public string LastName
  {
    get { return _lastName; }
    set { _lastName = value; }
  }
}
Public Class NorthwindEmployee

  Public Sub New()
  End Sub

  Private _employeeID As Integer
  <DataObjectFieldAttribute(True, True, False)> _
  Public Property EmployeeID() As Integer
    Get
      Return _employeeID
    End Get
    Set(ByVal value As Integer)
      _employeeID = value
    End Set
  End Property

  Private _firstName As String = String.Empty
  <DataObjectFieldAttribute(False, False, False)> _
  Public Property FirstName() As String
    Get
      Return _firstName
    End Get
    Set(ByVal value As String)
      _firstName = value
    End Set
  End Property

  Private _lastName As String = String.Empty
  <DataObjectFieldAttribute(False, False, False)> _
  Public Property LastName() As String
    Get
      Return _lastName
    End Get
    Set(ByVal value As String)
      _lastName = value
    End Set
  End Property

End Class

Комментарии

DataObjectFieldAttribute Используйте атрибут для предоставления сведений о схеме базовых данных.Use the DataObjectFieldAttribute attribute to provide information about the schema of the underlying data. Классы времени разработки, такие как класс ObjectDataSourceDesigner , DataObjectAttribute используют атрибут для задания свойств во время разработки на основе предоставленной схемы.Design-time classes such as the ObjectDataSourceDesigner class use the DataObjectAttribute attribute to set properties at design-time based on the exposed schema.

DataObjectFieldAttribute Атрибут применяется к членам объектов элементов данных, возвращаемых методом Select объекта, помеченного DataObjectAttribute атрибутом.You apply the DataObjectFieldAttribute attribute to members of the data item objects that are returned by the Select method of an object marked with the DataObjectAttribute attribute. В следующем NorthwindData примере класс помечен IEnumerable DataObjectAttribute атрибутом и возвращает объект, содержащий NorthwindEmployee объекты из GetAllEmployees метода.In the following example, the NorthwindData class is marked with the DataObjectAttribute attribute, and returns an IEnumerable object containing NorthwindEmployee objects from the GetAllEmployees method. Поля в NorthwindEmployee классе помечаются DataObjectFieldAttribute атрибутом, чтобы указать, что они представляют поля данных в базовом источнике данных.Fields in the NorthwindEmployee class are marked with the DataObjectFieldAttribute attribute to indicate they represent data fields in the underlying data source.

Дополнительные сведения об использовании атрибутов см. в разделе атрибуты.For more information about using attributes, see Attributes.

Конструкторы

DataObjectFieldAttribute(Boolean)

Выполняет инициализацию нового экземпляра класса DataObjectFieldAttribute и показывает, является ли поле первичным ключом для строки данных.Initializes a new instance of the DataObjectFieldAttribute class and indicates whether the field is the primary key for the data row.

DataObjectFieldAttribute(Boolean, Boolean)

Инициализирует новый экземпляр класса DataObjectFieldAttribute и показывает, является ли поле первичным ключом для строки данных и является ли это поле полем удостоверения базы данных.Initializes a new instance of the DataObjectFieldAttribute class and indicates whether the field is the primary key for the data row, and whether the field is a database identity field.

DataObjectFieldAttribute(Boolean, Boolean, Boolean)

Инициализирует новый экземпляр класса DataObjectFieldAttribute и показывает, является ли поле первичным ключом для строки данных, является ли оно полем удостоверения данных, и может ли оно принимать значение "null".Initializes a new instance of the DataObjectFieldAttribute class and indicates whether the field is the primary key for the data row, whether the field is a database identity field, and whether the field can be null.

DataObjectFieldAttribute(Boolean, Boolean, Boolean, Int32)

Инициализирует новый экземпляр класса DataObjectFieldAttribute и показывает, является ли поле первичным ключом для строки данных, является ли оно полем удостоверения данных, и может ли оно принимать значение "null", и задает длину поля.Initializes a new instance of the DataObjectFieldAttribute class and indicates whether the field is the primary key for the data row, whether it is a database identity field, and whether it can be null and sets the length of the field.

Свойства

IsIdentity

Возвращает значение, показывающее, представляет ли свойство поле удостоверения в базовых данных.Gets a value indicating whether a property represents an identity field in the underlying data.

IsNullable

Возвращает значение, показывающее, представляет ли свойство поле, которое может принимать значение "null" в базовом хранилище данных.Gets a value indicating whether a property represents a field that can be null in the underlying data store.

Length

Возвращает длину свойства в байтах.Gets the length of the property in bytes.

PrimaryKey

Возвращает значение, показывающее, входит ли свойство в первичный ключ базовых данных.Gets a value indicating whether a property is in the primary key in the underlying data.

TypeId

При реализации в производном классе возвращает уникальный идентификатор для этого Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Унаследовано от Attribute)

Методы

Equals(Object)

Возвращает значение, показывающее, равен ли данный экземпляр заданному объекту.Returns a value indicating whether this instance is equal to a specified object.

GetHashCode()

Возвращает хэш-код данного экземпляра.Returns the hash code for this instance.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Унаследовано от Attribute)
Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Унаследовано от Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Явные реализации интерфейса

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Унаследовано от Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Унаследовано от Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Унаследовано от Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Унаследовано от Attribute)

Применяется к