Share via


ControlCollection.AddMonthCalendar Method (, String) (2007 System)

Adds a new MonthCalendar control to the worksheet at the range specified.

Namespace:  Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel.v9.0 (in Microsoft.Office.Tools.Excel.v9.0.dll)

Syntax

'Declaration
Public Function AddMonthCalendar ( _
    range As Range, _
    name As String _
) As MonthCalendar
'Usage
Dim instance As ControlCollection 
Dim range As Range 
Dim name As String 
Dim returnValue As MonthCalendar 

returnValue = instance.AddMonthCalendar(range, _
    name)
public MonthCalendar AddMonthCalendar(
    Range range,
    string name
)
public:
MonthCalendar^ AddMonthCalendar(
    Range^ range, 
    String^ name
)
public function AddMonthCalendar(
    range : Range, 
    name : String
) : MonthCalendar

Parameters

  • range
    Type: Range

    A Range that provides the bounds for the control.

Return Value

Type: Microsoft.Office.Tools.Excel.Controls.MonthCalendar
The MonthCalendar control that was added to the ControlCollection instance.

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.

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

ControlCollection Class

ControlCollection Members

AddMonthCalendar Overload

Microsoft.Office.Tools.Excel Namespace