Share via


ControlExtensions.AddHScrollBar Method (ControlCollection, 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.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function AddHScrollBar ( _
    controls As ControlCollection, _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As HScrollBar
public static HScrollBar AddHScrollBar(
    this ControlCollection controls,
    Range range,
    float width,
    float height,
    string name
)

Parameters

  • range
    Type: Range

    The location of the control.

  • height
    Type: System.Single

    The height of the control in points.

Return Value

Type: Microsoft.Office.Tools.Word.Controls.HScrollBar
The control that was added to the document.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ControlCollection. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

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. To use this example, run it from the ThisDocument class in a document-level project.

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

ControlExtensions Class

AddHScrollBar Overload

Microsoft.Office.Tools.Word Namespace