ControlExtensions.AddMaskedTextBox Method (ControlCollection, Range, String)

Article
06/14/2013

Adds a new MaskedTextBox 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 AddMaskedTextBox ( _
    controls As ControlCollection, _
    range As Range, _
    name As String _
) As MaskedTextBox

public static MaskedTextBox AddMaskedTextBox(
    this ControlCollection controls,
    Range range,
    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.

range
Type: Range

A Range that provides the location for the control.

name
Type: System.String

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

Return Value

Type: Microsoft.Office.Tools.Excel.Controls.MaskedTextBox
The MaskedTextBox 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).

Remarks

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

Examples

The following code example adds a MaskedTextBox control to cell A1, and then sets the Mask property to 00/00/0000. To use this example, run it from the Sheet1 class in a document-level project.

Private Sub ExcelRangeAddMaskedTextBox()

        Dim MaskedTextBox1 As Microsoft.Office.Tools. _
            Excel.Controls.MaskedTextBox = Me.Controls. _
            AddMaskedTextBox(Me.Range("A1"), "MaskedTextBox1")

        MaskedTextBox1.Mask = "00/00/0000" 

    End Sub

private void ExcelRangeAddMaskedTextBox()
{

    Microsoft.Office.Tools.Excel.Controls.MaskedTextBox
         maskedTextBox1 = this.Controls.AddMaskedTextBox(
        this.Range["A1"], "maskedTextBox1");
    maskedTextBox1.Mask = "00/00/0000";
}

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

Share via