ControlCollection.AddHScrollBar Method (Double, Double, Double, Double, String) (2007 System)

  • Article

Adds a new HScrollBar 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 AddHScrollBar ( _
    left As Double, _
    top As Double, _
    width As Double, _
    height As Double, _
    name As String _
) As HScrollBar

'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 HScrollBar 

returnValue = instance.AddHScrollBar(left, _
    top, width, height, name)

public HScrollBar AddHScrollBar(
    double left,
    double top,
    double width,
    double height,
    string name
)

public:
HScrollBar^ AddHScrollBar(
    double left, 
    double top, 
    double width, 
    double height, 
    String^ name
)

public function AddHScrollBar(
    left : double, 
    top : double, 
    width : double, 
    height : double, 
    name : String
) : HScrollBar

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.HScrollBar
The HScrollBar 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 AddHScrollBar method enables you to add HScrollBar objects to the end of the ControlCollection. To remove an HScrollBar control that was previously added programmatically, use the Remove method.

Examples

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

Private Sub ExcelAddHScrollBar()

    Dim HScrollBar1 As Microsoft.Office.Tools. _
        Excel.Controls.HScrollBar = Me.Controls. _
        AddHScrollBar(0, 0, 100, 15, "HScrollBar1")
    HScrollBar1.Value = 50

End Sub

private void ExcelAddHScrollBar()
{

    Microsoft.Office.Tools.Excel.Controls.HScrollBar
        hScrollBar1 = this.Controls.AddHScrollBar(
        0, 0, 100, 15, "hScrollBar1");
    hScrollBar1.Value = 50;
}

.NET Framework Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddHScrollBar Overload

Microsoft.Office.Tools.Excel Namespace