linux-packaging-mono/mcs/class/Managed.Windows.Forms/Documentation/en/System.Windows.Forms/ScrollEventArgs.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="ScrollEventArgs" FullName="System.Windows.Forms.ScrollEventArgs">
  <TypeSignature Language="C#" Value="public class ScrollEventArgs : EventArgs" />
  <AssemblyInfo>
    <AssemblyName>System.Windows.Forms</AssemblyName>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.EventArgs</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <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>
      <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>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Provides data for the Scroll event.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ScrollEventArgs (System.Windows.Forms.ScrollEventType type, int newValue);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="type" Type="System.Windows.Forms.ScrollEventType" />
        <Parameter Name="newValue" Type="System.Int32" />
      </Parameters>
      <Docs>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <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>
        </summary>
        <param name="type">
          <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.ScrollEventType" /> values. </param>
        <param name="newValue">
          <attribution license="cc4" from="Microsoft" modified="false" />The new value for the scroll bar. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ScrollEventArgs (System.Windows.Forms.ScrollEventType type, int oldValue, int newValue);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="type" Type="System.Windows.Forms.ScrollEventType" />
        <Parameter Name="oldValue" Type="System.Int32" />
        <Parameter Name="newValue" Type="System.Int32" />
      </Parameters>
      <Docs>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <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>
        </summary>
        <param name="type">
          <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.ScrollEventType" /> values. </param>
        <param name="oldValue">
          <attribution license="cc4" from="Microsoft" modified="false" />The old value for the scroll bar. </param>
        <param name="newValue">
          <attribution license="cc4" from="Microsoft" modified="false" />The new value for the scroll bar. </param>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ScrollEventArgs (System.Windows.Forms.ScrollEventType type, int newValue, System.Windows.Forms.ScrollOrientation scroll);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="type" Type="System.Windows.Forms.ScrollEventType" />
        <Parameter Name="newValue" Type="System.Int32" />
        <Parameter Name="scroll" Type="System.Windows.Forms.ScrollOrientation" />
      </Parameters>
      <Docs>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <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>
        </summary>
        <param name="type">
          <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.ScrollEventType" /> values. </param>
        <param name="newValue">
          <attribution license="cc4" from="Microsoft" modified="false" />The new value for the scroll bar. </param>
        <param name="scroll">
          <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.ScrollOrientation" /> values. </param>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ScrollEventArgs (System.Windows.Forms.ScrollEventType type, int oldValue, int newValue, System.Windows.Forms.ScrollOrientation scroll);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="type" Type="System.Windows.Forms.ScrollEventType" />
        <Parameter Name="oldValue" Type="System.Int32" />
        <Parameter Name="newValue" Type="System.Int32" />
        <Parameter Name="scroll" Type="System.Windows.Forms.ScrollOrientation" />
      </Parameters>
      <Docs>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <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>
        </summary>
        <param name="type">
          <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.ScrollEventType" /> values. </param>
        <param name="oldValue">
          <attribution license="cc4" from="Microsoft" modified="false" />The old value for the scroll bar. </param>
        <param name="newValue">
          <attribution license="cc4" from="Microsoft" modified="false" />The new value for the scroll bar. </param>
        <param name="scroll">
          <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.ScrollOrientation" /> values. </param>
      </Docs>
    </Member>
    <Member MemberName="NewValue">
      <MemberSignature Language="C#" Value="public int NewValue { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the new <see cref="P:System.Windows.Forms.ScrollBar.Value" /> of the scroll bar.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="OldValue">
      <MemberSignature Language="C#" Value="public int OldValue { get; }" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the old <see cref="P:System.Windows.Forms.ScrollBar.Value" /> of the scroll bar.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="ScrollOrientation">
      <MemberSignature Language="C#" Value="public System.Windows.Forms.ScrollOrientation ScrollOrientation { get; }" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Forms.ScrollOrientation</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <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>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the scroll bar orientation that raised the Scroll event.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="Type">
      <MemberSignature Language="C#" Value="public System.Windows.Forms.ScrollEventType Type { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Windows.Forms.ScrollEventType</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the type of scroll event that occurred.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>