ControlCollection.AddHScrollBar Method (Range, Single, Single, String)

Adds a new HScrollBar control to the document in the specified size and location.

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

Syntax

'Declaration
Public Function AddHScrollBar ( _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As HScrollBar
'Usage
Dim instance As ControlCollection
Dim range As Range
Dim width As Single
Dim height As Single
Dim name As String
Dim returnValue As HScrollBar

returnValue = instance.AddHScrollBar(range, _
    width, height, name)
public HScrollBar AddHScrollBar(
    Range range,
    float width,
    float height,
    string name
)

Parameters

  • height
    Type: System.Single
    The height of the control in points.

Return Value

Type: Microsoft.Office.Tools.Word.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.

Remarks

This method enables you to add HScrollBar objects to the end of the ControlCollection.

To remove an HScrollBar control that was added programmatically, use the Remove method.

Examples

The following code example adds an HScrollBar control to the first paragraph in the document, and then moves the scroll box to the center of the scroll bar.

    Private Sub WordRangeAddHScrollBar()
        Me.Paragraphs(1).Range.InsertParagraphBefore()
        Dim HScrollBar1 As Microsoft.Office.Tools.Word.Controls. _
            HScrollBar = Me.Controls.AddHScrollBar(Me.Paragraphs(1). _
            Range, 100, 15, "HScrollBar1")
        HScrollBar1.Value = 50

    End Sub 

private void WordRangeAddHScrollBar()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.HScrollBar
        hScrollBar1 = this.Controls.AddHScrollBar(
        this.Paragraphs[1].Range, 100, 15, "hScrollBar1");
    hScrollBar1.Value = 50;
}

.NET Framework Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddHScrollBar Overload

Microsoft.Office.Tools.Word Namespace