Share via


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

Adds a new MonthCalendar 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 AddMonthCalendar ( _
    controls As ControlCollection, _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As MonthCalendar
public static MonthCalendar AddMonthCalendar(
    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.MonthCalendar
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).

Exceptions

Exception Condition
ArgumentNullException

The name or range argument is nulla null reference (Nothing in Visual Basic), or the name argument has zero length.

ControlNameAlreadyExistsException

A control with the same name is already in the ControlCollection instance.

InvalidRangeException

The range that was specified is not valid.

Remarks

This method enables you to add MonthCalendar objects to the end of the ControlCollection.

To remove a MonthCalendar control that was added programmatically, use the Remove method.

Examples

The following code example adds a MonthCalendar control to the first paragraph in the document, and then sets the FirstDayOfWeek property to Monday. To use this example, run it from the ThisDocument class in a document-level project.

Private Sub WordRangeAddMonthCalendar()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim MonthCalendar1 As Microsoft.Office.Tools.Word. _
        Controls.MonthCalendar = Me.Controls.AddMonthCalendar( _
        Me.Paragraphs(1).Range, 75, 15, "MonthCalendar1")
    MonthCalendar1.FirstDayOfWeek = System.Windows.Forms.Day.Monday
End Sub
private void WordRangeAddMonthCalendar()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.MonthCalendar
         monthCalendar1 = this.Controls.AddMonthCalendar(
         this.Paragraphs[1].Range, 75, 15, "monthCalendar1");
    monthCalendar1.FirstDayOfWeek = System.Windows.Forms.Day.Monday;
}

.NET Framework Security

See Also

Reference

ControlExtensions Class

AddMonthCalendar Overload

Microsoft.Office.Tools.Word Namespace