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

Article
07/25/2011

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

public static MaskedTextBox AddMaskedTextBox(
    this ControlCollection controls,
    float left,
    float top,
    float width,
    float height,
    string name
)

Parameters

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

left
Type: System.Single
The distance in points between the left edge of the control and the left edge of the document.

top
Type: System.Single
The distance in points between the top edge of the control and the top edge of the document.

width
Type: System.Single
The width of the control in points.

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

name
Type: System.String
The name that can be used to index the control in the ControlCollection instance.

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 start of 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 WordAddMaskedTextBox()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim MaskedTextBox1 As Microsoft.Office.Tools.Word. _
        Controls.MaskedTextBox = Me.Controls.AddMaskedTextBox( _
        0, 0, 75, 15, "MaskedTextBox1")
    MaskedTextBox1.Mask = "00/00/0000"
End Sub

private void WordAddMaskedTextBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.MaskedTextBox
         maskedTextBox1 = this.Controls.AddMaskedTextBox(
         0, 0, 75, 15, "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