ScrollEventArgs.ScrollOrientation Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ScrollEventArgs.cs

Gets the scroll bar orientation that raised the Scroll event.

public:
 property System::Windows::Forms::ScrollOrientation ScrollOrientation { System::Windows::Forms::ScrollOrientation get(); };

public System.Windows.Forms.ScrollOrientation ScrollOrientation { get; }

member this.ScrollOrientation : System.Windows.Forms.ScrollOrientation

Public ReadOnly Property ScrollOrientation As ScrollOrientation

Property Value

ScrollOrientation

One of the ScrollOrientation values.

Examples

The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the ScrollableControl.Scroll event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing MessageBox.Show with Console.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a project that contains an instance of a type that inherits from ScrollableControl, such as a Panel or ContainerControl. Then name the instance ScrollableControl1 and ensure that the event handler is associated with the ScrollableControl.Scroll event.

private void ScrollableControl1_Scroll(Object sender, ScrollEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "ScrollOrientation", e.ScrollOrientation );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Type", e.Type );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "NewValue", e.NewValue );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "OldValue", e.OldValue );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "Scroll Event" );
}

Private Sub ScrollableControl1_Scroll(sender as Object, e as ScrollEventArgs) _ 
     Handles ScrollableControl1.Scroll

    Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "ScrollOrientation", e.ScrollOrientation)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "Type", e.Type)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "NewValue", e.NewValue)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "OldValue", e.OldValue)
    messageBoxVB.AppendLine()
    MessageBox.Show(messageBoxVB.ToString(),"Scroll Event")

End Sub

Remarks

You would typically use the ScrollOrientation property to determine the scroll bar orientation that raised the Scroll event, such as with the ScrollableControl.Scroll event.