Freigeben über


ControlExtensions.AddVScrollBar-Methode (ControlCollection, Range, Single, Single, String)

Fügt dem Dokument in der angegebenen Größe und an der angegebenen Position ein neues VScrollBar-Steuerelement hinzu.

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 AddVScrollBar ( _
    controls As ControlCollection, _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As VScrollBar
public static VScrollBar AddVScrollBar(
    this ControlCollection controls,
    Range range,
    float width,
    float height,
    string name
)

Parameter

  • controls
    Typ: Microsoft.Office.Tools.Word.ControlCollection
    Die Auflistung, der das Steuerelement hinzugefügt werden soll.Geben Sie diesen Parameter nicht selbst an.Wenn Sie diese Methode für die von der Document.Controls-Eigenschaft (in einem Projekt auf Anwendungsebene) oder von der DocumentBase.Controls-Eigenschaft (in einem Projekt auf Dokumentebene) zurückgegebene Auflistung aufrufen, wird dieser Parameter automatisch angegeben.
  • width
    Typ: System.Single
    Die Breite des Steuerelements in Punkt.
  • height
    Typ: System.Single
    Die Höhe des Steuerelements in Punkt.

Rückgabewert

Typ: Microsoft.Office.Tools.Word.Controls.VScrollBar
Das Steuerelement, das dem Dokument hinzugefügt wurde.

Hinweis zur Verwendung

In Visual Basic und C# können Sie diese Methode als Instanzenmethode für ein beliebiges Objekt vom Typ ControlCollection aufrufen. Bei Verwendung der Syntax für Instanzenmethoden lassen Sie den ersten Parameter aus. Weitere Informationen finden Sie unter Erweiterungsmethoden (Visual Basic) und Erweiterungsmethoden (C#-Programmierhandbuch).

Ausnahmen

Ausnahme Bedingung
ArgumentNullException

Das name-Argument oder das range-Argument ist nullNULL-Verweis (Nothing in Visual Basic), oder das name-Argument hat die Länge 0 (null).

ControlNameAlreadyExistsException

Ein Steuerelement mit dem gleichen Namen ist bereits in der ControlCollection-Instanz vorhanden.

InvalidRangeException

Der angegebene Bereich ist nicht gültig.

Hinweise

Mithilfe dieser Methode können Sie VScrollBar-Objekte am Ende der ControlCollection hinzufügen.

Um ein VScrollBar-Steuerelement zu entfernen, das programmgesteuert hinzugefügt wurde, verwenden Sie die Remove-Methode.

Beispiele

Im folgenden Codebeispiel wird im ersten Absatz des Dokuments ein VScrollBar-Steuerelement hinzugefügt. Anschließend wird das Bildlauffeld in die Mitte der Schiebeleiste verschoben. Wenn Sie dieses Beispiel verwenden möchten, führen Sie es von der ThisDocument-Klasse in einem Projekt auf Dokumentebene aus.

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;
}

.NET Framework-Sicherheit

Siehe auch

Referenz

ControlExtensions Klasse

AddVScrollBar-Überladung

Microsoft.Office.Tools.Word-Namespace