Freigeben über

ControlExtensions.AddProgressBar-Methode (ControlCollection, Single, Single, Single, Single, String)

  • Artikel

Fügt dem Dokument in der angegebenen Größe und an der angegebenen Position ein neues ProgressBar-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 AddProgressBar ( _
    controls As ControlCollection, _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As ProgressBar

public static ProgressBar AddProgressBar(
    this ControlCollection controls,
    float left,
    float top,
    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.
  • left
    Typ: System.Single
    Die Entfernung zwischen dem linken Rand des Steuerelements und dem linken Rand des Dokuments in Punkt.
  • top
    Typ: System.Single
    Die Entfernung zwischen dem oberen Rand des Steuerelements und dem oberen Rand des Dokuments in Punkt.
  • 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.ProgressBar
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 ist nullein Nullverweis (Nothing in Visual Basic) oder hat die Länge 0 (null).
ControlNameAlreadyExistsException

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

Hinweise

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

Um eine ProgressBar zu entfernen, die programmgesteuert hinzugefügt wurde, verwenden Sie die Remove-Methode.

Beispiele

Im folgenden Codebeispiel wird am Anfang des Dokuments ein ProgressBar-Steuerelement hinzugefügt. Anschließend wird die aktuelle Position der ProgressBar auf 50 erhöht. Wenn Sie dieses Beispiel verwenden möchten, führen Sie es von der ThisDocument-Klasse in einem Projekt auf Dokumentebene aus.

Private Sub WordAddProgressBar()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim ProgressBar1 As Microsoft.Office.Tools.Word.Controls _
        .ProgressBar = Me.Controls.AddProgressBar(0, 0, 75, _
        17.25F, "ProgressBar1")
    ProgressBar1.Maximum = 100
    ProgressBar1.Step = 50
    ProgressBar1.PerformStep()
End Sub 

private void WordAddProgressBar()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.ProgressBar
         progressBar1 = this.Controls.AddProgressBar(
         0, 0, 75, 17.25F, "progressBar1");
    progressBar1.Maximum = 100;
    progressBar1.Step = 50;
    progressBar1.PerformStep();
}

.NET Framework-Sicherheit

Siehe auch

Referenz

ControlExtensions Klasse

AddProgressBar-Überladung

Microsoft.Office.Tools.Word-Namespace