ControlExtensions.AddProgressBar Method (ControlCollection, Double, Double, Double, Double, String)

Article
01/07/2014

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

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, _
    left As Double, _
    top As Double, _
    width As Double, _
    height As Double, _
    name As String _
) As ProgressBar

public static ProgressBar AddProgressBar(
    this ControlCollection controls,
    double left,
    double top,
    double width,
    double height,
    string name
)

Parameters

controls
Type: Microsoft.Office.Tools.Excel.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 Worksheet.Controls property (in an application-level project) or the WorksheetBase.Controls property (in a document-level project), this parameter is supplied automatically.

left
Type: System.Double

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

top
Type: System.Double

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

width
Type: System.Double

The width of the control in points.

height
Type: System.Double

The height of the control in points.

name
Type: System.String

The name of the control.

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

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

Examples

The following code example adds a ProgressBar control to the top of the worksheet, 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 ExcelAddProgressBar()

        Dim ProgressBar1 As Microsoft.Office.Tools.Excel. _
            Controls.ProgressBar = Me.Controls. _
            AddProgressBar(0, 0, 75, 17.25, "ProgressBar1")

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

    End Sub

private void ExcelAddProgressBar()
{

    Microsoft.Office.Tools.Excel.Controls.ProgressBar
         progressBar1 = this.Controls.AddProgressBar(
         0, 0, 75, 17.25, "progressBar1");
    progressBar1.Maximum = 100;
    progressBar1.Step = 50;
    progressBar1.PerformStep();
}

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via