1<?xml version="1.0" encoding="utf-8"?>
2<Type Name="SubMenuStyleCollection" FullName="System.Web.UI.WebControls.SubMenuStyleCollection">
3  <TypeSignature Language="C#" Value="public class SubMenuStyleCollection : System.Web.UI.StateManagedCollection" />
4  <AssemblyInfo>
5    <AssemblyName>System.Web</AssemblyName>
6    <AssemblyVersion>2.0.0.0</AssemblyVersion>
7  </AssemblyInfo>
8  <Base>
9    <BaseTypeName>System.Web.UI.StateManagedCollection</BaseTypeName>
10  </Base>
11  <Interfaces />
12  <Docs>
13    <since version=".NET 2.0" />
14    <remarks>
15      <attribution license="cc4" from="Microsoft" modified="false" />
16      <para>The <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> class is used to store and manage a collection of <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> objects in a <see cref="T:System.Web.UI.WebControls.Menu" /> control. The <see cref="T:System.Web.UI.WebControls.Menu" /> control uses the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> class as the underlying data type of the <see cref="P:System.Web.UI.WebControls.Menu.LevelSubMenuStyles" /> property.</para>
17      <para>The <see cref="P:System.Web.UI.WebControls.Menu.LevelSubMenuStyles" /> property provides additional style choices in addition to the <see cref="P:System.Web.UI.WebControls.Menu.StaticMenuStyle" /> and <see cref="P:System.Web.UI.WebControls.Menu.DynamicMenuStyle" /> properties. The first style in the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection corresponds to the submenu style for the first level of the menu. The second style in the collection corresponds to the submenu style for the second level of the menu, and so on. The <see cref="P:System.Web.UI.WebControls.Menu.LevelSubMenuStyles" /> property is most often used to generate a navigation menu, like a Web site map, where menu items at a certain level should have the same appearance, regardless of whether they have submenus.</para>
18      <para>The <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> class inherits most of its members from the <see cref="T:System.Web.UI.StateManagedCollection" /> class. For more information on the inherited members, see the <see cref="T:System.Web.UI.StateManagedCollection" /> collection.</para>
19    </remarks>
20    <summary>
21      <attribution license="cc4" from="Microsoft" modified="false" />
22      <para>Represents a collection of <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> objects in a <see cref="T:System.Web.UI.WebControls.Menu" /> control.</para>
23    </summary>
24  </Docs>
25  <Members>
26    <Member MemberName="Add">
27      <MemberSignature Language="C#" Value="public int Add (System.Web.UI.WebControls.SubMenuStyle style);" />
28      <MemberType>Method</MemberType>
29      <ReturnValue>
30        <ReturnType>System.Int32</ReturnType>
31      </ReturnValue>
32      <Parameters>
33        <Parameter Name="style" Type="System.Web.UI.WebControls.SubMenuStyle" />
34      </Parameters>
35      <Docs>
36        <since version=".NET 2.0" />
37        <remarks>
38          <attribution license="cc4" from="Microsoft" modified="false" />
39          <para>The <see cref="M:System.Web.UI.WebControls.SubMenuStyleCollection.OnInsert(System.Int32,System.Object)" /> and <see cref="M:System.Web.UI.StateManagedCollection.OnValidate(System.Object)" /> methods are called before the <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> instance is added to the collection, and the <see cref="M:System.Web.UI.StateManagedCollection.OnInsertComplete(System.Int32,System.Object)" /> method is called after the <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> instance is added.</para>
40        </remarks>
41        <summary>
42          <attribution license="cc4" from="Microsoft" modified="false" />
43          <para>Adds a submenu style to the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection.</para>
44        </summary>
45        <returns>
46          <attribution license="cc4" from="Microsoft" modified="false" />
47          <para>The position in the collection at which the <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> instance was inserted.</para>
48        </returns>
49        <param name="style">
50          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> instance to add to the collection.</param>
51      </Docs>
52      <AssemblyInfo>
53        <AssemblyVersion>2.0.0.0</AssemblyVersion>
54      </AssemblyInfo>
55    </Member>
56    <Member MemberName="Contains">
57      <MemberSignature Language="C#" Value="public bool Contains (System.Web.UI.WebControls.SubMenuStyle style);" />
58      <MemberType>Method</MemberType>
59      <ReturnValue>
60        <ReturnType>System.Boolean</ReturnType>
61      </ReturnValue>
62      <Parameters>
63        <Parameter Name="style" Type="System.Web.UI.WebControls.SubMenuStyle" />
64      </Parameters>
65      <Docs>
66        <since version=".NET 2.0" />
67        <remarks>
68          <attribution license="cc4" from="Microsoft" modified="false" />
69          <para>The <see cref="M:System.Web.UI.StateManagedCollection.OnValidate(System.Object)" /> method is called to validate the <paramref name="style" /> parameter before the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection is checked.</para>
70        </remarks>
71        <summary>
72          <attribution license="cc4" from="Microsoft" modified="false" />
73          <para>Determines whether a <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection contains a specific <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> instance.</para>
74        </summary>
75        <returns>
76          <attribution license="cc4" from="Microsoft" modified="false" />
77          <para>true if the <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> instance is found in the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection; otherwise, false. If null is passed as the <paramref name="style" /> parameter, false is returned.</para>
78        </returns>
79        <param name="style">
80          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> instance to locate in the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection.</param>
81      </Docs>
82      <AssemblyInfo>
83        <AssemblyVersion>2.0.0.0</AssemblyVersion>
84      </AssemblyInfo>
85    </Member>
86    <Member MemberName="CopyTo">
87      <MemberSignature Language="C#" Value="public void CopyTo (System.Web.UI.WebControls.SubMenuStyle[] array, int index);" />
88      <MemberType>Method</MemberType>
89      <ReturnValue>
90        <ReturnType>System.Void</ReturnType>
91      </ReturnValue>
92      <Parameters>
93        <Parameter Name="array" Type="System.Web.UI.WebControls.SubMenuStyle[]" />
94        <Parameter Name="index" Type="System.Int32" />
95      </Parameters>
96      <Docs>
97        <param name="array">To be added.</param>
98        <since version=".NET 2.0" />
99        <remarks>
100          <attribution license="cc4" from="Microsoft" modified="false" />
101          <para>The <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> objects are copied to the destination array in the same order in which the enumerator iterates through the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection.</para>
102        </remarks>
103        <summary>
104          <attribution license="cc4" from="Microsoft" modified="false" />
105          <para>Copies the contents of a <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection to an array, starting at a specified array index.</para>
106        </summary>
107        <param name="index">
108          <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index in <paramref name="array" /> at which copying begins.</param>
109      </Docs>
110      <AssemblyInfo>
111        <AssemblyVersion>2.0.0.0</AssemblyVersion>
112      </AssemblyInfo>
113    </Member>
114    <Member MemberName="CreateKnownType">
115      <MemberSignature Language="C#" Value="protected override object CreateKnownType (int index);" />
116      <MemberType>Method</MemberType>
117      <ReturnValue>
118        <ReturnType>System.Object</ReturnType>
119      </ReturnValue>
120      <Parameters>
121        <Parameter Name="index" Type="System.Int32" />
122      </Parameters>
123      <Docs>
124        <since version=".NET 2.0" />
125        <remarks>
126          <attribution license="cc4" from="Microsoft" modified="false" />
127          <para>The <see cref="M:System.Web.UI.WebControls.SubMenuStyleCollection.CreateKnownType(System.Int32)" /> method is a helper function that is used to create an <see cref="T:System.Object" /> of the data type that corresponds to the specified index. The index is often determined by using the <see cref="M:System.Web.UI.WebControls.SubMenuStyleCollection.GetKnownTypes" /> method to create an array of supported data types and then searching the array for the desired data type.</para>
128          <para>The <paramref name="index" /> parameter is not used in this implementation of the method and is ignored. You should always pass in null for this parameter. This implementation of the method always returns an empty <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object.</para>
129          <block subset="none" type="note">
130            <para>This method is used only by control developers.</para>
131          </block>
132        </remarks>
133        <summary>
134          <attribution license="cc4" from="Microsoft" modified="false" />
135          <para>Creates an <see cref="T:System.Object" /> of the data type that corresponds to the specified index.</para>
136        </summary>
137        <returns>
138          <attribution license="cc4" from="Microsoft" modified="false" />
139          <para>Always returns an empty <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object.</para>
140        </returns>
141        <param name="index">
142          <attribution license="cc4" from="Microsoft" modified="false" />The index of the data type to create. This parameter is not used in this implementation of the method; therefore, you should always pass in null.</param>
143      </Docs>
144      <AssemblyInfo>
145        <AssemblyVersion>2.0.0.0</AssemblyVersion>
146      </AssemblyInfo>
147    </Member>
148    <Member MemberName="GetKnownTypes">
149      <MemberSignature Language="C#" Value="protected override Type[] GetKnownTypes ();" />
150      <MemberType>Method</MemberType>
151      <ReturnValue>
152        <ReturnType>System.Type[]</ReturnType>
153      </ReturnValue>
154      <Parameters />
155      <Docs>
156        <since version=".NET 2.0" />
157        <remarks>
158          <attribution license="cc4" from="Microsoft" modified="false" />
159          <para>The <see cref="M:System.Web.UI.WebControls.SubMenuStyleCollection.GetKnownTypes" /> method is a helper function that is used to create an array of data types supported by the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> class. The array is often searched to determine the index of a desired data type. The index is then passed to the <see cref="M:System.Web.UI.WebControls.SubMenuStyleCollection.CreateKnownType(System.Int32)" /> method to create an <see cref="T:System.Object" /> of the corresponding data type.</para>
160          <block subset="none" type="note">
161            <para>This method is used only by control developers.</para>
162          </block>
163        </remarks>
164        <summary>
165          <attribution license="cc4" from="Microsoft" modified="false" />
166          <para>Creates an array of <see cref="T:System.Type" /> objects that contains the supported data types of the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> class.</para>
167        </summary>
168        <returns>
169          <attribution license="cc4" from="Microsoft" modified="false" />
170          <para>An array of <see cref="T:System.Type" /> objects that contains the data types supported by the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> class.</para>
171        </returns>
172      </Docs>
173      <AssemblyInfo>
174        <AssemblyVersion>2.0.0.0</AssemblyVersion>
175      </AssemblyInfo>
176    </Member>
177    <Member MemberName="IndexOf">
178      <MemberSignature Language="C#" Value="public int IndexOf (System.Web.UI.WebControls.SubMenuStyle style);" />
179      <MemberType>Method</MemberType>
180      <ReturnValue>
181        <ReturnType>System.Int32</ReturnType>
182      </ReturnValue>
183      <Parameters>
184        <Parameter Name="style" Type="System.Web.UI.WebControls.SubMenuStyle" />
185      </Parameters>
186      <Docs>
187        <since version=".NET 2.0" />
188        <remarks>
189          <attribution license="cc4" from="Microsoft" modified="false" />
190          <para>The <see cref="M:System.Web.UI.StateManagedCollection.OnValidate(System.Object)" /> method is called to validate the <paramref name="style" /> parameter before the index is returned.</para>
191        </remarks>
192        <summary>
193          <attribution license="cc4" from="Microsoft" modified="false" />
194          <para>Determines the location of a specified <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object in the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection.</para>
195        </summary>
196        <returns>
197          <attribution license="cc4" from="Microsoft" modified="false" />
198          <para>The index of the specified <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object if it is found in the list; otherwise, -1.</para>
199        </returns>
200        <param name="style">
201          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object to locate in the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection.</param>
202      </Docs>
203      <AssemblyInfo>
204        <AssemblyVersion>2.0.0.0</AssemblyVersion>
205      </AssemblyInfo>
206    </Member>
207    <Member MemberName="Insert">
208      <MemberSignature Language="C#" Value="public void Insert (int index, System.Web.UI.WebControls.SubMenuStyle style);" />
209      <MemberType>Method</MemberType>
210      <ReturnValue>
211        <ReturnType>System.Void</ReturnType>
212      </ReturnValue>
213      <Parameters>
214        <Parameter Name="index" Type="System.Int32" />
215        <Parameter Name="style" Type="System.Web.UI.WebControls.SubMenuStyle" />
216      </Parameters>
217      <Docs>
218        <since version=".NET 2.0" />
219        <remarks>
220          <attribution license="cc4" from="Microsoft" modified="false" />
221          <para>If index is -1, <paramref name="style" /> is inserted at the beginning of the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection. If index equals the number of items in the collection, <paramref name="style" /> is appended to the end of the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection.</para>
222          <para>The <see cref="M:System.Web.UI.StateManagedCollection.OnValidate(System.Object)" /> method is called to validate the style parameter before it is added to the collection. The <see cref="M:System.Web.UI.WebControls.SubMenuStyleCollection.OnInsert(System.Int32,System.Object)" /> method is called before the <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object is inserted into the collection, and the <see cref="M:System.Web.UI.StateManagedCollection.OnInsertComplete(System.Int32,System.Object)" /> method is called after the object is inserted.</para>
223        </remarks>
224        <summary>
225          <attribution license="cc4" from="Microsoft" modified="false" />
226          <para>Inserts a <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object into the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection at the specified index.</para>
227        </summary>
228        <param name="index">
229          <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index at which the <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object should be inserted.</param>
230        <param name="style">
231          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object to insert into the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection.</param>
232      </Docs>
233      <AssemblyInfo>
234        <AssemblyVersion>2.0.0.0</AssemblyVersion>
235      </AssemblyInfo>
236    </Member>
237    <Member MemberName="Item">
238      <MemberSignature Language="C#" Value="public System.Web.UI.WebControls.SubMenuStyle this[int i] { set; get; }" />
239      <MemberType>Property</MemberType>
240      <ReturnValue>
241        <ReturnType>System.Web.UI.WebControls.SubMenuStyle</ReturnType>
242      </ReturnValue>
243      <Parameters>
244        <Parameter Name="i" Type="System.Int32" />
245      </Parameters>
246      <Docs>
247        <param name="i">To be added.</param>
248        <summary>To be added.</summary>
249        <value>To be added.</value>
250        <remarks>To be added.</remarks>
251        <since version=".NET 2.0" />
252      </Docs>
253      <AssemblyInfo>
254        <AssemblyVersion>2.0.0.0</AssemblyVersion>
255      </AssemblyInfo>
256    </Member>
257    <Member MemberName="Remove">
258      <MemberSignature Language="C#" Value="public void Remove (System.Web.UI.WebControls.SubMenuStyle style);" />
259      <MemberType>Method</MemberType>
260      <ReturnValue>
261        <ReturnType>System.Void</ReturnType>
262      </ReturnValue>
263      <Parameters>
264        <Parameter Name="style" Type="System.Web.UI.WebControls.SubMenuStyle" />
265      </Parameters>
266      <Docs>
267        <since version=".NET 2.0" />
268        <remarks>
269          <attribution license="cc4" from="Microsoft" modified="false" />
270          <para>The <see cref="M:System.Web.UI.StateManagedCollection.OnValidate(System.Object)" /> method is called to validate the style parameter before it is used to locate the <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object to remove from the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection.</para>
271          <para>The <see cref="M:System.Web.UI.StateManagedCollection.OnRemove(System.Int32,System.Object)" /> method is called before the <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object is removed, and the <see cref="M:System.Web.UI.StateManagedCollection.OnRemoveComplete(System.Int32,System.Object)" /> method is called after the object is removed from the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection.</para>
272        </remarks>
273        <summary>
274          <attribution license="cc4" from="Microsoft" modified="false" />
275          <para>Removes the first occurrence of the specified <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object from the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection.</para>
276        </summary>
277        <param name="style">
278          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object to remove from the collection.</param>
279      </Docs>
280      <AssemblyInfo>
281        <AssemblyVersion>2.0.0.0</AssemblyVersion>
282      </AssemblyInfo>
283    </Member>
284    <Member MemberName="RemoveAt">
285      <MemberSignature Language="C#" Value="public void RemoveAt (int index);" />
286      <MemberType>Method</MemberType>
287      <ReturnValue>
288        <ReturnType>System.Void</ReturnType>
289      </ReturnValue>
290      <Parameters>
291        <Parameter Name="index" Type="System.Int32" />
292      </Parameters>
293      <Docs>
294        <since version=".NET 2.0" />
295        <remarks>
296          <attribution license="cc4" from="Microsoft" modified="false" />
297          <para>The <see cref="M:System.Web.UI.StateManagedCollection.OnRemove(System.Int32,System.Object)" /> method is called before the <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object is removed from the collection, and the <see cref="M:System.Web.UI.StateManagedCollection.OnRemoveComplete(System.Int32,System.Object)" /> method is called after the object is removed from the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection.</para>
298        </remarks>
299        <summary>
300          <attribution license="cc4" from="Microsoft" modified="false" />
301          <para>Removes the <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object at the specified location.</para>
302        </summary>
303        <param name="index">
304          <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index location of the <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object to remove from the collection.</param>
305      </Docs>
306      <AssemblyInfo>
307        <AssemblyVersion>2.0.0.0</AssemblyVersion>
308      </AssemblyInfo>
309    </Member>
310    <Member MemberName="SetDirtyObject">
311      <MemberSignature Language="C#" Value="protected override void SetDirtyObject (object o);" />
312      <MemberType>Method</MemberType>
313      <ReturnValue>
314        <ReturnType>System.Void</ReturnType>
315      </ReturnValue>
316      <Parameters>
317        <Parameter Name="o" Type="System.Object" />
318      </Parameters>
319      <Docs>
320        <since version=".NET 2.0" />
321        <remarks>
322          <attribution license="cc4" from="Microsoft" modified="false" />
323          <para>The <see cref="M:System.Web.UI.WebControls.SubMenuStyleCollection.SetDirtyObject(System.Object)" /> method is called internally by the <see cref="M:System.Web.UI.IStateManager.SaveViewState" />, <see cref="M:System.Web.UI.WebControls.SubMenuStyleCollection.Add(System.Web.UI.WebControls.SubMenuStyle)" />, and <see cref="M:System.Web.UI.WebControls.SubMenuStyleCollection.Insert(System.Int32,System.Web.UI.WebControls.SubMenuStyle)" /> methods.</para>
324        </remarks>
325        <summary>
326          <attribution license="cc4" from="Microsoft" modified="false" />
327          <para>Instructs a <see cref="T:System.Web.UI.WebControls.SubMenuStyle" /> object contained by the <see cref="T:System.Web.UI.WebControls.SubMenuStyleCollection" /> collection to record its entire state to view state.</para>
328        </summary>
329        <param name="o">
330          <attribution license="cc4" from="Microsoft" modified="false" />The object that should serialize itself completely.</param>
331      </Docs>
332      <AssemblyInfo>
333        <AssemblyVersion>2.0.0.0</AssemblyVersion>
334      </AssemblyInfo>
335    </Member>
336  </Members>
337</Type>