DesignerActionPropertyItem Класс

Определение

Представляет элемент области, сопоставленный со свойством в классе, производном от класса DesignerActionList.Represents a panel item that is associated with a property in a class derived from DesignerActionList. Этот класс не наследуется.This class cannot be inherited.

public ref class DesignerActionPropertyItem sealed : System::ComponentModel::Design::DesignerActionItem
public sealed class DesignerActionPropertyItem : System.ComponentModel.Design.DesignerActionItem
type DesignerActionPropertyItem = class
    inherit DesignerActionItem
Public NotInheritable Class DesignerActionPropertyItem
Inherits DesignerActionItem
Наследование
DesignerActionPropertyItem

Примеры

В следующем примере кода показано, как создать коллекцию DesignerActionItem объектов.The following code example demonstrates how to create a collection of DesignerActionItem objects. Полный пример реализации смарт-тегов см. в разделе как Присоединение смарт-тегов к компонентуWindows Forms.For a full example of implementing smart tags, see How to: Attach Smart Tags to a Windows Forms Component.

public override DesignerActionItemCollection GetSortedActionItems()
{
    DesignerActionItemCollection items = new DesignerActionItemCollection();

    //Define static section header entries.
    items.Add(new DesignerActionHeaderItem("Appearance"));
    items.Add(new DesignerActionHeaderItem("Information"));

    //Boolean property for locking color selections.
    items.Add(new DesignerActionPropertyItem("LockColors",
                     "Lock Colors", "Appearance",
                     "Locks the color properties."));
    if (!LockColors)
    {
        items.Add(new DesignerActionPropertyItem("BackColor",
                         "Back Color", "Appearance",
                         "Selects the background color."));
        items.Add(new DesignerActionPropertyItem("ForeColor",
                         "Fore Color", "Appearance",
                         "Selects the foreground color."));

        //This next method item is also added to the context menu 
        // (as a designer verb).
        items.Add(new DesignerActionMethodItem(this,
                         "InvertColors", "Invert Colors",
                         "Appearance",
                         "Inverts the fore and background colors.",
                          true));
    }
    items.Add(new DesignerActionPropertyItem("Text",
                     "Text String", "Appearance",
                     "Sets the display text."));

    //Create entries for static Information section.
    StringBuilder location = new StringBuilder("Location: ");
    location.Append(colLabel.Location);
    StringBuilder size = new StringBuilder("Size: ");
    size.Append(colLabel.Size);
    items.Add(new DesignerActionTextItem(location.ToString(),
                     "Information"));
    items.Add(new DesignerActionTextItem(size.ToString(),
                     "Information"));

    return items;
}
Public Overrides Function GetSortedActionItems() _
As DesignerActionItemCollection
    Dim items As New DesignerActionItemCollection()

    'Define static section header entries.
    items.Add(New DesignerActionHeaderItem("Appearance"))
    items.Add(New DesignerActionHeaderItem("Information"))

    'Boolean property for locking color selections.
    items.Add(New DesignerActionPropertyItem( _
    "LockColors", _
    "Lock Colors", _
    "Appearance", _
    "Locks the color properties."))

    If Not LockColors Then
        items.Add( _
        New DesignerActionPropertyItem( _
        "BackColor", _
        "Back Color", _
        "Appearance", _
        "Selects the background color."))

        items.Add( _
        New DesignerActionPropertyItem( _
        "ForeColor", _
        "Fore Color", _
        "Appearance", _
        "Selects the foreground color."))

        'This next method item is also added to the context menu 
        ' (as a designer verb).
        items.Add( _
        New DesignerActionMethodItem( _
        Me, _
        "InvertColors", _
        "Invert Colors", _
        "Appearance", _
        "Inverts the fore and background colors.", _
        True))
    End If
    items.Add( _
    New DesignerActionPropertyItem( _
    "Text", _
    "Text String", _
    "Appearance", _
    "Sets the display text."))

    'Create entries for static Information section.
    Dim location As New StringBuilder("Location: ")
    location.Append(colLabel.Location)
    Dim size As New StringBuilder("Size: ")
    size.Append(colLabel.Size)

    items.Add( _
    New DesignerActionTextItem( _
    location.ToString(), _
    "Information"))

    items.Add( _
    New DesignerActionTextItem( _
    size.ToString(), _
    "Information"))

    Return items
End Function

Комментарии

DesignerActionPropertyItem Класс представляет отдельные элементы в области смарт-тега.The DesignerActionPropertyItem class represents individual items in a smart tag panel. Каждый элемент обычно связывается со свойством в классе, который является производным от DesignerActionList класса и предоставляется автором компонента.Each item is typically associated with a property in a class that is derived from the DesignerActionList class and supplied by the component author. Ассоциация поддерживается с помощью имени свойства, как оно хранится в MemberName свойстве.The association is maintained through the name of the property, as stored in the MemberName property.

Отдельные элементы панели связаны друг с другом, образуя панель с помощью вызова GetSortedActionItems метода DesignerActionList класса.Individual panel items are associated together to form a panel by a call to the GetSortedActionItems method of the DesignerActionList class.

Чтобы отобразить значение связанного свойства, это свойство должно иметь get метод доступа; Чтобы разрешить редактирование, свойство должно set иметь метод доступа.To display the value of the associated property, that property must have a get accessor method; to allow editing, the property must have a set accessor method. Способ, которым панель разрешает непосредственное редактирование элемента свойства пользователем, зависит от сведений о вспомогательном типе, имеющихся для типа данных связанного свойства.The way in which the panel allows direct editing of a property item by the user depends on the supporting type information present for the data type of the associated property. В следующей таблице показана вероятная схема.The following table shows the likely scheme.

Сведения о типе свойстваProperty type information Пользовательский интерфейс редактирования элемента свойстваProperty item editing user interface (UI)
Имеет связанный редактор типов (UITypeEditor)Has an associated type editor (UITypeEditor) Редактор типов, связанный с базовым свойством, отображается для изменения значения свойства.The type editor associated with the underlying property is displayed for editing the property's value.
Имеет связанный преобразователь типов для известного типа (TypeConverter)Has an associated type converter to a known type (TypeConverter) Редактор типов для известного типа отображается для изменения значения свойства.The type editor for the known type is displayed for editing the property's value. Например, преобразователь String типов может TextBoxотображать.For example, a type converter to String will likely display a TextBox.
Логическое значениеBoolean value Элемент отображается с помощью двоичного пользовательского интерфейса, например галочки.The item is displayed using a binary UI, such as a check mark.
Ни один из указанных выше.None of the above. Элемент отображается как неизменяемая текстовая строка с помощью ToString метода типа данных.The item is displayed as a non-editable text string using the data type's ToString method.

Все фундаментальные типы, такие System.Booleanкак, и .NET Framework.NET Framework общие типы данных, такие System.Stringкак, предоставляют стандартные преобразователи типов и редакторы.All fundamental types, such as System.Boolean, and common .NET Framework.NET Framework data types, such as System.String, supply standard type converters and editors. Дополнительные сведения о преобразователях типов см. в разделе как Реализуйте преобразователь типов или Обобщенное преобразование типов.For more information about type converters, see How to: Implement a Type Converter or Generalized Type Conversion. Дополнительные сведения о редакторах типов см. в разделе как Реализуйте редактортипов пользовательского интерфейса.For more information about type editors, see How to: Implement a UI Type Editor.

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

DesignerActionPropertyItem(String, String)

Инициализирует новый экземпляр класса DesignerActionPropertyItem с заданным именем свойства и отображаемым именем.Initializes a new instance of the DesignerActionPropertyItem class, with the specified property and display names.

DesignerActionPropertyItem(String, String, String)

Инициализирует новый экземпляр класса DesignerActionPropertyItem с заданными именами свойства и категории, а также отображаемым текстом.Initializes a new instance of the DesignerActionPropertyItem class, with the specified property and category names, and display text.

DesignerActionPropertyItem(String, String, String, String)

Инициализирует новый экземпляр класса DesignerActionPropertyItem с заданными именами свойства и категории, а также отображаемым текстом и описанием.Initializes a new instance of the DesignerActionPropertyItem class, with the specified property and category names, and display and description text.

Свойства

AllowAssociate

Получает или задает значение, указывающее, разрешается ли поместить этот элемент в группу элементов с одинаковыми значениями свойств Category.Gets or sets a value indicating whether to allow this item to be placed into a group of items that have the same Category property value.

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

Возвращает имя группы для элемента.Gets the group name for an item.

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

Возвращает дополняющий текст для элемента.Gets the supplemental text for the item.

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

Получает текст для данного элемента.Gets the text for this item.

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

Возвращает имя свойства, которому сопоставлен данный элемент.Gets the name of the property that this item is associated with.

Properties

Возвращает ссылку на коллекцию, которая может использоваться для хранения определенных программистом пар ключ/значение.Gets a reference to a collection that can be used to store programmer-defined key/value pairs.

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

Получает или задает компонент, элементы которого помещаются в текущую область.Gets or sets a component that contributes its items to the current panel.

ShowInSourceView

Получает или задает значение, указывающее, отображается ли данный элемент в представлении исходного кода.Gets or sets a value that indicates whether this item appears in source code view.

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

Методы

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

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

Служит в качестве хэш-функции по умолчанию.Serves as the default hash function.

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

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

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

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

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

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

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

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

Дополнительно