1<?xml version="1.0" encoding="utf-8"?>
2<Type Name="DesignerActionItem" FullName="System.ComponentModel.Design.DesignerActionItem">
3  <TypeSignature Language="C#" Value="public abstract class DesignerActionItem" />
4  <AssemblyInfo>
5    <AssemblyName>System.Design</AssemblyName>
6    <AssemblyVersion>2.0.0.0</AssemblyVersion>
7  </AssemblyInfo>
8  <Base>
9    <BaseTypeName>System.Object</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.DesignerActionItem" /> class serves as an abstract base for classes that represent individual panel items in a smart tag panel, which represents a menu-like user interface (UI) for smart tags. The dnprdnshort supplies derived classes that represent the different common entries in a smart tag panel, including plain text, header text, properties and methods of the associated <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class, and designer verbs. </para>
16      <para>Typically, your DesignerAction feature is defined in a programmer-supplied class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" />, which contains a <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method that groups individual panel items together to form the smart tag panel. The <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> and <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> types are associated with members of the class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" />, and <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> objects are activated when their associated panel entry is selected by the user.</para>
17      <block subset="none" type="note">
18        <para>Forms and dialog boxes can be displayed by members of the class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" />. By default, the parent of these windows will be the container window for the smart tag panel. Explicitly parenting these child windows to another service or window may cause items to display improperly.</para>
19      </block>
20    </remarks>
21    <summary>
22      <attribution license="cc4" from="Microsoft" modified="false" />
23      <para>Provides the base class for types that represent a panel item on a smart tag panel.</para>
24    </summary>
25  </Docs>
26  <Members>
27    <Member MemberName=".ctor">
28      <MemberSignature Language="C#" Value="public DesignerActionItem (string displayName, string category, string description);" />
29      <MemberType>Constructor</MemberType>
30      <AssemblyInfo>
31        <AssemblyVersion>2.0.0.0</AssemblyVersion>
32      </AssemblyInfo>
33      <Parameters>
34        <Parameter Name="displayName" Type="System.String" />
35        <Parameter Name="category" Type="System.String" />
36        <Parameter Name="description" Type="System.String" />
37      </Parameters>
38      <Docs>
39        <remarks>
40          <attribution license="cc4" from="Microsoft" modified="false" />
41          <para>Because <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> is an abstract class, the <see cref="M:System.ComponentModel.Design.DesignerActionItem.#ctor(System.String,System.String,System.String)" /> constructor is intended to be called from derived classes only.</para>
42          <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>
43        </remarks>
44        <summary>
45          <attribution license="cc4" from="Microsoft" modified="false" />
46          <para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> class.</para>
47        </summary>
48        <param name="displayName">
49          <attribution license="cc4" from="Microsoft" modified="false" />The panel text for this item.</param>
50        <param name="category">
51          <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive <see cref="T:System.String" /> that defines the groupings of panel entries.</param>
52        <param name="description">
53          <attribution license="cc4" from="Microsoft" modified="false" />Supplemental text for this item, potentially used in ToolTips or the status bar.</param>
54      </Docs>
55    </Member>
56    <Member MemberName="AllowAssociate">
57      <MemberSignature Language="C#" Value="public bool AllowAssociate { set; get; }" />
58      <MemberType>Property</MemberType>
59      <AssemblyInfo>
60        <AssemblyVersion>2.0.0.0</AssemblyVersion>
61      </AssemblyInfo>
62      <ReturnValue>
63        <ReturnType>System.Boolean</ReturnType>
64      </ReturnValue>
65      <Docs>
66        <value>To be added.</value>
67        <remarks>
68          <attribution license="cc4" from="Microsoft" modified="false" />
69          <para>Because multiple <see cref="T:System.ComponentModel.Design.DesignerActionList" /> objects may be combined to form a single smart tag panel, the <see cref="P:System.ComponentModel.Design.DesignerActionItem.AllowAssociate" /> property indicates whether the current item can be rearranged by category.</para>
70          <para>The <see cref="P:System.ComponentModel.Design.DesignerActionItem.AllowAssociate" /> property is used in conjunction with the <see cref="P:System.ComponentModel.Design.DesignerActionMethodItem.RelatedComponent" /> property on the <see cref="T:System.ComponentModel.Design.DesignerActionMethodItem" /> and <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> types.</para>
71          <para>For example, ASP.NET uses a data-bound control like <see cref="T:System.Web.UI.WebControls.GridView" /> to connect to a data source control like <see cref="T:System.Web.UI.WebControls.SqlDataSource" />. Both have a <see cref="T:System.ComponentModel.Design.DesignerActionList" /> with its own set of <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> objects. The <see cref="T:System.Web.UI.WebControls.GridView" /> control has items like <see cref="P:System.Web.UI.WebControls.BaseDataBoundControl.DataSourceID" />, Edit Fields, and AutoFormat. The <see cref="T:System.Web.UI.WebControls.SqlDataSource" /> class has Configure and Refresh Items, which have <see cref="P:System.ComponentModel.Design.DesignerActionItem.AllowAssociate" /> set to true.</para>
72          <para>The <see cref="T:System.Web.UI.WebControls.GridView" /> control's <see cref="P:System.Web.UI.WebControls.BaseDataBoundControl.DataSourceID" /> item has a related component, which is the <see cref="T:System.Web.UI.WebControls.SqlDataSource" /> object. All the <see cref="T:System.Web.UI.WebControls.SqlDataSource" /> object's items that have <see cref="P:System.ComponentModel.Design.DesignerActionItem.AllowAssociate" /> set to true are automatically included in the <see cref="T:System.Web.UI.WebControls.GridView" /> control's action list. The following table shows how the two lists are merged in the <see cref="T:System.Web.UI.WebControls.GridView" /> control's designer action list.</para>
73          <list type="table">
74            <listheader>
75              <item>
76                <term>
77                  <para>GridView items</para>
78                </term>
79                <description>
80                  <para>SqlDataSource items</para>
81                </description>
82              </item>
83            </listheader>
84            <item>
85              <term>
86                <list type="bullet">
87                  <item>
88                    <para>DataSourceID (related component = SqlDataSource)</para>
89                  </item>
90                  <item>
91                    <para>Edit Fields</para>
92                  </item>
93                  <item>
94                    <para>AutoFormat</para>
95                  </item>
96                </list>
97              </term>
98              <description>
99                <list type="bullet">
100                  <item>
101                    <para>Configure (AllowAssociate = true)</para>
102                  </item>
103                  <item>
104                    <para>Refresh (AllowAssociate = true)</para>
105                  </item>
106                </list>
107              </description>
108            </item>
109          </list>
110          <list type="table">
111            <listheader>
112              <item>
113                <term>
114                  <para>Merged GridView control's smart tasks panel</para>
115                </term>
116              </item>
117            </listheader>
118            <item>
119              <term>
120                <list type="bullet">
121                  <item>
122                    <para>DataSourceID </para>
123                  </item>
124                  <item>
125                    <para>Configure </para>
126                  </item>
127                  <item>
128                    <para>Refresh </para>
129                  </item>
130                  <item>
131                    <para>Edit Fields</para>
132                  </item>
133                  <item>
134                    <para>AutoFormat</para>
135                  </item>
136                </list>
137              </term>
138            </item>
139          </list>
140        </remarks>
141        <summary>
142          <attribution license="cc4" from="Microsoft" modified="false" />
143          <para>Gets or sets a value indicating whether to allow this item to be placed into a group of items that have the same <see cref="P:System.ComponentModel.Design.DesignerActionItem.Category" /> property value.</para>
144        </summary>
145      </Docs>
146    </Member>
147    <Member MemberName="Category">
148      <MemberSignature Language="C#" Value="public virtual string Category { get; }" />
149      <MemberType>Property</MemberType>
150      <AssemblyInfo>
151        <AssemblyVersion>2.0.0.0</AssemblyVersion>
152      </AssemblyInfo>
153      <ReturnValue>
154        <ReturnType>System.String</ReturnType>
155      </ReturnValue>
156      <Docs>
157        <value>To be added.</value>
158        <remarks>
159          <attribution license="cc4" from="Microsoft" modified="false" />
160          <para>Item categories are defined by their names, which are case-sensitive.</para>
161          <para>For more information about how items are grouped by category, see the <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method.</para>
162        </remarks>
163        <summary>
164          <attribution license="cc4" from="Microsoft" modified="false" />
165          <para>Gets the group name for an item.</para>
166        </summary>
167      </Docs>
168    </Member>
169    <Member MemberName="Description">
170      <MemberSignature Language="C#" Value="public virtual string Description { get; }" />
171      <MemberType>Property</MemberType>
172      <AssemblyInfo>
173        <AssemblyVersion>2.0.0.0</AssemblyVersion>
174      </AssemblyInfo>
175      <ReturnValue>
176        <ReturnType>System.String</ReturnType>
177      </ReturnValue>
178      <Docs>
179        <value>To be added.</value>
180        <remarks>
181          <attribution license="cc4" from="Microsoft" modified="false" />
182          <para>The <see cref="P:System.ComponentModel.Design.DesignerActionItem.Description" /> property is used whenever a plain text description of the item is required (for example, in ToolTips and the status bar).</para>
183          <para>The value of this property is set in the constructor for this class. </para>
184        </remarks>
185        <summary>
186          <attribution license="cc4" from="Microsoft" modified="false" />
187          <para>Gets the supplemental text for the item.</para>
188        </summary>
189      </Docs>
190    </Member>
191    <Member MemberName="DisplayName">
192      <MemberSignature Language="C#" Value="public virtual string DisplayName { get; }" />
193      <MemberType>Property</MemberType>
194      <AssemblyInfo>
195        <AssemblyVersion>2.0.0.0</AssemblyVersion>
196      </AssemblyInfo>
197      <ReturnValue>
198        <ReturnType>System.String</ReturnType>
199      </ReturnValue>
200      <Docs>
201        <value>To be added.</value>
202        <remarks>
203          <attribution license="cc4" from="Microsoft" modified="false" />
204          <para>The value of the <see cref="P:System.ComponentModel.Design.DesignerActionItem.DisplayName" /> property is set in the constructor for this class.</para>
205        </remarks>
206        <summary>
207          <attribution license="cc4" from="Microsoft" modified="false" />
208          <para>Gets the text for this item.</para>
209        </summary>
210      </Docs>
211    </Member>
212    <Member MemberName="Properties">
213      <MemberSignature Language="C#" Value="public System.Collections.IDictionary Properties { get; }" />
214      <MemberType>Property</MemberType>
215      <AssemblyInfo>
216        <AssemblyVersion>2.0.0.0</AssemblyVersion>
217      </AssemblyInfo>
218      <ReturnValue>
219        <ReturnType>System.Collections.IDictionary</ReturnType>
220      </ReturnValue>
221      <Docs>
222        <value>To be added.</value>
223        <remarks>
224          <attribution license="cc4" from="Microsoft" modified="false" />
225          <para>The <see cref="P:System.ComponentModel.Design.DesignerActionItem.Properties" /> property allows the programmer to store arbitrary data within an item. The standard properties for this class, such as <see cref="P:System.ComponentModel.Design.DesignerActionItem.Category" /> and <see cref="P:System.ComponentModel.Design.DesignerActionItem.DisplayName" />, are not stored in this collection.</para>
226          <para>The type of this property is actually <see cref="T:System.Collections.Specialized.HybridDictionary" />.</para>
227        </remarks>
228        <summary>
229          <attribution license="cc4" from="Microsoft" modified="false" />
230          <para>Gets a reference to a collection that can be used to store programmer-defined key/value pairs.</para>
231        </summary>
232      </Docs>
233    </Member>
234  </Members>
235</Type>