Class IgbCalendar

Represents a calendar that lets users to select a date value in a variety of different ways.

Inheritance
System.Object
BaseRendererControl
IgbCalendarBase
IgbCalendar
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbCalendar : IgbCalendarBase, RefSink, JsonSerializable, IDisposable

Constructors

IgbCalendar()

Declaration
public IgbCalendar()

Properties

ActiveDate

Sets the date which is shown in view and is highlighted. By default it is the current date.

Declaration
public DateTime ActiveDate { get; set; }
Property Value
Type Description
System.DateTime

ActiveView

The current active view of the component. @default "days"

Declaration
public CalendarActiveView ActiveView { get; set; }
Property Value
Type Description
CalendarActiveView

Change

Declaration
public EventCallback<IgbComponentDataValueChangedEventArgs> Change { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbComponentDataValueChangedEventArgs>

ChangeScript

Declaration
public string ChangeScript { get; set; }
Property Value
Type Description
System.String

FormatOptions

The options used to format the months and the weekdays in the calendar views.

Declaration
public IgbCalendarFormatOptions FormatOptions { get; set; }
Property Value
Type Description
IgbCalendarFormatOptions

HeaderOrientation

The orientation of the calendar header. @default "horizontal"

Declaration
public CalendarHeaderOrientation HeaderOrientation { get; set; }
Property Value
Type Description
CalendarHeaderOrientation

HideHeader

Whether to render the calendar header part. When the calendar selection is set to multiple the header is always hidden. @default false

Declaration
public bool HideHeader { get; set; }
Property Value
Type Description
System.Boolean

HideOutsideDays

Whether to show the dates that do not belong to the current active month. @default false

Declaration
public bool HideOutsideDays { get; set; }
Property Value
Type Description
System.Boolean

Orientation

The orientation of the calendar months when more than one month is being shown. @default "horizontal"

Declaration
public ContentOrientation Orientation { get; set; }
Property Value
Type Description
ContentOrientation

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

Value

Declaration
public DateTime Value { get; set; }
Property Value
Type Description
System.DateTime

ValueChanged

Declaration
public EventCallback<DateTime> ValueChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.DateTime>

Values

Declaration
public DateTime[] Values { get; set; }
Property Value
Type Description
System.DateTime[]

ValuesChanged

Declaration
public EventCallback<DateTime[]> ValuesChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.DateTime[]>

VisibleMonths

The number of months displayed in the days view. @default 1

Declaration
public double VisibleMonths { get; set; }
Property Value
Type Description
System.Double

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

GetCurrentValue()

Declaration
public DateTime GetCurrentValue()
Returns
Type Description
System.DateTime

GetCurrentValueAsync()

Declaration
public Task<DateTime> GetCurrentValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.DateTime>

GetCurrentValues()

Declaration
public DateTime[] GetCurrentValues()
Returns
Type Description
System.DateTime[]

GetCurrentValuesAsync()

Declaration
public Task<DateTime[]> GetCurrentValuesAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.DateTime[]>

ResolveDisplay()

Declaration
protected override string ResolveDisplay()
Returns
Type Description
System.String
Overrides

SetCustomizedStringAsync(String, Dictionary<String, String>)

Provide a new set of localized strings to use for a given languange.

Declaration
public Task<object> SetCustomizedStringAsync(string language, Dictionary<string, string> values)
Parameters
Type Name Description
System.String language

The browser language the strings will be used with. I.e. "ja", "en", "fr", etc.
System.Collections.Generic.Dictionary<System.String, System.String> values

The new string value.
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

SetCustomizedStringAsync(String, String)

Provide a new set of localized strings to use for a given languange.

Declaration
public Task<object> SetCustomizedStringAsync(string language, string json)
Parameters
Type Name Description
System.String language

The browser language the strings will be used with. I.e. "ja", "en", "fr", etc.
System.String json

The new string values in json format.
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

SetCustomizedStringAsync(String, String, String)

Provide a new set of localized strings to use for a given languange.

Declaration
public Task<object> SetCustomizedStringAsync(string language, string id, string value)
Parameters
Type Name Description
System.String language

The browser language the strings will be used with. I.e. "ja", "en", "fr", etc.
System.String id

The id of the string to set.
System.String value

The new string value.
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

Implements

System.IDisposable