ControlExtensions.AddProgressBar Method (ControlCollection, Range, String)

Adds a new ProgressBar control to the worksheet at the range specified.

Namespace:  Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel.v4.0.Utilities (in Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function AddProgressBar ( _
    controls As ControlCollection, _
    range As Range, _
    name As String _
) As ProgressBar
public static ProgressBar AddProgressBar(
    this ControlCollection controls,
    Range range,
    string name
)

Parameters

Return Value

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

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ControlCollection. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

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. Multi-area ranges cannot be used. The range should be on the same worksheet as the ControlCollection instance.

Remarks

The AddProgressBar method enables you to add ProgressBar objects to the end of the ControlCollection. To remove a ProgressBar that was previously added programmatically, use the Remove method.

The control automatically resizes when the range is resized.

Examples

The following code example adds a ProgressBar control to cells A1 through B1, and then increases the current position of the control to 50. To use this example, run it from the Sheet1 class in a document-level project.

Private Sub ExcelRangeAddProgressBar()

        Dim ProgressBar1 As Microsoft.Office.Tools. _
            Excel.Controls.ProgressBar = Me.Controls. _
            AddProgressBar(Me.Range("A1", "B1"), _
            "ProgressBar1")

        ProgressBar1.Maximum = 100
        ProgressBar1.Step = 50
        ProgressBar1.PerformStep()

    End Sub
private void ExcelRangeAddProgressBar()
{

    Microsoft.Office.Tools.Excel.Controls.ProgressBar
         progressBar1 = this.Controls.AddProgressBar(
         this.Range["A1", "B1"], "progressBar1");
    progressBar1.Maximum = 100;
    progressBar1.Step = 50;
    progressBar1.PerformStep();
}

.NET Framework Security

See Also

Reference

ControlExtensions Class

AddProgressBar Overload

Microsoft.Office.Tools.Excel Namespace