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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="ScrollEventArgs" FullName="System.Windows.Forms.ScrollEventArgs">
   3   <TypeSignature Language="C#" Value="public class ScrollEventArgs : EventArgs" />
   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.EventArgs</BaseTypeName>
  11   </Base>
  12   <Interfaces />
  13   <Attributes>
  14     <Attribute>
  15       <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
  16     </Attribute>
  17   </Attributes>
  18   <Docs>
  19     <remarks>
  20       <attribution license="cc4" from="Microsoft" modified="false" />
  21       <para>The Scroll event occurs when the user changes the value of the scroll bar. This event can result from a variety of actions, such as clicking a scroll bar arrow, pressing the UP ARROW or DOWN ARROW, or dragging the scroll box. The <see cref="T:System.Windows.Forms.ScrollEventArgs" /> specifies the type of scroll event that occurred and the new value of the scroll bar. Use the <see cref="P:System.Windows.Forms.ScrollEventArgs.ScrollOrientation" /> property to determine the scroll bar orientation for the Scroll event.</para>
  22       <para>The Scroll event occurs for the <see cref="T:System.Windows.Forms.DataGridView" />, <see cref="T:System.Windows.Forms.ScrollableControl" />, <see cref="T:System.Windows.Forms.ScrollBar" />, and <see cref="T:System.Windows.Forms.DataGrid" /> controls.</para>
  23     </remarks>
  24     <summary>
  25       <attribution license="cc4" from="Microsoft" modified="false" />
  26       <para>Provides data for the Scroll event.</para>
  27     </summary>
  28   </Docs>
  29   <Members>
  30     <Member MemberName=".ctor">
  31       <MemberSignature Language="C#" Value="public ScrollEventArgs (System.Windows.Forms.ScrollEventType type, int newValue);" />
  32       <MemberType>Constructor</MemberType>
  33       <Parameters>
  34         <Parameter Name="type" Type="System.Windows.Forms.ScrollEventType" />
  35         <Parameter Name="newValue" Type="System.Int32" />
  36       </Parameters>
  37       <Docs>
  38         <remarks>To be added.</remarks>
  39         <summary>
  40           <attribution license="cc4" from="Microsoft" modified="false" />
  41           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.ScrollEventArgs" /> class using the given values for the <see cref="P:System.Windows.Forms.ScrollEventArgs.Type" /> and <see cref="P:System.Windows.Forms.ScrollEventArgs.NewValue" /> properties.</para>
  42         </summary>
  43         <param name="type">
  44           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.ScrollEventType" /> values. </param>
  45         <param name="newValue">
  46           <attribution license="cc4" from="Microsoft" modified="false" />The new value for the scroll bar. </param>
  47       </Docs>
  48       <AssemblyInfo>
  49         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  50         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  51       </AssemblyInfo>
  52     </Member>
  53     <Member MemberName=".ctor">
  54       <MemberSignature Language="C#" Value="public ScrollEventArgs (System.Windows.Forms.ScrollEventType type, int oldValue, int newValue);" />
  55       <MemberType>Constructor</MemberType>
  56       <AssemblyInfo>
  57         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  58       </AssemblyInfo>
  59       <Parameters>
  60         <Parameter Name="type" Type="System.Windows.Forms.ScrollEventType" />
  61         <Parameter Name="oldValue" Type="System.Int32" />
  62         <Parameter Name="newValue" Type="System.Int32" />
  63       </Parameters>
  64       <Docs>
  65         <remarks>To be added.</remarks>
  66         <summary>
  67           <attribution license="cc4" from="Microsoft" modified="false" />
  68           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.ScrollEventArgs" /> class using the given values for the <see cref="P:System.Windows.Forms.ScrollEventArgs.Type" />, <see cref="P:System.Windows.Forms.ScrollEventArgs.OldValue" />, and <see cref="P:System.Windows.Forms.ScrollEventArgs.NewValue" /> properties.</para>
  69         </summary>
  70         <param name="type">
  71           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.ScrollEventType" /> values. </param>
  72         <param name="oldValue">
  73           <attribution license="cc4" from="Microsoft" modified="false" />The old value for the scroll bar. </param>
  74         <param name="newValue">
  75           <attribution license="cc4" from="Microsoft" modified="false" />The new value for the scroll bar. </param>
  76       </Docs>
  77     </Member>
  78     <Member MemberName=".ctor">
  79       <MemberSignature Language="C#" Value="public ScrollEventArgs (System.Windows.Forms.ScrollEventType type, int newValue, System.Windows.Forms.ScrollOrientation scroll);" />
  80       <MemberType>Constructor</MemberType>
  81       <AssemblyInfo>
  82         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  83       </AssemblyInfo>
  84       <Parameters>
  85         <Parameter Name="type" Type="System.Windows.Forms.ScrollEventType" />
  86         <Parameter Name="newValue" Type="System.Int32" />
  87         <Parameter Name="scroll" Type="System.Windows.Forms.ScrollOrientation" />
  88       </Parameters>
  89       <Docs>
  90         <remarks>To be added.</remarks>
  91         <summary>
  92           <attribution license="cc4" from="Microsoft" modified="false" />
  93           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.ScrollEventArgs" /> class using the given values for the <see cref="P:System.Windows.Forms.ScrollEventArgs.Type" />, <see cref="P:System.Windows.Forms.ScrollEventArgs.NewValue" />, and <see cref="P:System.Windows.Forms.ScrollEventArgs.ScrollOrientation" /> properties.</para>
  94         </summary>
  95         <param name="type">
  96           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.ScrollEventType" /> values. </param>
  97         <param name="newValue">
  98           <attribution license="cc4" from="Microsoft" modified="false" />The new value for the scroll bar. </param>
  99         <param name="scroll">
 100           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.ScrollOrientation" /> values. </param>
 101       </Docs>
 102     </Member>
 103     <Member MemberName=".ctor">
 104       <MemberSignature Language="C#" Value="public ScrollEventArgs (System.Windows.Forms.ScrollEventType type, int oldValue, int newValue, System.Windows.Forms.ScrollOrientation scroll);" />
 105       <MemberType>Constructor</MemberType>
 106       <AssemblyInfo>
 107         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 108       </AssemblyInfo>
 109       <Parameters>
 110         <Parameter Name="type" Type="System.Windows.Forms.ScrollEventType" />
 111         <Parameter Name="oldValue" Type="System.Int32" />
 112         <Parameter Name="newValue" Type="System.Int32" />
 113         <Parameter Name="scroll" Type="System.Windows.Forms.ScrollOrientation" />
 114       </Parameters>
 115       <Docs>
 116         <remarks>To be added.</remarks>
 117         <summary>
 118           <attribution license="cc4" from="Microsoft" modified="false" />
 119           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.ScrollEventArgs" /> class using the given values for the <see cref="P:System.Windows.Forms.ScrollEventArgs.Type" />, <see cref="P:System.Windows.Forms.ScrollEventArgs.OldValue" />, <see cref="P:System.Windows.Forms.ScrollEventArgs.NewValue" />, and <see cref="P:System.Windows.Forms.ScrollEventArgs.ScrollOrientation" /> properties.</para>
 120         </summary>
 121         <param name="type">
 122           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.ScrollEventType" /> values. </param>
 123         <param name="oldValue">
 124           <attribution license="cc4" from="Microsoft" modified="false" />The old value for the scroll bar. </param>
 125         <param name="newValue">
 126           <attribution license="cc4" from="Microsoft" modified="false" />The new value for the scroll bar. </param>
 127         <param name="scroll">
 128           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.ScrollOrientation" /> values. </param>
 129       </Docs>
 130     </Member>
 131     <Member MemberName="NewValue">
 132       <MemberSignature Language="C#" Value="public int NewValue { set; get; }" />
 133       <MemberType>Property</MemberType>
 134       <ReturnValue>
 135         <ReturnType>System.Int32</ReturnType>
 136       </ReturnValue>
 137       <Docs>
 138         <value>To be added.</value>
 139         <remarks>To be added.</remarks>
 140         <summary>
 141           <attribution license="cc4" from="Microsoft" modified="false" />
 142           <para>Gets or sets the new <see cref="P:System.Windows.Forms.ScrollBar.Value" /> of the scroll bar.</para>
 143         </summary>
 144       </Docs>
 145       <AssemblyInfo>
 146         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 147         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 148       </AssemblyInfo>
 149     </Member>
 150     <Member MemberName="OldValue">
 151       <MemberSignature Language="C#" Value="public int OldValue { get; }" />
 152       <MemberType>Property</MemberType>
 153       <AssemblyInfo>
 154         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 155       </AssemblyInfo>
 156       <ReturnValue>
 157         <ReturnType>System.Int32</ReturnType>
 158       </ReturnValue>
 159       <Docs>
 160         <value>To be added.</value>
 161         <remarks>To be added.</remarks>
 162         <summary>
 163           <attribution license="cc4" from="Microsoft" modified="false" />
 164           <para>Gets the old <see cref="P:System.Windows.Forms.ScrollBar.Value" /> of the scroll bar.</para>
 165         </summary>
 166       </Docs>
 167     </Member>
 168     <Member MemberName="ScrollOrientation">
 169       <MemberSignature Language="C#" Value="public System.Windows.Forms.ScrollOrientation ScrollOrientation { get; }" />
 170       <MemberType>Property</MemberType>
 171       <AssemblyInfo>
 172         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 173       </AssemblyInfo>
 174       <ReturnValue>
 175         <ReturnType>System.Windows.Forms.ScrollOrientation</ReturnType>
 176       </ReturnValue>
 177       <Docs>
 178         <value>To be added.</value>
 179         <remarks>
 180           <attribution license="cc4" from="Microsoft" modified="false" />
 181           <para>You would typically use the <see cref="P:System.Windows.Forms.ScrollEventArgs.ScrollOrientation" /> property to determine the scroll bar orientation that raised the Scroll event, such as with the <see cref="E:System.Windows.Forms.ScrollableControl.Scroll" /> event.</para>
 182         </remarks>
 183         <summary>
 184           <attribution license="cc4" from="Microsoft" modified="false" />
 185           <para>Gets the scroll bar orientation that raised the Scroll event.</para>
 186         </summary>
 187       </Docs>
 188     </Member>
 189     <Member MemberName="Type">
 190       <MemberSignature Language="C#" Value="public System.Windows.Forms.ScrollEventType Type { get; }" />
 191       <MemberType>Property</MemberType>
 192       <ReturnValue>
 193         <ReturnType>System.Windows.Forms.ScrollEventType</ReturnType>
 194       </ReturnValue>
 195       <Docs>
 196         <value>To be added.</value>
 197         <remarks>To be added.</remarks>
 198         <summary>
 199           <attribution license="cc4" from="Microsoft" modified="false" />
 200           <para>Gets the type of scroll event that occurred.</para>
 201         </summary>
 202       </Docs>
 203       <AssemblyInfo>
 204         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 205         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 206       </AssemblyInfo>
 207     </Member>
 208   </Members>
 209 </Type>