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

  • Article

Adds a new HScrollBar control to the worksheet at the range specified.

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 ( _
    range As Range, _
    name As String _
) As HScrollBar

'Usage
Dim instance As ControlCollection 
Dim range As Range 
Dim name As String 
Dim returnValue As HScrollBar 

returnValue = instance.AddHScrollBar(range, _
    name)

public HScrollBar AddHScrollBar(
    Range range,
    string name
)

public:
HScrollBar^ AddHScrollBar(
    Range^ range, 
    String^ name
)

public function AddHScrollBar(
    range : Range, 
    name : String
) : HScrollBar

Parameters

  • range
    Type: Range

    A Range that provides the bounds for the control.

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 or range argument is nulla null reference (Nothing in Visual Basic), or the name argument has zero length.
ControlNameAlreadyExistsException

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

The range that was specified is not valid. Multi-area ranges cannot be used. The range should be on the same worksheet as 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.

The control automatically resizes when the range is resized.

Examples

The following code example adds an HScrollBar control to cells A1 through B1, and then moves the scroll box to the center of the scroll bar.

Private Sub ExcelRangeAddHScrollBar()
    Dim HScrollBar1 As Microsoft.Office.Tools.Excel. _
        Controls.HScrollBar = Me.Controls. _
        AddHScrollBar(Me.Range("A1", "B1"), _
        "HScrollBar1")
    HScrollBar1.Value = 50

End Sub

private void ExcelRangeAddHScrollBar()
{
    Microsoft.Office.Tools.Excel.Controls.HScrollBar
        hScrollBar1 = this.Controls.AddHScrollBar(
        this.Range["A1", "B1"], "hScrollBar1");
    hScrollBar1.Value = 50;
}

.NET Framework Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddHScrollBar Overload

Microsoft.Office.Tools.Excel Namespace