ControlCollection.AddVScrollBar Method (Double, Double, Double, Double, String)

Adds a new VScrollBar control to the worksheet in the specified size and location.

Namespace:  Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel.v9.0 (in Microsoft.Office.Tools.Excel.v9.0.dll)

Syntax

'Declaration
Public Function AddVScrollBar ( _
    left As Double, _
    top As Double, _
    width As Double, _
    height As Double, _
    name As String _
) As VScrollBar
'Usage
Dim instance As ControlCollection
Dim left As Double
Dim top As Double
Dim width As Double
Dim height As Double
Dim name As String
Dim returnValue As VScrollBar

returnValue = instance.AddVScrollBar(left, _
    top, width, height, name)
public VScrollBar AddVScrollBar(
    double left,
    double top,
    double width,
    double height,
    string name
)

Parameters

  • left
    Type: System.Double
    The distance in points between the left edge of the control and the left edge of the worksheet.
  • top
    Type: System.Double
    The distance in points between the top edge of the control and the top edge of the worksheet.
  • height
    Type: System.Double
    The height of the control in points.

Return Value

Type: Microsoft.Office.Tools.Excel.Controls.VScrollBar
The VScrollBar control that was added to the ControlCollection instance.

Exceptions

Exception Condition
ArgumentNullException

The name argument is nulla null reference (Nothing in Visual Basic) or has zero length.

ControlNameAlreadyExistsException

A control with the same name is already in the ControlCollection instance.

Remarks

The AddVScrollBar method enables you to add VScrollBar objects to the end of the ControlCollection. To remove a VScrollBar control that was previously added programmatically, use the Remove() method.

Examples

The following code example adds a VScrollBar control to the top of the worksheet, and then moves the scroll box to the center of the scroll bar.

Private Sub ExcelAddVScrollBar()
    Dim VScrollBar1 As Microsoft.Office.Tools.Excel. _
        Controls.VScrollBar = Me.Controls.AddVScrollBar( _
        0, 0, 15, 100, "VScrollBar1")

    VScrollBar1.Value = 50

End Sub
private void ExcelAddVScrollBar()
{
    Microsoft.Office.Tools.Excel.Controls.VScrollBar
        vScrollBar1 = this.Controls.AddVScrollBar(
        0, 0, 15, 100, "vScrollBar1");
    vScrollBar1.Value = 50;
}

.NET Framework Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddVScrollBar Overload

Microsoft.Office.Tools.Excel Namespace