Class Calendar

Definition

Namespace:

ElmSharp

Assembly:

ElmSharp.dll

API Level:

preview

The Calendar is a widget that helps applications to flexibly display a calender with day of the week, date, year, and month.

public class Calendar : Layout, IAccessibleObject

Inheritance

Object

EvasObject

AccessibleObject

Widget

Container

Layout

Calendar

Implements

IAccessibleObject

Constructors

Calendar(EvasObject)

Creates and initializes a new instance of the Calendar class.

Declaration

public Calendar(EvasObject parent)

Parameters

Type	Name	Description
EvasObject	parent	The EvasObject to which the new calendar will be attached as a child.

API Level: preview

Properties

DateFormat

Gets or sets the date format of the string that will be used to display month and year.

Declaration

public Calendar.DateFormatDelegate DateFormat { get; set; }

Property Value

Type	Description
Calendar.DateFormatDelegate

API Level: preview

DisplayedTime

Sets or gets the first day of the week, which is used on the calendar.

Declaration

public DateTime DisplayedTime { get; }

Property Value

Type	Description
DateTime

API Level: preview

FirstDayOfWeek

Sets or gets the first day of the week, which is used on the calendar.

Declaration

public DayOfWeek FirstDayOfWeek { get; set; }

Property Value

Type	Description
DayOfWeek

API Level: preview

Interval

Sets or gets the interval on time updates for a user mouse button hold, on the calendar widgets' month/year selection.

Declaration

public double Interval { get; set; }

Property Value

Type	Description
Double

API Level: preview

MaximumYear

Sets or gets the maximum for the year.

Declaration

public int MaximumYear { get; set; }

Property Value

Type	Description
Int32

API Level: preview

MinimumYear

Sets or gets the minimum for year.

Declaration

public int MinimumYear { get; set; }

Property Value

Type	Description
Int32

API Level: preview

Selectable

Gets or sets the fields of a datetime that will be taken into account, when SelectedDate set is invoked.

Declaration

public CalendarSelectable Selectable { get; set; }

Property Value

Type	Description
CalendarSelectable

API Level: preview

SelectedDate

Sets or gets the selected date.

Declaration

public DateTime SelectedDate { get; set; }

Property Value

Type	Description
DateTime

Remarks

The selected date changes when the user goes to the next/previous month or selects a day pressing over it on the calendar.

API Level: preview

SelectMode

Gets or sets the select day mode used.

Declaration

public CalendarSelectMode SelectMode { get; set; }

Property Value

Type	Description
CalendarSelectMode

API Level: preview

WeekDayNames

Sets or gets the weekdays name to be displayed by the calendar.

Declaration

public IReadOnlyList<string> WeekDayNames { get; set; }

Property Value

Type	Description
IReadOnlyList<String>

Remarks

The usage should be like this: List<string> weekDayNames = new List<string>() { "S", "M", "T", "W", "T", "F", "S" }; Calendar.WeekDayNames = weekDayNames;

API Level: preview

Methods

AddMark(String, DateTime, CalendarMarkRepeatType)

Adds a new mark to the calendar.

Declaration

public CalendarMark AddMark(string type, DateTime date, CalendarMarkRepeatType repeat)

Parameters

Type	Name	Description
String	type	A string used to define the type of mark. It will be emitted to the theme that should display a related modification on these day's representation.
DateTime	date	A time struct to represent the date of inclusion of the mark. For marks that repeat, it will just be displayed after the inclusion date in the calendar.
CalendarMarkRepeatType	repeat	Repeat the event following this periodicity. Can be a unique mark (that doesn't repeat), daily, weekly, monthly, or annually.

Returns

Type	Description
CalendarMark	Item for a calendar mark.

API Level: preview

ClearMarks()

Removes all the calendar's marks.

Declaration

public void ClearMarks()

API Level: preview

CreateHandle(EvasObject)

Creates a widget handle.

Declaration

protected override IntPtr CreateHandle(EvasObject parent)

Parameters

Type	Name	Description
EvasObject	parent	Parent EvasObject.

Returns

Type	Description
IntPtr	Handle IntPtr.

Overrides

Layout.CreateHandle(EvasObject)

API Level: preview

DeleteMark(CalendarMark)

Deletes a mark from the calendar.

Declaration

public void DeleteMark(CalendarMark mark)

Parameters

Type	Name	Description
CalendarMark	mark	Item for a calendar mark.

API Level: preview

DrawMarks()

Draws the calendar marks.

Declaration

public void DrawMarks()

API Level: preview

Events

DateChanged

DateChanged will be triggered when the date in the calendar is changed.

Declaration

public event EventHandler<DateChangedEventArgs> DateChanged

Event Type

Type	Description
EventHandler<DateChangedEventArgs>

API Level: preview

DisplayedMonthChanged

DisplayedMonthChanged will be triggered when the current month displayed in the calendar is changed.

Declaration

public event EventHandler<DisplayedMonthChangedEventArgs> DisplayedMonthChanged

Event Type

Type	Description
EventHandler<DisplayedMonthChangedEventArgs>

API Level: preview

Implements

IAccessibleObject

Extension Methods

RotaryEventExtensions.AddRotaryEventHandler(EvasObject, RotaryEventHandler)

RotaryEventExtensions.RemoveRotaryEventHandler(EvasObject, RotaryEventHandler)

RotaryEventExtensions.Activate(EvasObject)

RotaryEventExtensions.Deactivate(EvasObject)