Class IgbCalendar
Represents a calendar that lets users
to select a date value in a variety of different ways.
when calendar orientation is vertical.
Inheritance
System.Object
IgbCalendar
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbCalendar : IgbCalendarBase, RefSink, JsonSerializable, IDisposable
Constructors
IgbCalendar()
Declaration
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
Declaration
public CalendarActiveView ActiveView { get; set; }
Property Value
Change
Declaration
public EventCallback<IgbComponentDataValueChangedEventArgs> Change { get; set; }
Property Value
ChangeScript
Declaration
public string ChangeScript { get; set; }
Property Value
Type |
Description |
System.String |
|
DirectRenderElementName
Declaration
protected override string DirectRenderElementName { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
The options used to format the months and the weekdays in the calendar views.
Declaration
public IgbCalendarFormatOptions FormatOptions { get; set; }
Property Value
The orientation of the header.
Declaration
public CalendarHeaderOrientation HeaderOrientation { get; set; }
Property Value
Determines whether the calendar hides its header. Even if set to false, the header is not displayed for multiple
selection.
Declaration
public bool HideHeader { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
HideOutsideDays
Controls the visibility of the dates that do not belong to the current month.
Declaration
public bool HideOutsideDays { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Orientation
The orientation of the multiple months displayed in days view.
Declaration
public CalendarOrientation Orientation { get; set; }
Property Value
ResourceStrings
Declaration
public IgbCalendarResourceStrings ResourceStrings { get; set; }
Property Value
Size
Declaration
public SizableComponentSize Size { get; set; }
Property Value
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
UseDirectRender
Declaration
protected override bool UseDirectRender { get; }
Property Value
Type |
Description |
System.Boolean |
|
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 days view.
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