Scheduler for WinForms | ComponentOne
C1.Win.C1Schedule.4.5.2 Assembly / C1.C1Schedule Namespace / RecurrencePattern Class / GetDescription Method / GetDescription(CalendarInfo) Method
The CalendarInfo object used for getting calendar specific strings.

In This Topic
    GetDescription(CalendarInfo) Method
    In This Topic
    Gets the human-readable description of the RecurrencePattern object according to the specified CalendarInfo object. Use this method instead of Description property if the RecurrencePattern object does not belong to any C1.C1Schedule control.
    Syntax
    'Declaration
     
    Public Overloads Function GetDescription( _
       ByVal calendarInfo As CalendarInfo _
    ) As System.String
    public System.string GetDescription( 
       CalendarInfo calendarInfo
    )

    Parameters

    calendarInfo
    The CalendarInfo object used for getting calendar specific strings.

    Return Value

    The System.String value described the RecurrencePattern object.
    Remarks
    If the RecurrencePattern object does not belong to the C1.C1Schedule control, its Description property will return the default description using current user culture and calendar settings.
    See Also