ControlExtensions Class

  • Article

Provides extension methods you can use to add Windows Forms controls to a Word document that has been customized by using the Office development tools in Visual Studio.

Inheritance Hierarchy

System.Object
  Microsoft.Office.Tools.Word.ControlExtensions

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 NotInheritable Class ControlExtensions

public static class ControlExtensions

Methods

  Name Description
Public methodStatic member AddButton(ControlCollection, Range, Single, Single, String) Adds a new Button control to the document in the specified size and location.
Public methodStatic member AddButton(ControlCollection, Single, Single, Single, Single, String) Adds a new Button control to the document in the specified size and location.
Public methodStatic member AddCheckBox(ControlCollection, Range, Single, Single, String) Adds a new CheckBox control to the document in the specified size and location.
Public methodStatic member AddCheckBox(ControlCollection, Single, Single, Single, Single, String) Adds a new CheckBox control to the document in the specified size and location.
Public methodStatic member AddCheckedListBox(ControlCollection, Range, Single, Single, String) Adds a new CheckedListBox control to the document in the specified size and location.
Public methodStatic member AddCheckedListBox(ControlCollection, Single, Single, Single, Single, String) Adds a new CheckedListBox control to the document in the specified size and location.
Public methodStatic member AddComboBox(ControlCollection, Range, Single, Single, String) Adds a new ComboBox control to the document in the specified size and location.
Public methodStatic member AddComboBox(ControlCollection, Single, Single, Single, Single, String) Adds a new ComboBox control to the document in the specified size and location.
Public methodStatic member AddDataGridView(ControlCollection, Range, Single, Single, String) Adds a new DataGridView control to the document in the specified size and location.
Public methodStatic member AddDataGridView(ControlCollection, Single, Single, Single, Single, String) Adds a new DataGridView control to the document in the specified size and location.
Public methodStatic member AddDateTimePicker(ControlCollection, Range, Single, Single, String) Adds a new DateTimePicker control to the document in the specified size and location.
Public methodStatic member AddDateTimePicker(ControlCollection, Single, Single, Single, Single, String) Adds a new DateTimePicker control to the document in the specified size and location.
Public methodStatic member AddDomainUpDown(ControlCollection, Range, Single, Single, String) Adds a new DomainUpDown control to the document in the specified size and location.
Public methodStatic member AddDomainUpDown(ControlCollection, Single, Single, Single, Single, String) Adds a new DomainUpDown control to the document in the specified size and location.
Public methodStatic member AddHScrollBar(ControlCollection, Range, Single, Single, String) Adds a new HScrollBar control to the document in the specified size and location.
Public methodStatic member AddHScrollBar(ControlCollection, Single, Single, Single, Single, String) Adds a new HScrollBar control to the document in the specified size and location.
Public methodStatic member AddLabel(ControlCollection, Range, Single, Single, String) Adds a new Label control to the document in the specified size and location.
Public methodStatic member AddLabel(ControlCollection, Single, Single, Single, Single, String) Adds a new Label control to the document in the specified size and location.
Public methodStatic member AddLinkLabel(ControlCollection, Range, Single, Single, String) Adds a new LinkLabel control to the document in the specified size and location.
Public methodStatic member AddLinkLabel(ControlCollection, Single, Single, Single, Single, String) Adds a new LinkLabel control to the document in the specified size and location.
Public methodStatic member AddListBox(ControlCollection, Range, Single, Single, String) Adds a new ListBox control to the document in the specified size and location.
Public methodStatic member AddListBox(ControlCollection, Single, Single, Single, Single, String) Adds a new ListBox control to the document in the specified size and location.
Public methodStatic member AddListView(ControlCollection, Range, Single, Single, String) Adds a new ListView control to the document in the specified size and location.
Public methodStatic member AddListView(ControlCollection, Single, Single, Single, Single, String) Adds a new ListView control to the document in the specified size and location.
Public methodStatic member AddMaskedTextBox(ControlCollection, Range, Single, Single, String) Adds a new MaskedTextBox control to the document in the specified size and location.
Public methodStatic member AddMaskedTextBox(ControlCollection, Single, Single, Single, Single, String) Adds a new MaskedTextBox control to the document in the specified size and location.
Public methodStatic member AddMonthCalendar(ControlCollection, Range, Single, Single, String) Adds a new MonthCalendar control to the document in the specified size and location.
Public methodStatic member AddMonthCalendar(ControlCollection, Single, Single, Single, Single, String) Adds a new MonthCalendar control to the document in the specified size and location.
Public methodStatic member AddNumericUpDown(ControlCollection, Range, Single, Single, String) Adds a new NumericUpDown control to the document in the specified size and location.
Public methodStatic member AddNumericUpDown(ControlCollection, Single, Single, Single, Single, String) Adds a new NumericUpDown control to the document in the specified size and location.
Public methodStatic member AddPictureBox(ControlCollection, Range, Single, Single, String) Adds a new PictureBox control to the document in the specified size and location.
Public methodStatic member AddPictureBox(ControlCollection, Single, Single, Single, Single, String) Adds a new PictureBox control to the document in the specified size and location.
Public methodStatic member AddProgressBar(ControlCollection, Range, Single, Single, String) Adds a new ProgressBar control to the document in the specified size and location.
Public methodStatic member AddProgressBar(ControlCollection, Single, Single, Single, Single, String) Adds a new ProgressBar control to the document in the specified size and location.
Public methodStatic member AddPropertyGrid(ControlCollection, Range, Single, Single, String) Adds a new PropertyGrid control to the document in the specified size and location.
Public methodStatic member AddPropertyGrid(ControlCollection, Single, Single, Single, Single, String) Adds a new PropertyGrid control to the document in the specified size and location.
Public methodStatic member AddRadioButton(ControlCollection, Range, Single, Single, String) Adds a new RadioButton control to the document in the specified size and location.
Public methodStatic member AddRadioButton(ControlCollection, Single, Single, Single, Single, String) Adds a new RadioButton control to the document in the specified size and location.
Public methodStatic member AddRichTextBox(ControlCollection, Range, Single, Single, String) Adds a new RichTextBox control to the document in the specified size and location.
Public methodStatic member AddRichTextBox(ControlCollection, Single, Single, Single, Single, String) Adds a new RichTextBox control to the document in the specified size and location.
Public methodStatic member AddTextBox(ControlCollection, Range, Single, Single, String) Adds a new TextBox control to the document in the specified size and location.
Public methodStatic member AddTextBox(ControlCollection, Single, Single, Single, Single, String) Adds a new TextBox control to the document in the specified size and location.
Public methodStatic member AddTrackBar(ControlCollection, Range, Single, Single, String) Adds a new TrackBar control to the document in the specified size and location.
Public methodStatic member AddTrackBar(ControlCollection, Single, Single, Single, Single, String) Adds a new TrackBar control to the document in the specified size and location.
Public methodStatic member AddTreeView(ControlCollection, Range, Single, Single, String) Adds a new TreeView control to the document in the specified size and location.
Public methodStatic member AddTreeView(ControlCollection, Single, Single, Single, Single, String) Adds a new TreeView control to the document in the specified size and location.
Public methodStatic member AddVScrollBar(ControlCollection, Range, Single, Single, String) Adds a new VScrollBar control to the document in the specified size and location.
Public methodStatic member AddVScrollBar(ControlCollection, Single, Single, Single, Single, String) Adds a new VScrollBar control to the document in the specified size and location.
Public methodStatic member AddWebBrowser(ControlCollection, Range, Single, Single, String) Adds a new WebBrowser control to the document in the specified size and location.
Public methodStatic member AddWebBrowser(ControlCollection, Single, Single, Single, Single, String) Adds a new WebBrowser control to the document in the specified size and location.

Top

Remarks

The ControlExtensions methods are extension methods that are available on the ControlCollection object returned by the Document.Controls property (in an application-level project) or the DocumentBase.Controls property (in a document-level project) at run time. To add a specific control to a document, use the method that includes the name of the control in the method name. For example, to add a Button, use the AddButton method.

For more information about adding controls to a document, see Adding Controls to Office Documents at Run Time. For more information about extension methods, see Extension Methods (C# Programming Guide) and Extension Methods (Visual Basic).

Note

In Word add-in projects that target the .NET Framework 4, you must add a reference to the Microsoft.Office.Tools.Word.v4.0.Utilities.dll assembly before you can access the ControlExtensions methods.

Examples

The following code example uses the AddButton method to add a Button control to the first paragraph in the document, and then adds text to the button. To use this example, run it from the ThisDocument class in a document-level project.

Private Sub WordRangeAddButton()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim Button1 As Microsoft.Office.Tools.Word.Controls.Button _
        = Me.Controls.AddButton(Me.Paragraphs(1).Range, 56.25F, _
        17.25F, "Button1")
    Button1.Text = "OK"
End Sub 

private void WordRangeAddButton()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.Button button1 =
        this.Controls.AddButton(this.Paragraphs[1].Range,
        56.25F, 17.25F, "button1");
    button1.Text = "OK";
}

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Office.Tools.Word Namespace

Other Resources

Adding Controls to Office Documents at Run Time