ControlCollection.AddVScrollBar Method (Range, Single, Single, String) (2003 System)

Article
10/10/2008

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

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

Syntax

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

returnValue = instance.AddVScrollBar(range, _
    width, height, name)

public VScrollBar AddVScrollBar(
    Range range,
    float width,
    float height,
    string name
)

Parameters

range
Type: Microsoft.Office.Interop.Word.Range
A Range that provides the location for the control.

width
Type: System.Single
The width of the control in pixels.

height
Type: System.Single
The height of the control in pixels.

name
Type: System.String
The name of the control that can be used to index the control in the ControlCollection instance.

Return Value

Type: Microsoft.Office.Tools.Word.Controls.VScrollBar
The VScrollBar 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 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 first paragraph in the document, and then moves the scroll box to the center of the scroll bar.

Private Sub WordRangeAddVScrollBar()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim VScrollBar1 As Microsoft.Office.Tools.Word.Controls. _
        VScrollBar = Me.Controls.AddVScrollBar( _
        Me.Paragraphs(1).Range, 15, 100, "VScrollBar1")
    VScrollBar1.Value = 50

End Sub

private void WordRangeAddVScrollBar()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.VScrollBar
        vScrollBar1 = this.Controls.AddVScrollBar(
        this.Paragraphs[1].Range, 15, 100, "vScrollBar1");
    vScrollBar1.Value = 50;
}

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.