GetDescription(CalendarInfo) Method

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

Visual Basic
C#

'Declaration
 
Public Overloads Function GetDescription( _
   ByVal calendarInfo As CalendarInfo _
) As String

'Usage
 
Dim instance As RecurrencePattern
Dim calendarInfo As CalendarInfo
Dim value As String
 
value = instance.GetDescription(calendarInfo)

public 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.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

RecurrencePattern Class
RecurrencePattern Members
Overload List