1<?xml version="1.0" encoding="utf-8"?>
2<Type Name="DesignerActionPropertyItem" FullName="System.ComponentModel.Design.DesignerActionPropertyItem">
3  <TypeSignature Language="C#" Value="public sealed class DesignerActionPropertyItem : System.ComponentModel.Design.DesignerActionItem" />
4  <AssemblyInfo>
5    <AssemblyName>System.Design</AssemblyName>
6    <AssemblyVersion>2.0.0.0</AssemblyVersion>
7  </AssemblyInfo>
8  <Base>
9    <BaseTypeName>System.ComponentModel.Design.DesignerActionItem</BaseTypeName>
10  </Base>
11  <Interfaces />
12  <Docs>
13    <remarks>
14      <attribution license="cc4" from="Microsoft" modified="false" />
15      <para>The <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> class represents individual items in a smart tag panel. Each item is typically associated with a property in a class that is derived from the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class and supplied by the component author. The association is maintained through the name of the property, as stored in the <see cref="P:System.ComponentModel.Design.DesignerActionPropertyItem.MemberName" /> property. </para>
16      <para>Individual panel items are associated together to form a panel by a call to the <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method of the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class.</para>
17      <para>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.</para>
18      <list type="table">
19        <listheader>
20          <item>
21            <term>
22              <para>Property type information</para>
23            </term>
24            <description>
25              <para>Property item editing user interface (UI)</para>
26            </description>
27          </item>
28        </listheader>
29        <item>
30          <term>
31            <para>Has an associated type editor (<see cref="T:System.Drawing.Design.UITypeEditor" />)</para>
32          </term>
33          <description>
34            <para>The type editor associated with the underlying property is displayed for editing the property's value.</para>
35          </description>
36        </item>
37        <item>
38          <term>
39            <para>Has an associated type converter to a known type (<see cref="T:System.ComponentModel.TypeConverter" />)</para>
40          </term>
41          <description>
42            <para>The type editor for the known type is displayed for editing the property's value. For example, a type converter to <see cref="T:System.String" /> will likely display a <see cref="T:System.Windows.Forms.TextBox" />.</para>
43          </description>
44        </item>
45        <item>
46          <term>
47            <para>Boolean value</para>
48          </term>
49          <description>
50            <para>The item is displayed using a binary UI, such as a check mark. </para>
51          </description>
52        </item>
53        <item>
54          <term>
55            <para>None of the above.</para>
56          </term>
57          <description>
58            <para>The item is displayed as a non-editable text string using the data type's <see cref="M:System.Object.ToString" /> method.</para>
59          </description>
60        </item>
61      </list>
62      <para>All fundamental types, such as <see cref="T:System.Boolean" />, and common dnprdnshort data types, such as <see cref="T:System.String" />, supply standard type converters and editors. For more information about type converters, see <format type="text/html"><a href="90373a3f-d8c8-492d-841c-945d62393c56">How to: Implement a Type Converter</a></format> or <format type="text/html"><a href="49253ae6-7657-4810-82ab-1176a6feeada">Generalized Type Conversion</a></format>. For more information about type editors, see <format type="text/html"><a href="ed961fb9-ee02-4666-b511-05f3204bb75c">How to: Implement a UI Type Editor</a></format>.</para>
63    </remarks>
64    <summary>
65      <attribution license="cc4" from="Microsoft" modified="false" />
66      <para>Represents a panel item that is associated with a property in a class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" />. This class cannot be inherited.</para>
67    </summary>
68  </Docs>
69  <Members>
70    <Member MemberName=".ctor">
71      <MemberSignature Language="C#" Value="public DesignerActionPropertyItem (string memberName, string displayName);" />
72      <MemberType>Constructor</MemberType>
73      <AssemblyInfo>
74        <AssemblyVersion>2.0.0.0</AssemblyVersion>
75      </AssemblyInfo>
76      <Parameters>
77        <Parameter Name="memberName" Type="System.String" />
78        <Parameter Name="displayName" Type="System.String" />
79      </Parameters>
80      <Docs>
81        <remarks>
82          <attribution license="cc4" from="Microsoft" modified="false" />
83          <para>The <see cref="M:System.ComponentModel.Design.DesignerActionPropertyItem.#ctor(System.String,System.String)" /> constructor sets the <see cref="P:System.ComponentModel.Design.DesignerActionItem.Category" /> and <see cref="P:System.ComponentModel.Design.DesignerActionItem.Description" /> properties to null.</para>
84          <para>The <paramref name="memberName" /> parameter refers to the name of the associated property that is a member of the programmer-supplied class derived from the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class.</para>
85        </remarks>
86        <summary>
87          <attribution license="cc4" from="Microsoft" modified="false" />
88          <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> class, with the specified property and display names.</para>
89        </summary>
90        <param name="memberName">
91          <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive name of the property associated with this panel item.</param>
92        <param name="displayName">
93          <attribution license="cc4" from="Microsoft" modified="false" />The panel text for this item.</param>
94      </Docs>
95    </Member>
96    <Member MemberName=".ctor">
97      <MemberSignature Language="C#" Value="public DesignerActionPropertyItem (string memberName, string displayName, string category);" />
98      <MemberType>Constructor</MemberType>
99      <AssemblyInfo>
100        <AssemblyVersion>2.0.0.0</AssemblyVersion>
101      </AssemblyInfo>
102      <Parameters>
103        <Parameter Name="memberName" Type="System.String" />
104        <Parameter Name="displayName" Type="System.String" />
105        <Parameter Name="category" Type="System.String" />
106      </Parameters>
107      <Docs>
108        <remarks>
109          <attribution license="cc4" from="Microsoft" modified="false" />
110          <para>The <see cref="M:System.ComponentModel.Design.DesignerActionPropertyItem.#ctor(System.String,System.String,System.String)" /> constructor sets the <see cref="P:System.ComponentModel.Design.DesignerActionItem.Description" /> property to null.</para>
111          <para>For more information about how the <paramref name="category" /> parameter is used to group items on a panel, see the <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method.</para>
112          <para>The <paramref name="memberName" /> parameter refers to the name of the associated property that is a member of the programmer-supplied class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" />.</para>
113        </remarks>
114        <summary>
115          <attribution license="cc4" from="Microsoft" modified="false" />
116          <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> class, with the specified property and category names, and display text.</para>
117        </summary>
118        <param name="memberName">
119          <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive name of the property associated with this panel item.</param>
120        <param name="displayName">
121          <attribution license="cc4" from="Microsoft" modified="false" />The panel text for this item.</param>
122        <param name="category">
123          <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive <see cref="T:System.String" /> used to group similar items on the panel.</param>
124      </Docs>
125    </Member>
126    <Member MemberName=".ctor">
127      <MemberSignature Language="C#" Value="public DesignerActionPropertyItem (string memberName, string displayName, string category, string description);" />
128      <MemberType>Constructor</MemberType>
129      <AssemblyInfo>
130        <AssemblyVersion>2.0.0.0</AssemblyVersion>
131      </AssemblyInfo>
132      <Parameters>
133        <Parameter Name="memberName" Type="System.String" />
134        <Parameter Name="displayName" Type="System.String" />
135        <Parameter Name="category" Type="System.String" />
136        <Parameter Name="description" Type="System.String" />
137      </Parameters>
138      <Docs>
139        <remarks>
140          <attribution license="cc4" from="Microsoft" modified="false" />
141          <para>For more information about how the <paramref name="category" /> parameter is used to group items on a panel, see the <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method.</para>
142          <para>The <paramref name="memberName" /> parameter refers to the name of the associated property that is a member of the programmer-supplied class derived from the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class.</para>
143        </remarks>
144        <summary>
145          <attribution license="cc4" from="Microsoft" modified="false" />
146          <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> class, with the specified property and category names, and display and description text.</para>
147        </summary>
148        <param name="memberName">
149          <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive name of the property associated with this panel item.</param>
150        <param name="displayName">
151          <attribution license="cc4" from="Microsoft" modified="false" />The panel text for this item.</param>
152        <param name="category">
153          <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive <see cref="T:System.String" /> used to group similar items on the panel.</param>
154        <param name="description">
155          <attribution license="cc4" from="Microsoft" modified="false" />Supplemental text for this item, used in ToolTips or the status bar.</param>
156      </Docs>
157    </Member>
158    <Member MemberName="MemberName">
159      <MemberSignature Language="C#" Value="public string MemberName { get; }" />
160      <MemberType>Property</MemberType>
161      <AssemblyInfo>
162        <AssemblyVersion>2.0.0.0</AssemblyVersion>
163      </AssemblyInfo>
164      <ReturnValue>
165        <ReturnType>System.String</ReturnType>
166      </ReturnValue>
167      <Docs>
168        <value>To be added.</value>
169        <remarks>
170          <attribution license="cc4" from="Microsoft" modified="false" />
171          <para>The <see cref="P:System.ComponentModel.Design.DesignerActionPropertyItem.MemberName" /> property specifies which property—in the class derived from the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class—the item should be bound to. When the programmer interacts with the panel item through the user interface (UI), this associated property will be set.</para>
172          <para>
173            <see cref="P:System.ComponentModel.Design.DesignerActionPropertyItem.MemberName" /> is set in the constructor. Its value is case-sensitive.</para>
174        </remarks>
175        <summary>
176          <attribution license="cc4" from="Microsoft" modified="false" />
177          <para>Gets the name of the property that this item is associated with.</para>
178        </summary>
179      </Docs>
180    </Member>
181    <Member MemberName="RelatedComponent">
182      <MemberSignature Language="C#" Value="public System.ComponentModel.IComponent RelatedComponent { set; get; }" />
183      <MemberType>Property</MemberType>
184      <AssemblyInfo>
185        <AssemblyVersion>2.0.0.0</AssemblyVersion>
186      </AssemblyInfo>
187      <ReturnValue>
188        <ReturnType>System.ComponentModel.IComponent</ReturnType>
189      </ReturnValue>
190      <Docs>
191        <value>To be added.</value>
192        <remarks>
193          <attribution license="cc4" from="Microsoft" modified="false" />
194          <para>With the <see cref="P:System.ComponentModel.Design.DesignerActionPropertyItem.RelatedComponent" /> property, another component can lend its pull-model panel items to the current list. For example, a user control might aggregate the <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> objects from one or more of its constituent controls.</para>
195          <para>This property works in conjunction with the <see cref="P:System.ComponentModel.Design.DesignerActionItem.AllowAssociate" /> property.</para>
196        </remarks>
197        <summary>
198          <attribution license="cc4" from="Microsoft" modified="false" />
199          <para>Gets or sets a component that contributes its items to the current panel.</para>
200        </summary>
201      </Docs>
202    </Member>
203  </Members>
204</Type>