ControlCollection.AddProgressBar Method (Single, Single, Single, Single, String)

Adds a new ProgressBar 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 AddProgressBar ( _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As ProgressBar
'Usage
Dim instance As ControlCollection
Dim left As Single
Dim top As Single
Dim width As Single
Dim height As Single
Dim name As String
Dim returnValue As ProgressBar

returnValue = instance.AddProgressBar(left, _
    top, width, height, name)
public ProgressBar AddProgressBar(
    float left,
    float top,
    float width,
    float height,
    string name
)

Parameters

  • left
    Type: System.Single
    The distance in points between the left edge of the control and the left edge of the document.
  • top
    Type: System.Single
    The distance in points between the top edge of the control and the top edge of the document.
  • height
    Type: System.Single
    The height of the control in points.

Return Value

Type: Microsoft.Office.Tools.Word.Controls.ProgressBar
The ProgressBar control that was added to the ControlCollection instance.

Exceptions

Exception Condition
ArgumentNullException

The name argument is nulla null reference (Nothing in Visual Basic) or has zero length.

ControlNameAlreadyExistsException

A control with the same name is already in the ControlCollection instance.

Remarks

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

To remove a ProgressBar that was added programmatically, use the Remove method.

Examples

The following code example adds a ProgressBar control to the start of the document, and then increases the current position of the ProgressBar to 50.

    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 Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddProgressBar Overload

Microsoft.Office.Tools.Word Namespace