Share via


ControlExtensions.AddMaskedTextBox Method (ControlCollection, Range, Single, Single, String)

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

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function AddMaskedTextBox ( _
    controls As ControlCollection, _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As MaskedTextBox
public static MaskedTextBox AddMaskedTextBox(
    this ControlCollection controls,
    Range range,
    float width,
    float height,
    string name
)

Parameters

  • height
    Type: System.Single
    The height of the control in points.

Return Value

Type: Microsoft.Office.Tools.Word.Controls.MaskedTextBox
The control that was added to the document.

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 added programmatically, use the Remove method.

Examples

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

Private Sub WordRangeAddMaskedTextBox()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim MaskedTextBox1 As Microsoft.Office.Tools.Word. _
        Controls.MaskedTextBox = Me.Controls.AddMaskedTextBox( _
        Me.Paragraphs(1).Range, 75, 15, "MaskedTextBox1")
    MaskedTextBox1.Mask = "00/00/0000"
End Sub 
private void WordRangeAddMaskedTextBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.MaskedTextBox
         maskedTextBox1 = this.Controls.AddMaskedTextBox(
         this.Paragraphs[1].Range, 75, 15, "maskedTextBox1");
    maskedTextBox1.Mask = "00/00/0000";
}

.NET Framework Security

See Also

Reference

ControlExtensions Class

AddMaskedTextBox Overload

Microsoft.Office.Tools.Word Namespace