ControlValuePropertyAttribute Класс

Определение

Определяет используемое по умолчанию свойство элемента управления, к которому во время выполнения привязывается объект ControlParameter.Specifies the default property of a control that a ControlParameter object binds to at run time. Этот класс не наследуется.This class cannot be inherited.

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

Примеры

В следующем примере кода показано, как применить ControlValuePropertyAttribute атрибут, который задает свойство и значение по умолчанию для пользовательского элемента управления.The following code example demonstrates how to apply a ControlValuePropertyAttribute attribute that specifies a default property and value to a custom control.


using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Text;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace Samples.AspNet.CS.Controls
{
    // Set ControlValueProperty attribute to specify the default
    // property of this control that a ControlParameter object 
    // binds to at run time.
    [DefaultProperty("Text")]
    [ControlValueProperty("Text", "Default Text")]
    public class SimpleCustomControl : WebControl
    {
        private string text;

        [Bindable(true)]
        [Category("Appearance")]
        [DefaultValue("")]
        public string Text
        {
            get
            {
                return text;
            }
            set
            {
                text = value;
            }
        }

        protected override void Render(HtmlTextWriter output)
        {
            output.Write(Text);
        }
    }
}


Imports System.ComponentModel
Imports System.Web.UI

Namespace Samples.AspNet.VB.Controls

    ' Set ControlValueProperty attribute to specify the default
    ' property of this control that a ControlParameter object 
    ' binds to at run time.
    <DefaultProperty("Text"), ControlValueProperty("Text", "DefaultText")> Public Class SimpleCustomControl
        Inherits System.Web.UI.WebControls.WebControl

        Dim _text As String

        <Bindable(True), Category("Appearance"), DefaultValue("")> Property [Text]() As String
            Get
                Return _text
            End Get

            Set(ByVal Value As String)
                _text = Value
            End Set
        End Property

        Protected Overrides Sub Render(ByVal output As System.Web.UI.HtmlTextWriter)
            output.Write([Text])
        End Sub

    End Class

End Namespace

Комментарии

При определении ControlParameter объекта обычно свойство элемента управления привязывается к параметру путем задания ControlID PropertyName свойств и.When defining a ControlParameter object, you typically bind a control's property to a parameter by setting both the ControlID and PropertyName properties. Если PropertyName свойство не задано, используется свойство по умолчанию.If the PropertyName property is not set, a default property is used. ControlValuePropertyAttributeАтрибут применяется к элементу управления, чтобы указать свойство по умолчанию, ControlParameter к которому привязывается объект во время выполнения.The ControlValuePropertyAttribute attribute is applied to a control to specify its default property that a ControlParameter object binds to at run time.

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

Список начальных значений свойств для экземпляра класса ControlValuePropertyAttribute см. в описании конструктора ControlValuePropertyAttribute.For a list of initial property values for an instance of the ControlValuePropertyAttribute class, see the ControlValuePropertyAttribute constructor.

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

ControlValuePropertyAttribute(String)

Инициализирует новый экземпляр класса ControlValuePropertyAttribute с помощью указанного имени свойства.Initializes a new instance of the ControlValuePropertyAttribute class using the specified property name.

ControlValuePropertyAttribute(String, Object)

Выполняет инициализацию нового экземпляр класса ControlValuePropertyAttribute с заданными именем свойства и значением по умолчанию.Initializes a new instance of the ControlValuePropertyAttribute class using the specified property name and default value.

ControlValuePropertyAttribute(String, Type, String)

Выполняет инициализацию нового экземпляр класса ControlValuePropertyAttribute с заданными именем свойства и значением по умолчанию.Initializes a new instance of the ControlValuePropertyAttribute class using the specified property name and default value. Используемое по умолчанию значение преобразовывается в указанный тип данных.The default value is also converted to the specified data type.

Свойства

DefaultValue

Возвращает значение по умолчанию для используемого по умолчанию свойства элемента управления.Gets the default value for the default property of a control.

Name

Возвращает свойство, используемое по умолчанию для элемента управления.Gets the default property for a control.

TypeId

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

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

Методы

Equals(Object)

Определяет равенство текущего экземпляра объекта ControlValuePropertyAttribute с указанным объектом.Determines whether the current instance of the ControlValuePropertyAttribute object is equal to the 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)

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

См. также раздел