Share via


ControlExtensions.AddMonthCalendar Method (ControlCollection, Range, String)

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

Parameters

Return Value

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

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. Multi-area ranges cannot be used. The range should be on the same worksheet as the ControlCollection instance.

Remarks

The AddMonthCalendar method enables you to add MonthCalendar objects to the end of the ControlCollection. To remove a MonthCalendar control that was previously added programmatically, use the Remove method. The control automatically resizes when the range is resized.

Examples

The following code example adds a MonthCalendar control to cells A1 through C10, and then sets the FirstDayOfWeek property to Monday. To use this example, run it from the Sheet1 class in a document-level project.

Private Sub ExcelRangeAddMonthCalendar()

    Dim MonthCalendar1 As Microsoft.Office.Tools. _
        Excel.Controls.MonthCalendar = Me.Controls. _
        AddMonthCalendar(Me.Range("A1", "C10"), _
        "MonthCalendar1")

    MonthCalendar1.FirstDayOfWeek = System.Windows. _
        Forms.Day.Monday

End Sub
private void ExcelRangeAddMonthCalendar()
{

    Microsoft.Office.Tools.Excel.Controls.MonthCalendar
         monthCalendar1 = this.Controls.AddMonthCalendar(
         this.Range["A1", "C10"], "monthCalendar1");
    monthCalendar1.FirstDayOfWeek = System.Windows.Forms.Day.Monday;
}

.NET Framework Security

See Also

Reference

ControlExtensions Class

AddMonthCalendar Overload

Microsoft.Office.Tools.Excel Namespace