ControlExtensions.AddProgressBar Method

Definition

Namespace:

Microsoft.Office.Tools.Word

Assembly:

Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Overloads

AddProgressBar(ControlCollection, Range, Single, Single, String)	Adds a new ProgressBar control to the document in the specified size and location.
AddProgressBar(ControlCollection, Single, Single, Single, Single, String)	Adds a new ProgressBar control to the document in the specified size and location.

AddProgressBar(ControlCollection, Range, Single, Single, String)

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

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Office::Tools::Word::Controls::ProgressBar ^ AddProgressBar(Microsoft::Office::Tools::Word::ControlCollection ^ controls, Microsoft::Office::Interop::Word::Range ^ range, float width, float height, System::String ^ name);

public static Microsoft.Office.Tools.Word.Controls.ProgressBar AddProgressBar (this Microsoft.Office.Tools.Word.ControlCollection controls, Microsoft.Office.Interop.Word.Range range, float width, float height, string name);

static member AddProgressBar : Microsoft.Office.Tools.Word.ControlCollection * Microsoft.Office.Interop.Word.Range * single * single * string -> Microsoft.Office.Tools.Word.Controls.ProgressBar

<Extension()>
Public Function AddProgressBar (controls As ControlCollection, range As Range, width As Single, height As Single, name As String) As ProgressBar

Parameters

controls

ControlCollection

The collection to add the control to. Do not supply this parameter yourself. When you call this method on the collection returned by the Controls property (in an application-level project) or the Controls property (in a document-level project), this parameter is supplied automatically.

range

Range

The location of the control.

width

Single

The width of the control in points.

height

Single

The height of the control in points.

name

String

The name that can be used to index the control in the ControlCollection instance.

Returns

ProgressBar

The control that was added to the document.

Exceptions

ArgumentNullException

The name or range argument is null, 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.

Examples

The following code example adds a ProgressBar control to the first paragraph in the document, and then increases the current position of the ProgressBar to 50. To use this example, run it from the ThisDocument class in a document-level project.

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

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

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.

AddProgressBar(ControlCollection, Single, Single, Single, Single, String)

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

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Office::Tools::Word::Controls::ProgressBar ^ AddProgressBar(Microsoft::Office::Tools::Word::ControlCollection ^ controls, float left, float top, float width, float height, System::String ^ name);

public static Microsoft.Office.Tools.Word.Controls.ProgressBar AddProgressBar (this Microsoft.Office.Tools.Word.ControlCollection controls, float left, float top, float width, float height, string name);

static member AddProgressBar : Microsoft.Office.Tools.Word.ControlCollection * single * single * single * single * string -> Microsoft.Office.Tools.Word.Controls.ProgressBar

<Extension()>
Public Function AddProgressBar (controls As ControlCollection, left As Single, top As Single, width As Single, height As Single, name As String) As ProgressBar

Parameters

controls

ControlCollection

The collection to add the control to. Do not supply this parameter yourself. When you call this method on the collection returned by the Controls property (in an application-level project) or the Controls property (in a document-level project), this parameter is supplied automatically.

left

Single

The distance in points between the left edge of the control and the left edge of the document.

top

Single

The distance in points between the top edge of the control and the top edge of the document.

width

Single

The width of the control in points.

height

Single

The height of the control in points.

name

String

The name that can be used to index the control in the ControlCollection instance.

Returns

ProgressBar

The control that was added to the document.

Exceptions

ArgumentNullException

The name argument is null or has zero length.

ControlNameAlreadyExistsException

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

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

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

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 

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.