TextBoxBase.VerticalOffset Property

Definition

Gets or sets the vertical scroll position.

public:
 property double VerticalOffset { double get(); };
public double VerticalOffset { get; }
member this.VerticalOffset : double
Public ReadOnly Property VerticalOffset As Double

Property Value

A floating-point value that specifies the vertical scroll position, in device-independent units (1/96th inch per unit).

Setting this property causes the text editing control to scroll to the specified vertical offset. Reading this property returns the current vertical offset.

The value of this property is 0.0 if the text editing control is not configured to support scrolling.

This property has no default value.

Exceptions

An attempt is made to set this property to a negative value.

Examples

The following example demonstrates how to read the value of the VerticalOffset property.

private void initValues(object sender, EventArgs e)
{
    myTB1.Text= "ExtentHeight is currently " + myTextBox.ExtentHeight.ToString();
    myTB2.Text= "ExtentWidth is currently " + myTextBox.ExtentWidth.ToString();
    myTB3.Text= "HorizontalOffset is currently " + myTextBox.HorizontalOffset.ToString();
    myTB4.Text= "VerticalOffset is currently " + myTextBox.VerticalOffset.ToString();
    myTB5.Text = "ViewportHeight is currently " + myTextBox.ViewportHeight.ToString();
    myTB6.Text = "ViewportWidth is currently " + myTextBox.ViewportWidth.ToString();
    radiobtn1.IsChecked = true;
}
Private Sub initValues(ByVal sender As Object, ByVal e As EventArgs)
    myTB1.Text = "ExtentHeight is currently " + myTextBox.ExtentHeight.ToString()
    myTB2.Text = "ExtentWidth is currently " + myTextBox.ExtentWidth.ToString()
    myTB3.Text = "HorizontalOffset is currently " + myTextBox.HorizontalOffset.ToString()
    myTB4.Text = "VerticalOffset is currently " + myTextBox.VerticalOffset.ToString()
    myTB5.Text = "ViewportHeight is currently " + myTextBox.ViewportHeight.ToString()
    myTB6.Text = "ViewportWidth is currently " + myTextBox.ViewportWidth.ToString()
    radiobtn1.IsChecked = True

Remarks

The vertical offset is measured from the top of the visible text area.

Applies to

See also