mcs/class/Managed.Windows.Forms/Documentation/en/System.Windows.Forms/MdiClient.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="MdiClient" FullName="System.Windows.Forms.MdiClient">
   3   <TypeSignature Language="C#" Value="public sealed class MdiClient : System.Windows.Forms.Control" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.Windows.Forms.Control</BaseTypeName>
  11   </Base>
  12   <Interfaces />
  13   <Attributes>
  14     <Attribute>
  15       <AttributeName>System.ComponentModel.ToolboxItem(false)</AttributeName>
  16     </Attribute>
  17     <Attribute>
  18       <AttributeName>System.ComponentModel.DesignTimeVisible(false)</AttributeName>
  19     </Attribute>
  20     <Attribute>
  21       <AttributeName>System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)</AttributeName>
  22     </Attribute>
  23     <Attribute>
  24       <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
  25     </Attribute>
  26   </Attributes>
  27   <Docs>
  28     <remarks>
  29       <attribution license="cc4" from="Microsoft" modified="false" />
  30       <para>You should not create an <see cref="T:System.Windows.Forms.MdiClient" /> control. A form creates and uses the <see cref="T:System.Windows.Forms.MdiClient" /> when you set the <see cref="P:System.Windows.Forms.Form.IsMdiContainer" /> property to true.</para>
  31     </remarks>
  32     <summary>
  33       <attribution license="cc4" from="Microsoft" modified="false" />
  34       <para>Represents the container for multiple-document interface (MDI) child forms. This class cannot be inherited.</para>
  35     </summary>
  36   </Docs>
  37   <Members>
  38     <Member MemberName=".ctor">
  39       <MemberSignature Language="C#" Value="public MdiClient ();" />
  40       <MemberType>Constructor</MemberType>
  41       <Parameters />
  42       <Docs>
  43         <remarks>To be added.</remarks>
  44         <summary>
  45           <attribution license="cc4" from="Microsoft" modified="false" />
  46           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.MdiClient" /> class. </para>
  47         </summary>
  48       </Docs>
  49       <AssemblyInfo>
  50         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  51         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  52       </AssemblyInfo>
  53     </Member>
  54     <Member MemberName="BackgroundImage">
  55       <MemberSignature Language="C#" Value="public override System.Drawing.Image BackgroundImage { set; get; }" />
  56       <MemberType>Property</MemberType>
  57       <Attributes>
  58         <Attribute>
  59           <AttributeName>System.ComponentModel.Localizable(true)</AttributeName>
  60         </Attribute>
  61       </Attributes>
  62       <ReturnValue>
  63         <ReturnType>System.Drawing.Image</ReturnType>
  64       </ReturnValue>
  65       <Docs>
  66         <value>To be added.</value>
  67         <remarks>
  68           <attribution license="cc4" from="Microsoft" modified="false" />
  69           <para>Use the <see cref="P:System.Windows.Forms.MdiClient.BackgroundImage" /> property to get and set the background image of a form’s MDI client area.</para>
  70         </remarks>
  71         <summary>
  72           <attribution license="cc4" from="Microsoft" modified="false" />
  73           <para>Gets or sets the background image displayed in the <see cref="T:System.Windows.Forms.MdiClient" /> control.</para>
  74         </summary>
  75       </Docs>
  76       <AssemblyInfo>
  77         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  78         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  79       </AssemblyInfo>
  80     </Member>
  81     <Member MemberName="BackgroundImageLayout">
  82       <MemberSignature Language="C#" Value="public override System.Windows.Forms.ImageLayout BackgroundImageLayout { set; get; }" />
  83       <MemberType>Property</MemberType>
  84       <AssemblyInfo>
  85         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  86       </AssemblyInfo>
  87       <Attributes>
  88         <Attribute>
  89           <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
  90         </Attribute>
  91         <Attribute>
  92           <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
  93         </Attribute>
  94       </Attributes>
  95       <ReturnValue>
  96         <ReturnType>System.Windows.Forms.ImageLayout</ReturnType>
  97       </ReturnValue>
  98       <Docs>
  99         <value>To be added.</value>
 100         <remarks>
 101           <attribution license="cc4" from="Microsoft" modified="false" />
 102           <para>This property is not relevant to this class.</para>
 103         </remarks>
 104         <summary>
 105           <attribution license="cc4" from="Microsoft" modified="false" />
 106           <para>This property is not relevant to this class.</para>
 107         </summary>
 108       </Docs>
 109     </Member>
 110     <Member MemberName="CreateControlsInstance">
 111       <MemberSignature Language="C#" Value="protected override System.Windows.Forms.Control.ControlCollection CreateControlsInstance ();" />
 112       <MemberType>Method</MemberType>
 113       <ReturnValue>
 114         <ReturnType>System.Windows.Forms.Control+ControlCollection</ReturnType>
 115       </ReturnValue>
 116       <Parameters />
 117       <Docs>
 118         <summary>To be added.</summary>
 119         <returns>To be added.</returns>
 120         <remarks>To be added.</remarks>
 121       </Docs>
 122       <AssemblyInfo>
 123         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 124         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 125       </AssemblyInfo>
 126     </Member>
 127     <Member MemberName="CreateParams">
 128       <MemberSignature Language="C#" Value="protected override System.Windows.Forms.CreateParams CreateParams { get; }" />
 129       <MemberType>Property</MemberType>
 130       <ReturnValue>
 131         <ReturnType>System.Windows.Forms.CreateParams</ReturnType>
 132       </ReturnValue>
 133       <Docs>
 134         <summary>To be added.</summary>
 135         <value>To be added.</value>
 136         <remarks>To be added.</remarks>
 137       </Docs>
 138       <AssemblyInfo>
 139         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 140         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 141       </AssemblyInfo>
 142     </Member>
 143     <Member MemberName="LayoutMdi">
 144       <MemberSignature Language="C#" Value="public void LayoutMdi (System.Windows.Forms.MdiLayout value);" />
 145       <MemberType>Method</MemberType>
 146       <ReturnValue>
 147         <ReturnType>System.Void</ReturnType>
 148       </ReturnValue>
 149       <Parameters>
 150         <Parameter Name="value" Type="System.Windows.Forms.MdiLayout" />
 151       </Parameters>
 152       <Docs>
 153         <remarks>
 154           <attribution license="cc4" from="Microsoft" modified="false" />
 155           <para>Use the <see cref="M:System.Windows.Forms.Form.LayoutMdi(System.Windows.Forms.MdiLayout)" /> method to arrange MDI child forms on a parent form.</para>
 156         </remarks>
 157         <summary>
 158           <attribution license="cc4" from="Microsoft" modified="false" />
 159           <para>Arranges the multiple-document interface (MDI) child forms within the MDI parent form.</para>
 160         </summary>
 161         <param name="value">
 162           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.MdiLayout" /> values that defines the layout of MDI child forms.</param>
 163       </Docs>
 164       <AssemblyInfo>
 165         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 166         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 167       </AssemblyInfo>
 168     </Member>
 169     <Member MemberName="MdiChildren">
 170       <MemberSignature Language="C#" Value="public System.Windows.Forms.Form[] MdiChildren { get; }" />
 171       <MemberType>Property</MemberType>
 172       <ReturnValue>
 173         <ReturnType>System.Windows.Forms.Form[]</ReturnType>
 174       </ReturnValue>
 175       <Docs>
 176         <value>To be added.</value>
 177         <remarks>
 178           <attribution license="cc4" from="Microsoft" modified="false" />
 179           <para>Use the <see cref="P:System.Windows.Forms.Form.MdiChildren" /> property to get the child MDI forms of the <see cref="T:System.Windows.Forms.MdiClient" />.</para>
 180         </remarks>
 181         <summary>
 182           <attribution license="cc4" from="Microsoft" modified="false" />
 183           <para>Gets the child multiple-document interface (MDI) forms of the <see cref="T:System.Windows.Forms.MdiClient" /> control.</para>
 184         </summary>
 185       </Docs>
 186       <AssemblyInfo>
 187         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 188         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 189       </AssemblyInfo>
 190     </Member>
 191     <Member MemberName="OnResize">
 192       <MemberSignature Language="C#" Value="protected override void OnResize (EventArgs e);" />
 193       <MemberType>Method</MemberType>
 194       <ReturnValue>
 195         <ReturnType>System.Void</ReturnType>
 196       </ReturnValue>
 197       <Parameters>
 198         <Parameter Name="e" Type="System.EventArgs" />
 199       </Parameters>
 200       <Docs>
 201         <param name="e">To be added.</param>
 202         <summary>To be added.</summary>
 203         <remarks>To be added.</remarks>
 204       </Docs>
 205       <AssemblyInfo>
 206         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 207         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 208       </AssemblyInfo>
 209     </Member>
 210     <Member MemberName="ScaleControl">
 211       <MemberSignature Language="C#" Value="protected override void ScaleControl (System.Drawing.SizeF factor, System.Windows.Forms.BoundsSpecified specified);" />
 212       <MemberType>Method</MemberType>
 213       <AssemblyInfo>
 214         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 215       </AssemblyInfo>
 216       <ReturnValue>
 217         <ReturnType>System.Void</ReturnType>
 218       </ReturnValue>
 219       <Parameters>
 220         <Parameter Name="factor" Type="System.Drawing.SizeF" />
 221         <Parameter Name="specified" Type="System.Windows.Forms.BoundsSpecified" />
 222       </Parameters>
 223       <Docs>
 224         <param name="factor">To be added.</param>
 225         <param name="specified">To be added.</param>
 226         <summary>To be added.</summary>
 227         <remarks>To be added.</remarks>
 228       </Docs>
 229     </Member>
 230     <Member MemberName="ScaleCore">
 231       <MemberSignature Language="C#" Value="protected override void ScaleCore (float dx, float dy);" />
 232       <MemberType>Method</MemberType>
 233       <ReturnValue>
 234         <ReturnType>System.Void</ReturnType>
 235       </ReturnValue>
 236       <Parameters>
 237         <Parameter Name="dx" Type="System.Single" />
 238         <Parameter Name="dy" Type="System.Single" />
 239       </Parameters>
 240       <Docs>
 241         <param name="dx">To be added.</param>
 242         <param name="dy">To be added.</param>
 243         <summary>To be added.</summary>
 244         <remarks>To be added.</remarks>
 245       </Docs>
 246       <AssemblyInfo>
 247         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 248         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 249       </AssemblyInfo>
 250       <Attributes>
 251         <Attribute>
 252           <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
 253         </Attribute>
 254       </Attributes>
 255     </Member>
 256     <Member MemberName="SetBoundsCore">
 257       <MemberSignature Language="C#" Value="protected override void SetBoundsCore (int x, int y, int width, int height, System.Windows.Forms.BoundsSpecified specified);" />
 258       <MemberType>Method</MemberType>
 259       <ReturnValue>
 260         <ReturnType>System.Void</ReturnType>
 261       </ReturnValue>
 262       <Parameters>
 263         <Parameter Name="x" Type="System.Int32" />
 264         <Parameter Name="y" Type="System.Int32" />
 265         <Parameter Name="width" Type="System.Int32" />
 266         <Parameter Name="height" Type="System.Int32" />
 267         <Parameter Name="specified" Type="System.Windows.Forms.BoundsSpecified" />
 268       </Parameters>
 269       <Docs>
 270         <param name="x">To be added.</param>
 271         <param name="y">To be added.</param>
 272         <param name="width">To be added.</param>
 273         <param name="height">To be added.</param>
 274         <param name="specified">To be added.</param>
 275         <summary>To be added.</summary>
 276         <remarks>To be added.</remarks>
 277       </Docs>
 278       <AssemblyInfo>
 279         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 280         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 281       </AssemblyInfo>
 282     </Member>
 283     <Member MemberName="WndProc">
 284       <MemberSignature Language="C#" Value="protected override void WndProc (ref System.Windows.Forms.Message m);" />
 285       <MemberType>Method</MemberType>
 286       <ReturnValue>
 287         <ReturnType>System.Void</ReturnType>
 288       </ReturnValue>
 289       <Parameters>
 290         <Parameter Name="m" Type="System.Windows.Forms.Message&amp;" RefType="ref" />
 291       </Parameters>
 292       <Docs>
 293         <param name="m">To be added.</param>
 294         <summary>To be added.</summary>
 295         <remarks>To be added.</remarks>
 296       </Docs>
 297       <AssemblyInfo>
 298         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 299         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 300       </AssemblyInfo>
 301     </Member>
 302   </Members>
 303 </Type>