1<?xml version="1.0" encoding="utf-8"?> 2<Type Name="MultiView" FullName="System.Web.UI.WebControls.MultiView"> 3 <TypeSignature Language="C#" Value="public class MultiView : System.Web.UI.Control" /> 4 <AssemblyInfo> 5 <AssemblyName>System.Web</AssemblyName> 6 <AssemblyVersion>2.0.0.0</AssemblyVersion> 7 </AssemblyInfo> 8 <Base> 9 <BaseTypeName>System.Web.UI.Control</BaseTypeName> 10 </Base> 11 <Interfaces /> 12 <Attributes> 13 <Attribute> 14 <AttributeName>System.ComponentModel.DefaultEvent("ActiveViewChanged")</AttributeName> 15 </Attribute> 16 <Attribute> 17 <AttributeName>System.Web.UI.ParseChildren(typeof(System.Web.UI.WebControls.View))</AttributeName> 18 </Attribute> 19 <Attribute> 20 <AttributeName>System.Web.UI.ToolboxData("<{0}:MultiView runat="server"></{0}:MultiView>")</AttributeName> 21 </Attribute> 22 <Attribute> 23 <AttributeName>System.ComponentModel.Designer("System.Web.UI.Design.WebControls.MultiViewDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.IDesigner")</AttributeName> 24 </Attribute> 25 </Attributes> 26 <Docs> 27 <since version=".NET 2.0" /> 28 <remarks> 29 <attribution license="cc4" from="Microsoft" modified="false" /> 30 <para>In this topic:</para> 31 <list type="bullet"> 32 <item> 33 <para> 34 <format type="text/html"> 35 <a href="#introduction">Introduction</a> 36 </format> 37 </para> 38 </item> 39 <item> 40 <para> 41 <format type="text/html"> 42 <a href="#declarative_syntax">Declarative Syntax</a> 43 </format> 44 </para> 45 </item> 46 </list> 47 <format type="text/html"> 48 <a href="#introduction" /> 49 </format> 50 <format type="text/html"> 51 <h2>Introduction</h2> 52 </format> 53 <para>The <see cref="T:System.Web.UI.WebControls.MultiView" /> control is a container for a group of <see cref="T:System.Web.UI.WebControls.View" /> controls. It allows you to define a group of <see cref="T:System.Web.UI.WebControls.View" /> controls, where each <see cref="T:System.Web.UI.WebControls.View" /> control contains child controls. Your application can then render a specific <see cref="T:System.Web.UI.WebControls.View" /> control to the client based on criteria such as user identity, user preferences, and information passed in a query-string parameter. You can also use the <see cref="T:System.Web.UI.WebControls.MultiView" /> control to create wizards. In this scenario, each <see cref="T:System.Web.UI.WebControls.View" /> control contained in a <see cref="T:System.Web.UI.WebControls.MultiView" /> control represents a different step or page in the wizard. You should also use this control to develop multiple-screen applications for mobile devices. This control provides the same functionality as the ASP.NET mobile <see cref="T:System.Web.UI.MobileControls.Form" /> control in .NET Framework version 1.1.</para> 54 <para>Only one <see cref="T:System.Web.UI.WebControls.View" /> control at a time can be defined as the active view within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control. When a <see cref="T:System.Web.UI.WebControls.View" /> control is defined as the active view, the child controls that it contains are rendered to the client. You can use either the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property or the <see cref="M:System.Web.UI.WebControls.MultiView.SetActiveView(System.Web.UI.WebControls.View)" /> method to define the active view. If the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property is empty, the <see cref="T:System.Web.UI.WebControls.MultiView" /> control does not render any content to the client. If the active view is set to a <see cref="T:System.Web.UI.WebControls.View" /> that does not exist within the <see cref="T:System.Web.UI.WebControls.MultiView" /> control, an <see cref="T:System.ArgumentOutOfRangeException" /> is raised at run time.</para> 55 <para>You can define the active view declaratively or programmatically. Setting the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property declaratively when you define the <see cref="T:System.Web.UI.WebControls.MultiView" /> control causes the <see cref="T:System.Web.UI.WebControls.View" /> control that is set as the active view to render to the client the first time the <see cref="T:System.Web.UI.WebControls.MultiView" /> control is called. The following code example demonstrates how to set the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property declaratively.</para> 56 <code><asp:MultiView id="MultiView1" ActiveViewIndex=0 runat="Server"> </code> 57 <para>Setting the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property programmatically, or calling the <see cref="M:System.Web.UI.WebControls.MultiView.SetActiveView(System.Web.UI.WebControls.View)" /> method, allows the application to determine which <see cref="T:System.Web.UI.WebControls.View" /> control to render to the client at run time based on criteria such as a user's identity or preferences.</para> 58 <para>To allow users to navigate between <see cref="T:System.Web.UI.WebControls.View" /> controls within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control, you can add a <see cref="T:System.Web.UI.WebControls.LinkButton" /> or <see cref="T:System.Web.UI.WebControls.Button" /> control to each <see cref="T:System.Web.UI.WebControls.View" /> control. To take advantage of the <see cref="T:System.Web.UI.WebControls.MultiView" /> control's automatic updating of the currently active <see cref="T:System.Web.UI.WebControls.View" />, set the CommandName property on the button or link button to the value of one of the following command-name fields that corresponds to the desired navigation behavior: <see cref="F:System.Web.UI.WebControls.MultiView.PreviousViewCommandName" />, <see cref="F:System.Web.UI.WebControls.MultiView.NextViewCommandName" />, <see cref="F:System.Web.UI.WebControls.MultiView.SwitchViewByIDCommandName" />, or <see cref="F:System.Web.UI.WebControls.MultiView.SwitchViewByIndexCommandName" />.</para> 59 <format type="text/html"> 60 <a href="#declarative_syntax" /> 61 </format> 62 <format type="text/html"> 63 <h2>Declarative Syntax</h2> 64 </format> 65 <code><asp:MultiView 66 ActiveViewIndex="integer" 67 EnableTheming="<codeFeaturedElement>True</codeFeaturedElement>|False" 68 EnableViewState="<codeFeaturedElement>True</codeFeaturedElement>|False" 69 ID="string" 70 OnActiveViewChanged="ActiveViewChanged event handler" 71 OnDataBinding="DataBinding event handler" 72 OnDisposed="Disposed event handler" 73 OnInit="Init event handler" 74 OnLoad="Load event handler" 75 OnPreRender="PreRender event handler" 76 OnUnload="Unload event handler" 77 runat="server" 78 SkinID="string" 79 Visible="<codeFeaturedElement>True</codeFeaturedElement>|False" 80> 81 <asp:TemplatedWizardStep 82 AllowReturn="<codeFeaturedElement>True</codeFeaturedElement>|False" 83 ContentTemplateContainer="string" 84 EnableTheming="<codeFeaturedElement>True</codeFeaturedElement>|False" 85 EnableViewState="<codeFeaturedElement>True</codeFeaturedElement>|False" 86 ID="string" 87 OnActivate="Activate event handler" 88 OnDataBinding="DataBinding event handler" 89 OnDeactivate="Deactivate event handler" 90 OnDisposed="Disposed event handler" 91 OnInit="Init event handler" 92 OnLoad="Load event handler" 93 OnPreRender="PreRender event handler" 94 OnUnload="Unload event handler" 95 runat="server" 96 SkinID="string" 97 StepType="<codeFeaturedElement>Auto</codeFeaturedElement>|Complete|Finish|Start|Step" 98 Title="string" 99 Visible="<codeFeaturedElement>True</codeFeaturedElement>|False" 100> 101 <ContentTemplate> 102 <!-- child controls --> 103 </ContentTemplate> 104 <CustomNavigationTemplate> 105 <!-- child controls --> 106 </CustomNavigationTemplate> 107 </asp:TemplatedWizardStep> 108 <asp:View 109 EnableTheming="<codeFeaturedElement>True</codeFeaturedElement>|False" 110 EnableViewState="<codeFeaturedElement>True</codeFeaturedElement>|False" 111 ID="string" 112 OnActivate="Activate event handler" 113 OnDataBinding="DataBinding event handler" 114 OnDeactivate="Deactivate event handler" 115 OnDisposed="Disposed event handler" 116 OnInit="Init event handler" 117 OnLoad="Load event handler" 118 OnPreRender="PreRender event handler" 119 OnUnload="Unload event handler" 120 runat="server" 121 SkinID="string" 122 Visible="<codeFeaturedElement>True</codeFeaturedElement>|False" 123 /> 124 <asp:WizardStep 125 AllowReturn="<codeFeaturedElement>True</codeFeaturedElement>|False" 126 EnableTheming="<codeFeaturedElement>True</codeFeaturedElement>|False" 127 EnableViewState="<codeFeaturedElement>True</codeFeaturedElement>|False" 128 ID="string" 129 OnActivate="Activate event handler" 130 OnDataBinding="DataBinding event handler" 131 OnDeactivate="Deactivate event handler" 132 OnDisposed="Disposed event handler" 133 OnInit="Init event handler" 134 OnLoad="Load event handler" 135 OnPreRender="PreRender event handler" 136 OnUnload="Unload event handler" 137 runat="server" 138 SkinID="string" 139 StepType="<codeFeaturedElement>Auto</codeFeaturedElement>|Complete|Finish|Start|Step" 140 Title="string" 141 Visible="<codeFeaturedElement>True</codeFeaturedElement>|False" 142 /> 143</asp:MultiView></code> 144 </remarks> 145 <summary> 146 <attribution license="cc4" from="Microsoft" modified="false" /> 147 <para>Represents a control that acts as a container for a group of <see cref="T:System.Web.UI.WebControls.View" /> controls.</para> 148 </summary> 149 </Docs> 150 <Members> 151 <Member MemberName=".ctor"> 152 <MemberSignature Language="C#" Value="public MultiView ();" /> 153 <MemberType>Constructor</MemberType> 154 <Parameters /> 155 <Docs> 156 <since version=".NET 2.0" /> 157 <remarks> 158 <attribution license="cc4" from="Microsoft" modified="false" /> 159 <para>Use this constructor to create and initialize a new instance of the <see cref="T:System.Web.UI.WebControls.MultiView" /> class.</para> 160 </remarks> 161 <summary> 162 <attribution license="cc4" from="Microsoft" modified="false" /> 163 <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.MultiView" /> class. </para> 164 </summary> 165 </Docs> 166 <AssemblyInfo> 167 <AssemblyVersion>2.0.0.0</AssemblyVersion> 168 </AssemblyInfo> 169 </Member> 170 <Member MemberName="ActiveViewChanged"> 171 <MemberSignature Language="C#" Value="public event EventHandler ActiveViewChanged;" /> 172 <MemberType>Event</MemberType> 173 <ReturnValue> 174 <ReturnType>System.EventHandler</ReturnType> 175 </ReturnValue> 176 <Docs> 177 <since version=".NET 2.0" /> 178 <remarks> 179 <attribution license="cc4" from="Microsoft" modified="false" /> 180 <para>The <see cref="E:System.Web.UI.WebControls.MultiView.ActiveViewChanged" /> event is raised when the active <see cref="T:System.Web.UI.WebControls.View" /> control within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control changes between posts to the server.</para> 181 <para>For more information about handling events, see <format type="text/html"><a href="73bf8638-c4ec-4069-b0bb-a1dc79b92e32">How to: Consume Events in a Web Forms Application</a></format>.</para> 182 </remarks> 183 <summary> 184 <attribution license="cc4" from="Microsoft" modified="false" /> 185 <para>Occurs when the active <see cref="T:System.Web.UI.WebControls.View" /> control of a <see cref="T:System.Web.UI.WebControls.MultiView" /> control changes between posts to the server.</para> 186 </summary> 187 </Docs> 188 <AssemblyInfo> 189 <AssemblyVersion>2.0.0.0</AssemblyVersion> 190 </AssemblyInfo> 191 </Member> 192 <Member MemberName="ActiveViewIndex"> 193 <MemberSignature Language="C#" Value="public virtual int ActiveViewIndex { set; get; }" /> 194 <MemberType>Property</MemberType> 195 <Attributes> 196 <Attribute> 197 <AttributeName>System.ComponentModel.DefaultValue(-1)</AttributeName> 198 </Attribute> 199 </Attributes> 200 <ReturnValue> 201 <ReturnType>System.Int32</ReturnType> 202 </ReturnValue> 203 <Docs> 204 <value>To be added.</value> 205 <since version=".NET 2.0" /> 206 <remarks> 207 <attribution license="cc4" from="Microsoft" modified="false" /> 208 <para>Use the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property to set a <see cref="T:System.Web.UI.WebControls.View" /> control within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control as the active view. You can also use this property to return the index of the <see cref="T:System.Web.UI.WebControls.View" /> control that is currently set as the active view. The index of a <see cref="T:System.Web.UI.WebControls.View" /> control is determined by the order in which it is declared within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control. For example, the first <see cref="T:System.Web.UI.WebControls.View" /> control declared within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control has an index of 0.</para> 209 <para>Only one <see cref="T:System.Web.UI.WebControls.View" /> control at a time can be defined as active within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control. The <see cref="T:System.Web.UI.WebControls.View" /> control that is set to the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property will be rendered to the client. If the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property is set to a <see cref="T:System.Web.UI.WebControls.View" /> that does not exist within the <see cref="T:System.Web.UI.WebControls.MultiView" /> control, a <see cref="T:System.ArgumentOutOfRangeException" /> is raised at run time. If the property is empty, the <see cref="T:System.Web.UI.WebControls.MultiView" /> control does not render any content to the client.</para> 210 <para>You can set the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property either declaratively at development time or programmatically at run time. Setting the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property declaratively when you define the <see cref="T:System.Web.UI.WebControls.MultiView" /> control causes the <see cref="T:System.Web.UI.WebControls.View" /> control that is set as the active view to render to the client the first time the <see cref="T:System.Web.UI.WebControls.MultiView" /> control is called. Setting the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property programmatically allows the application to determine which <see cref="T:System.Web.UI.WebControls.View" /> control to render to the client at run time based on criteria such as a user's identity or their preferences.</para> 211 <para>Alternately, you can use the <see cref="M:System.Web.UI.WebControls.MultiView.SetActiveView(System.Web.UI.WebControls.View)" /> and <see cref="M:System.Web.UI.WebControls.MultiView.GetActiveView" /> methods to set or get the active view within the <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 212 </remarks> 213 <summary> 214 <attribution license="cc4" from="Microsoft" modified="false" /> 215 <para>Gets or sets the index of the active <see cref="T:System.Web.UI.WebControls.View" /> control within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 216 </summary> 217 </Docs> 218 <AssemblyInfo> 219 <AssemblyVersion>2.0.0.0</AssemblyVersion> 220 </AssemblyInfo> 221 </Member> 222 <Member MemberName="AddParsedSubObject"> 223 <MemberSignature Language="C#" Value="protected override void AddParsedSubObject (object ob);" /> 224 <MemberType>Method</MemberType> 225 <ReturnValue> 226 <ReturnType>System.Void</ReturnType> 227 </ReturnValue> 228 <Parameters> 229 <Parameter Name="ob" Type="System.Object" /> 230 </Parameters> 231 <Docs> 232 <param name="ob">To be added.</param> 233 <since version=".NET 2.0" /> 234 <remarks> 235 <attribution license="cc4" from="Microsoft" modified="false" /> 236 <para>This method overrides the base class implementation to allow only <see cref="T:System.Web.UI.WebControls.View" /> controls to be added to the <see cref="T:System.Web.UI.WebControls.ViewCollection" />.</para> 237 </remarks> 238 <summary> 239 <attribution license="cc4" from="Microsoft" modified="false" /> 240 <para>Notifies the <see cref="T:System.Web.UI.WebControls.MultiView" /> control that an XML or HTML element was parsed, and adds the element to the <see cref="T:System.Web.UI.WebControls.ViewCollection" /> collection of the <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 241 </summary> 242 </Docs> 243 <AssemblyInfo> 244 <AssemblyVersion>2.0.0.0</AssemblyVersion> 245 </AssemblyInfo> 246 </Member> 247 <Member MemberName="CreateControlCollection"> 248 <MemberSignature Language="C#" Value="protected override System.Web.UI.ControlCollection CreateControlCollection ();" /> 249 <MemberType>Method</MemberType> 250 <ReturnValue> 251 <ReturnType>System.Web.UI.ControlCollection</ReturnType> 252 </ReturnValue> 253 <Parameters /> 254 <Docs> 255 <since version=".NET 2.0" /> 256 <remarks> 257 <attribution license="cc4" from="Microsoft" modified="false" /> 258 <para>This method overrides the base implementation to always return a <see cref="T:System.Web.UI.WebControls.ViewCollection" /> to contain the <see cref="T:System.Web.UI.WebControls.View" /> controls of the current <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 259 </remarks> 260 <summary> 261 <attribution license="cc4" from="Microsoft" modified="false" /> 262 <para>Creates a <see cref="T:System.Web.UI.ControlCollection" /> to hold the child controls of the <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 263 </summary> 264 <returns> 265 <attribution license="cc4" from="Microsoft" modified="false" /> 266 <para>A <see cref="T:System.Web.UI.WebControls.ViewCollection" /> to contain the <see cref="T:System.Web.UI.WebControls.View" /> controls of the current <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 267 </returns> 268 </Docs> 269 <AssemblyInfo> 270 <AssemblyVersion>2.0.0.0</AssemblyVersion> 271 </AssemblyInfo> 272 </Member> 273 <Member MemberName="EnableTheming"> 274 <MemberSignature Language="C#" Value="public virtual bool EnableTheming { set; get; }" /> 275 <MemberType>Property</MemberType> 276 <Attributes> 277 <Attribute> 278 <AttributeName>System.ComponentModel.Browsable(true)</AttributeName> 279 </Attribute> 280 </Attributes> 281 <ReturnValue> 282 <ReturnType>System.Boolean</ReturnType> 283 </ReturnValue> 284 <Docs> 285 <value>To be added.</value> 286 <since version=".NET 2.0" /> 287 <remarks> 288 <attribution license="cc4" from="Microsoft" modified="false" /> 289 <para>The <see cref="P:System.Web.UI.WebControls.MultiView.EnableTheming" /> property indicates whether themes are enabled for the <see cref="T:System.Web.UI.WebControls.MultiView" /> control. The <see cref="P:System.Web.UI.WebControls.MultiView.EnableTheming" /> property also affects whether themes are enabled for the controls contained in its <see cref="P:System.Web.UI.Control.Controls" /> collection. When the <see cref="P:System.Web.UI.WebControls.MultiView.EnableTheming" /> property is true, the application's theme directory is searched for control skins to apply. If no skin for the particular control exists in the theme directory, a skin is not applied. When the <see cref="P:System.Web.UI.WebControls.MultiView.EnableTheming" /> property is false, the theme directory is not searched and the contents of the <see cref="P:System.Web.UI.Control.SkinID" /> property are not used.</para> 290 <para>A control can override the <see cref="P:System.Web.UI.WebControls.MultiView.EnableTheming" /> value set by its parent control or the containing page. For example, if a <see cref="T:System.Web.UI.WebControls.MultiView" /> control has <see cref="P:System.Web.UI.WebControls.MultiView.EnableTheming" /> set to false, you can selectively apply themes to individual <see cref="T:System.Web.UI.WebControls.View" /> controls contained within the <see cref="T:System.Web.UI.WebControls.MultiView" /> control by setting the <see cref="P:System.Web.UI.Control.EnableTheming" /> property to true on the individual child controls.</para> 291 </remarks> 292 <summary> 293 <attribution license="cc4" from="Microsoft" modified="false" /> 294 <para>Gets or sets a value indicating whether themes apply to the <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 295 </summary> 296 </Docs> 297 <AssemblyInfo> 298 <AssemblyVersion>2.0.0.0</AssemblyVersion> 299 </AssemblyInfo> 300 </Member> 301 <Member MemberName="GetActiveView"> 302 <MemberSignature Language="C#" Value="public System.Web.UI.WebControls.View GetActiveView ();" /> 303 <MemberType>Method</MemberType> 304 <ReturnValue> 305 <ReturnType>System.Web.UI.WebControls.View</ReturnType> 306 </ReturnValue> 307 <Parameters /> 308 <Docs> 309 <since version=".NET 2.0" /> 310 <remarks> 311 <attribution license="cc4" from="Microsoft" modified="false" /> 312 <para>Use this method to return the <see cref="T:System.Web.UI.WebControls.View" /> control within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control that is currently set as the active view. This method returns a <see cref="T:System.Web.UI.WebControls.View" /> control and therefore can be used to access the properties of the active view. For example, MultiView1.GetActiveView.ID returns the value of the <see cref="P:System.Web.UI.Control.ID" /> property of the current active view in MultiView1.</para> 313 <para>Alternately, you can use the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property to get or set the zero-based index of the current active view in a <see cref="T:System.Web.UI.WebControls.MultiView" /> control. This property can be accessed either declaratively or programmatically.</para> 314 </remarks> 315 <summary> 316 <attribution license="cc4" from="Microsoft" modified="false" /> 317 <para>Returns the current active <see cref="T:System.Web.UI.WebControls.View" /> control within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 318 </summary> 319 <returns> 320 <attribution license="cc4" from="Microsoft" modified="false" /> 321 <para>A <see cref="T:System.Web.UI.WebControls.View" /> control that represents the active view within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 322 </returns> 323 </Docs> 324 <AssemblyInfo> 325 <AssemblyVersion>2.0.0.0</AssemblyVersion> 326 </AssemblyInfo> 327 </Member> 328 <Member MemberName="LoadControlState"> 329 <MemberSignature Language="C#" Value="protected override void LoadControlState (object state);" /> 330 <MemberType>Method</MemberType> 331 <AssemblyInfo> 332 <AssemblyVersion>2.0.0.0</AssemblyVersion> 333 </AssemblyInfo> 334 <ReturnValue> 335 <ReturnType>System.Void</ReturnType> 336 </ReturnValue> 337 <Parameters> 338 <Parameter Name="state" Type="System.Object" /> 339 </Parameters> 340 <Docs> 341 <remarks>To be added.</remarks> 342 <summary> 343 <attribution license="cc4" from="Microsoft" modified="false" /> 344 <para>Loads the current state of the <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 345 </summary> 346 <param name="state"> 347 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Object" /> that represents the state of the <see cref="T:System.Web.UI.WebControls.MultiView" /> control. </param> 348 </Docs> 349 </Member> 350 <Member MemberName="NextViewCommandName"> 351 <MemberSignature Language="C#" Value="public static readonly string NextViewCommandName;" /> 352 <MemberType>Field</MemberType> 353 <ReturnValue> 354 <ReturnType>System.String</ReturnType> 355 </ReturnValue> 356 <Docs> 357 <since version=".NET 2.0" /> 358 <remarks> 359 <attribution license="cc4" from="Microsoft" modified="false" /> 360 <para>Use the <see cref="F:System.Web.UI.WebControls.MultiView.NextViewCommandName" /> field to represent the "NextView" command name.</para> 361 <para>You can use the value of this field to take advantage of the <see cref="T:System.Web.UI.WebControls.MultiView" /> control's automatic updating of the active <see cref="T:System.Web.UI.WebControls.View" /> control. For example, if a <see cref="T:System.Web.UI.WebControls.View" /> control contains a <see cref="T:System.Web.UI.WebControls.Button" /> control that navigates to the previous <see cref="T:System.Web.UI.WebControls.View" />, you can set the <see cref="P:System.Web.UI.WebControls.Button.CommandName" /> property to the value of the <see cref="F:System.Web.UI.WebControls.MultiView.NextViewCommandName" /> field, which is "NextView". This causes the <see cref="T:System.Web.UI.WebControls.MultiView" /> control to automatically decrement the value of the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property when the button is clicked.</para> 362 </remarks> 363 <summary> 364 <attribution license="cc4" from="Microsoft" modified="false" /> 365 <para>Represents the command name associated with the next <see cref="T:System.Web.UI.WebControls.View" /> control to display in a <see cref="T:System.Web.UI.WebControls.MultiView" /> control. This field is read-only.</para> 366 </summary> 367 </Docs> 368 <AssemblyInfo> 369 <AssemblyVersion>2.0.0.0</AssemblyVersion> 370 </AssemblyInfo> 371 </Member> 372 <Member MemberName="OnActiveViewChanged"> 373 <MemberSignature Language="C#" Value="protected virtual void OnActiveViewChanged (EventArgs e);" /> 374 <MemberType>Method</MemberType> 375 <ReturnValue> 376 <ReturnType>System.Void</ReturnType> 377 </ReturnValue> 378 <Parameters> 379 <Parameter Name="e" Type="System.EventArgs" /> 380 </Parameters> 381 <Docs> 382 <since version=".NET 2.0" /> 383 <remarks> 384 <attribution license="cc4" from="Microsoft" modified="false" /> 385 <para>The <see cref="E:System.Web.UI.WebControls.MultiView.ActiveViewChanged" /> event is raised when the active <see cref="T:System.Web.UI.WebControls.View" /> control within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control changes between posts to the server, and you can provide a custom handler for this event.</para> 386 <para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="73bf8638-c4ec-4069-b0bb-a1dc79b92e32">How to: Consume Events in a Web Forms Application</a></format>.</para> 387 <para>The <see cref="M:System.Web.UI.WebControls.MultiView.OnActiveViewChanged(System.EventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para> 388 </remarks> 389 <summary> 390 <attribution license="cc4" from="Microsoft" modified="false" /> 391 <para>Raises the <see cref="E:System.Web.UI.WebControls.MultiView.ActiveViewChanged" /> event of a <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 392 </summary> 393 <param name="e"> 394 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.EventArgs" /> that contains the event data. </param> 395 </Docs> 396 <AssemblyInfo> 397 <AssemblyVersion>2.0.0.0</AssemblyVersion> 398 </AssemblyInfo> 399 </Member> 400 <Member MemberName="OnBubbleEvent"> 401 <MemberSignature Language="C#" Value="protected override bool OnBubbleEvent (object source, EventArgs e);" /> 402 <MemberType>Method</MemberType> 403 <ReturnValue> 404 <ReturnType>System.Boolean</ReturnType> 405 </ReturnValue> 406 <Parameters> 407 <Parameter Name="source" Type="System.Object" /> 408 <Parameter Name="e" Type="System.EventArgs" /> 409 </Parameters> 410 <Docs> 411 <since version=".NET 2.0" /> 412 <remarks> 413 <attribution license="cc4" from="Microsoft" modified="false" /> 414 <para>A <see cref="T:System.Web.UI.WebControls.MultiView" /> control contains <see cref="T:System.Web.UI.WebControls.View" /> controls that raise events. This method overrides the base implementation to handle navigation between <see cref="T:System.Web.UI.WebControls.View" /> controls.</para> 415 </remarks> 416 <summary> 417 <attribution license="cc4" from="Microsoft" modified="false" /> 418 <para>Determines whether the event for the <see cref="T:System.Web.UI.WebControls.MultiView" /> control is passed to the page's UI server control hierarchy.</para> 419 </summary> 420 <returns> 421 <attribution license="cc4" from="Microsoft" modified="false" /> 422 <para>true if the event has been canceled; otherwise, false. The default is false.</para> 423 </returns> 424 <param name="source"> 425 <attribution license="cc4" from="Microsoft" modified="false" />The source of the event. </param> 426 <param name="e"> 427 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> object that contains the event data. </param> 428 </Docs> 429 <AssemblyInfo> 430 <AssemblyVersion>2.0.0.0</AssemblyVersion> 431 </AssemblyInfo> 432 </Member> 433 <Member MemberName="OnInit"> 434 <MemberSignature Language="C#" Value="protected override void OnInit (EventArgs e);" /> 435 <MemberType>Method</MemberType> 436 <AssemblyInfo> 437 <AssemblyVersion>2.0.0.0</AssemblyVersion> 438 </AssemblyInfo> 439 <ReturnValue> 440 <ReturnType>System.Void</ReturnType> 441 </ReturnValue> 442 <Parameters> 443 <Parameter Name="e" Type="System.EventArgs" /> 444 </Parameters> 445 <Docs> 446 <remarks> 447 <attribution license="cc4" from="Microsoft" modified="false" /> 448 <para>When notified by this method, a <see cref="T:System.Web.UI.WebControls.MultiView" /> control must perform any initialization steps that are required to create and set up an instance. In this stage of the server control's lifecycle, the control's view state has yet to be populated. You cannot access another server control when this method is called, even if it is a child or parent of this control. Other server controls are not certain to be created and ready for access.</para> 449 </remarks> 450 <summary> 451 <attribution license="cc4" from="Microsoft" modified="false" /> 452 <para>Raises the <see cref="E:System.Web.UI.Control.Init" /> event.</para> 453 </summary> 454 <param name="e"> 455 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> object that contains the event data. </param> 456 </Docs> 457 </Member> 458 <Member MemberName="PreviousViewCommandName"> 459 <MemberSignature Language="C#" Value="public static readonly string PreviousViewCommandName;" /> 460 <MemberType>Field</MemberType> 461 <ReturnValue> 462 <ReturnType>System.String</ReturnType> 463 </ReturnValue> 464 <Docs> 465 <since version=".NET 2.0" /> 466 <remarks> 467 <attribution license="cc4" from="Microsoft" modified="false" /> 468 <para>Use the <see cref="F:System.Web.UI.WebControls.MultiView.PreviousViewCommandName" /> field to represent the "PrevView" command name. </para> 469 <para>You can use the value of this field to take advantage of the <see cref="T:System.Web.UI.WebControls.MultiView" /> control's automatic updating of the active <see cref="T:System.Web.UI.WebControls.View" /> control. For example, if a <see cref="T:System.Web.UI.WebControls.View" /> control contains a <see cref="T:System.Web.UI.WebControls.Button" /> control that navigates to the next <see cref="T:System.Web.UI.WebControls.View" />, you can set the <see cref="P:System.Web.UI.WebControls.Button.CommandName" /> property to the value of the <see cref="F:System.Web.UI.WebControls.MultiView.PreviousViewCommandName" /> field, which is "PrevView". This causes the <see cref="T:System.Web.UI.WebControls.MultiView" /> control to automatically increment the value of the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property when the button is clicked.</para> 470 </remarks> 471 <summary> 472 <attribution license="cc4" from="Microsoft" modified="false" /> 473 <para>Represents the command name associated with the previous <see cref="T:System.Web.UI.WebControls.View" /> control to display in a <see cref="T:System.Web.UI.WebControls.MultiView" /> control. This field is read-only.</para> 474 </summary> 475 </Docs> 476 <AssemblyInfo> 477 <AssemblyVersion>2.0.0.0</AssemblyVersion> 478 </AssemblyInfo> 479 </Member> 480 <Member MemberName="RemovedControl"> 481 <MemberSignature Language="C#" Value="protected override void RemovedControl (System.Web.UI.Control ctl);" /> 482 <MemberType>Method</MemberType> 483 <AssemblyInfo> 484 <AssemblyVersion>2.0.0.0</AssemblyVersion> 485 </AssemblyInfo> 486 <ReturnValue> 487 <ReturnType>System.Void</ReturnType> 488 </ReturnValue> 489 <Parameters> 490 <Parameter Name="ctl" Type="System.Web.UI.Control" /> 491 </Parameters> 492 <Docs> 493 <remarks> 494 <attribution license="cc4" from="Microsoft" modified="false" /> 495 <para>The <see cref="M:System.Web.UI.Control.RemovedControl(System.Web.UI.Control)" /> method is called immediately after a <see cref="T:System.Web.UI.WebControls.View" /> control is removed from the <see cref="P:System.Web.UI.Control.Controls" /> collection of a <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 496 </remarks> 497 <summary> 498 <attribution license="cc4" from="Microsoft" modified="false" /> 499 <para>Called after a <see cref="T:System.Web.UI.WebControls.View" /> control is removed from the <see cref="P:System.Web.UI.Control.Controls" /> collection of a <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 500 </summary> 501 <param name="ctl"> 502 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.View" /> control that has been removed. </param> 503 </Docs> 504 </Member> 505 <Member MemberName="Render"> 506 <MemberSignature Language="C#" Value="protected override void Render (System.Web.UI.HtmlTextWriter writer);" /> 507 <MemberType>Method</MemberType> 508 <AssemblyInfo> 509 <AssemblyVersion>2.0.0.0</AssemblyVersion> 510 </AssemblyInfo> 511 <ReturnValue> 512 <ReturnType>System.Void</ReturnType> 513 </ReturnValue> 514 <Parameters> 515 <Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" /> 516 </Parameters> 517 <Docs> 518 <remarks> 519 <attribution license="cc4" from="Microsoft" modified="false" /> 520 <para>The <see cref="M:System.Web.UI.WebControls.MultiView.Render(System.Web.UI.HtmlTextWriter)" /> method is used primarily by control developers when deriving a custom class from the <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 521 <para>The <see cref="M:System.Web.UI.WebControls.MultiView.Render(System.Web.UI.HtmlTextWriter)" /> method writes the rendered content of the active view to the client using the supplied <see cref="T:System.Web.UI.HtmlTextWriter" />. You can set the active view in a <see cref="T:System.Web.UI.WebControls.MultiView" /> control using the <see cref="M:System.Web.UI.WebControls.MultiView.SetActiveView(System.Web.UI.WebControls.View)" /> method or the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property. You can determine which one of the <see cref="T:System.Web.UI.WebControls.View" /> controls in the <see cref="P:System.Web.UI.WebControls.MultiView.Views" /> collection is the active view, if any, by using the <see cref="M:System.Web.UI.WebControls.MultiView.GetActiveView" /> method or the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property.</para> 522 <para>If an active view is set for the <see cref="T:System.Web.UI.WebControls.MultiView" /> control, the active <see cref="T:System.Web.UI.WebControls.View" /> control is used to render content for that view and its child controls. If an active view is not set for the <see cref="T:System.Web.UI.WebControls.MultiView" /> control, no content is rendered to the <see cref="T:System.Web.UI.HtmlTextWriter" />.</para> 523 </remarks> 524 <summary> 525 <attribution license="cc4" from="Microsoft" modified="false" /> 526 <para>Writes the <see cref="T:System.Web.UI.WebControls.MultiView" /> control content to the specified <see cref="T:System.Web.UI.HtmlTextWriter" /> object, for display on the client. </para> 527 </summary> 528 <param name="writer"> 529 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Web.UI.HtmlTextWriter" /> that represents the output stream to render HTML content on the client.</param> 530 </Docs> 531 </Member> 532 <Member MemberName="SaveControlState"> 533 <MemberSignature Language="C#" Value="protected override object SaveControlState ();" /> 534 <MemberType>Method</MemberType> 535 <AssemblyInfo> 536 <AssemblyVersion>2.0.0.0</AssemblyVersion> 537 </AssemblyInfo> 538 <ReturnValue> 539 <ReturnType>System.Object</ReturnType> 540 </ReturnValue> 541 <Parameters /> 542 <Docs> 543 <remarks>To be added.</remarks> 544 <summary> 545 <attribution license="cc4" from="Microsoft" modified="false" /> 546 <para>Saves the current state of the <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 547 </summary> 548 <returns> 549 <attribution license="cc4" from="Microsoft" modified="false" /> 550 <para>An <see cref="T:System.Object" /> that represents the state of the <see cref="T:System.Web.UI.WebControls.MultiView" /> control. If there is no state associated with the <see cref="T:System.Web.UI.WebControls.MultiView" /> control, this method returns null.</para> 551 </returns> 552 </Docs> 553 </Member> 554 <Member MemberName="SetActiveView"> 555 <MemberSignature Language="C#" Value="public void SetActiveView (System.Web.UI.WebControls.View view);" /> 556 <MemberType>Method</MemberType> 557 <ReturnValue> 558 <ReturnType>System.Void</ReturnType> 559 </ReturnValue> 560 <Parameters> 561 <Parameter Name="view" Type="System.Web.UI.WebControls.View" /> 562 </Parameters> 563 <Docs> 564 <since version=".NET 2.0" /> 565 <remarks> 566 <attribution license="cc4" from="Microsoft" modified="false" /> 567 <para>Use this method to set a <see cref="T:System.Web.UI.WebControls.View" /> control within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control as the active view. Only one <see cref="T:System.Web.UI.WebControls.View" /> control at a time can be defined as active within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control. The <see cref="T:System.Web.UI.WebControls.View" /> control that is set as the active view is rendered to the client. If a <see cref="T:System.Web.UI.WebControls.View" /> control that does not exist within the <see cref="T:System.Web.UI.WebControls.MultiView" /> control is set as active, an exception is raised at run time. If no <see cref="T:System.Web.UI.WebControls.View" /> control is set as the active view, the <see cref="T:System.Web.UI.WebControls.MultiView" /> control does not render any content to the client.</para> 568 <para>Using the <see cref="M:System.Web.UI.WebControls.MultiView.SetActiveView(System.Web.UI.WebControls.View)" /> method to programmatically set the active view allows the application to determine which <see cref="T:System.Web.UI.WebControls.View" /> control to render to the client at run time based on criteria such as a user's identity and preferences.</para> 569 <para>Alternately, you can use the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property to get or set the zero-based index of the current active view in a <see cref="T:System.Web.UI.WebControls.MultiView" /> control. This property can be accessed either declaratively or programmatically.</para> 570 </remarks> 571 <summary> 572 <attribution license="cc4" from="Microsoft" modified="false" /> 573 <para>Sets the specified <see cref="T:System.Web.UI.WebControls.View" /> control to the active view within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 574 </summary> 575 <param name="view"> 576 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.WebControls.View" /> control to set as the active view within a <see cref="T:System.Web.UI.WebControls.MultiView" /> control. </param> 577 </Docs> 578 <AssemblyInfo> 579 <AssemblyVersion>2.0.0.0</AssemblyVersion> 580 </AssemblyInfo> 581 </Member> 582 <Member MemberName="SwitchViewByIDCommandName"> 583 <MemberSignature Language="C#" Value="public static readonly string SwitchViewByIDCommandName;" /> 584 <MemberType>Field</MemberType> 585 <ReturnValue> 586 <ReturnType>System.String</ReturnType> 587 </ReturnValue> 588 <Docs> 589 <since version=".NET 2.0" /> 590 <remarks> 591 <attribution license="cc4" from="Microsoft" modified="false" /> 592 <para>Use the <see cref="F:System.Web.UI.WebControls.MultiView.SwitchViewByIDCommandName" /> field to represent the "SwitchViewByID" command name.</para> 593 <para>You can use the value of this field to take advantage of the <see cref="T:System.Web.UI.WebControls.MultiView" /> control's automatic updating of the active <see cref="T:System.Web.UI.WebControls.View" /> control. For example, if a <see cref="T:System.Web.UI.WebControls.View" /> control contains a <see cref="T:System.Web.UI.WebControls.Button" /> control that navigates to the first <see cref="T:System.Web.UI.WebControls.View" /> when clicked, you can set the <see cref="P:System.Web.UI.WebControls.Button.CommandName" /> property to the value of the <see cref="F:System.Web.UI.WebControls.MultiView.SwitchViewByIDCommandName" /> field, which is "SwitchViewByID". Set the <see cref="P:System.Web.UI.WebControls.Button.CommandArgument" /> property to the ID of the first <see cref="T:System.Web.UI.WebControls.View" /> in the <see cref="T:System.Web.UI.WebControls.MultiView" /> control, such as "Page1". This causes the <see cref="T:System.Web.UI.WebControls.MultiView" /> control to automatically set "Page1" as the active <see cref="T:System.Web.UI.WebControls.View" /> when the button is clicked.</para> 594 </remarks> 595 <summary> 596 <attribution license="cc4" from="Microsoft" modified="false" /> 597 <para>Represents the command name associated with changing the active <see cref="T:System.Web.UI.WebControls.View" /> control in a <see cref="T:System.Web.UI.WebControls.MultiView" /> control, based on a specified <see cref="T:System.Web.UI.WebControls.View" /> id. This field is read-only.</para> 598 </summary> 599 </Docs> 600 <AssemblyInfo> 601 <AssemblyVersion>2.0.0.0</AssemblyVersion> 602 </AssemblyInfo> 603 </Member> 604 <Member MemberName="SwitchViewByIndexCommandName"> 605 <MemberSignature Language="C#" Value="public static readonly string SwitchViewByIndexCommandName;" /> 606 <MemberType>Field</MemberType> 607 <ReturnValue> 608 <ReturnType>System.String</ReturnType> 609 </ReturnValue> 610 <Docs> 611 <since version=".NET 2.0" /> 612 <remarks> 613 <attribution license="cc4" from="Microsoft" modified="false" /> 614 <para>Use the <see cref="F:System.Web.UI.WebControls.MultiView.SwitchViewByIndexCommandName" /> field to represent the "SwitchViewByIndex" command name.</para> 615 <para>You can use the value of this field to take advantage of the <see cref="T:System.Web.UI.WebControls.MultiView" /> control's automatic updating of the active <see cref="T:System.Web.UI.WebControls.View" /> control. For example, if a <see cref="T:System.Web.UI.WebControls.View" /> control contains a <see cref="T:System.Web.UI.WebControls.Button" /> control that navigates to the first <see cref="T:System.Web.UI.WebControls.View" /> when clicked, you can set the <see cref="P:System.Web.UI.WebControls.Button.CommandName" /> property to the value of the <see cref="F:System.Web.UI.WebControls.MultiView.SwitchViewByIndexCommandName" /> field, which is "SwitchViewByIndex". Set the <see cref="P:System.Web.UI.WebControls.Button.CommandArgument" /> property to the index of the first <see cref="T:System.Web.UI.WebControls.View" /> in the <see cref="T:System.Web.UI.WebControls.MultiView" /> control, which is 0. This causes the <see cref="T:System.Web.UI.WebControls.MultiView" /> control to automatically set the <see cref="P:System.Web.UI.WebControls.MultiView.ActiveViewIndex" /> property to 0 when the button is clicked.</para> 616 </remarks> 617 <summary> 618 <attribution license="cc4" from="Microsoft" modified="false" /> 619 <para>Represents the command name associated with changing the active <see cref="T:System.Web.UI.WebControls.View" /> control in a <see cref="T:System.Web.UI.WebControls.MultiView" /> control based on a specified <see cref="T:System.Web.UI.WebControls.View" /> index. This field is read-only.</para> 620 </summary> 621 </Docs> 622 <AssemblyInfo> 623 <AssemblyVersion>2.0.0.0</AssemblyVersion> 624 </AssemblyInfo> 625 </Member> 626 <Member MemberName="Views"> 627 <MemberSignature Language="C#" Value="public virtual System.Web.UI.WebControls.ViewCollection Views { get; }" /> 628 <MemberType>Property</MemberType> 629 <Attributes> 630 <Attribute> 631 <AttributeName>System.ComponentModel.Browsable(false)</AttributeName> 632 </Attribute> 633 <Attribute> 634 <AttributeName>System.Web.UI.PersistenceMode(System.Web.UI.PersistenceMode.InnerDefaultProperty)</AttributeName> 635 </Attribute> 636 </Attributes> 637 <ReturnValue> 638 <ReturnType>System.Web.UI.WebControls.ViewCollection</ReturnType> 639 </ReturnValue> 640 <Docs> 641 <value>To be added.</value> 642 <since version=".NET 2.0" /> 643 <remarks> 644 <attribution license="cc4" from="Microsoft" modified="false" /> 645 <para>Use this property to programmatically manage the <see cref="T:System.Web.UI.WebControls.View" /> controls in a <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 646 </remarks> 647 <summary> 648 <attribution license="cc4" from="Microsoft" modified="false" /> 649 <para>Gets the collection of <see cref="T:System.Web.UI.WebControls.View" /> controls in the <see cref="T:System.Web.UI.WebControls.MultiView" /> control.</para> 650 </summary> 651 </Docs> 652 <AssemblyInfo> 653 <AssemblyVersion>2.0.0.0</AssemblyVersion> 654 </AssemblyInfo> 655 </Member> 656 </Members> 657</Type>