Represents a calendar that lets users to select a date value in a variety of different ways.
Inheritance
object
ComponentBase
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbCalendar()Returns IgbCalendar
Properties
Section titled "Properties"DefaultEventBehavior
Section titled "DefaultEventBehavior"Inherited from: IgbCalendarBase
Gets the components default event behavior.
protected override ControlEventBehavior DefaultEventBehavior { get; }Selection
Section titled "Selection"Inherited from: IgbCalendarBase
Sets the type of selection in the component. single
[Parameter]
public CalendarSelection Selection { get; set; }ShowWeekNumbers
Section titled "ShowWeekNumbers"Inherited from: IgbCalendarBase
Whether to show the week numbers. false
[Parameter]
public bool ShowWeekNumbers { get; set; }WeekStart
Section titled "WeekStart"Inherited from: IgbCalendarBase
Gets/Sets the first day of the week. sunday
[Parameter]
public WeekDays WeekStart { get; set; }Locale
Section titled "Locale"Inherited from: IgbCalendarBase
Gets/Sets the locale used for formatting and displaying the dates in the component.
[Parameter]
public string Locale { get; set; }ResourceStrings
Section titled "ResourceStrings"Inherited from: IgbCalendarBase
The resource strings for localization.
[Parameter]
public IgbCalendarResourceStrings ResourceStrings { get; set; }SpecialDates
Section titled "SpecialDates"Inherited from: IgbCalendarBase
Gets/Sets the special dates for the component.
[Parameter]
public IgbDateRangeDescriptor[]? SpecialDates { get; set; }DisabledDates
Section titled "DisabledDates"Inherited from: IgbCalendarBase
Gets/Sets the disabled dates for the component.
[Parameter]
public IgbDateRangeDescriptor[]? DisabledDates { get; set; }IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererControl
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }Height
Section titled "Height"Inherited from: BaseRendererControl
[Parameter]
public string Height { get; set; }Width
Section titled "Width"Inherited from: BaseRendererControl
[Parameter]
public string Width { get; set; }Class
Section titled "Class"Inherited from: BaseRendererControl
[Parameter]
public string Class { get; set; }AdditionalAttributes
Section titled "AdditionalAttributes"Inherited from: BaseRendererControl
[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererControl
protected virtual string ParentTypeName { get; }EventBehavior
Section titled "EventBehavior"Inherited from: BaseRendererControl
Gets or sets how events are bubbled up from JavaScript to Blazor.
[Parameter]
public ControlEventBehavior EventBehavior { get; set; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererControl
[Parameter]
public RenderFragment ChildContent { get; set; }RoundTripDateConversion
Section titled "RoundTripDateConversion"Inherited from: BaseRendererControl
Gets or sets what type of date conversion to make when round tripping dates.
[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererControl
protected virtual bool UseDirectRender { get; }DirectRenderElementName
Section titled "DirectRenderElementName"Inherited from: BaseRendererControl
protected virtual string DirectRenderElementName { get; }NeedsDynamicContent
Section titled "NeedsDynamicContent"Inherited from: BaseRendererControl
protected virtual bool NeedsDynamicContent { get; }UseCamelEnumValues
Section titled "UseCamelEnumValues"Inherited from: BaseRendererControl
protected virtual bool UseCamelEnumValues { get; }ActiveDate
Section titled "ActiveDate"Sets the date which is shown in view and is highlighted. By default it is the current date.
[Parameter]
public DateTime ActiveDate { get; set; }ActiveView
Section titled "ActiveView"The current active view of the component. "days"
[Parameter]
public CalendarActiveView ActiveView { get; set; }FormatOptions
Section titled "FormatOptions"The options used to format the months and the weekdays in the calendar views.
[Parameter]
public IgbCalendarFormatOptions FormatOptions { get; set; }HeaderOrientation
Section titled "HeaderOrientation"The orientation of the calendar header. "horizontal"
[Parameter]
public CalendarHeaderOrientation HeaderOrientation { get; set; }HideHeader
Section titled "HideHeader"Whether to render the calendar header part. When the calendar selection is set to multiple the header is always hidden. false
[Parameter]
public bool HideHeader { get; set; }HideOutsideDays
Section titled "HideOutsideDays"Whether to show the dates that do not belong to the current active month. false
[Parameter]
public bool HideOutsideDays { get; set; }Orientation
Section titled "Orientation"The orientation of the calendar months when more than one month is being shown. "horizontal"
[Parameter]
public ContentOrientation Orientation { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"protected override bool SupportsVisualChildren { get; }public override string Type { get; }Value
Section titled "Value"[Parameter]
public DateTime Value { get; set; }Values
Section titled "Values"[Parameter]
public DateTime[] Values { get; set; }VisibleMonths
Section titled "VisibleMonths"The number of months displayed in the days view. 1
[Parameter]
public double VisibleMonths { get; set; }Accessors
Section titled "Accessors"eventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererControl
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererControl
protected string _cachedSerializedContentMethods
Section titled "Methods"SetNativeElementAsync(object)
Section titled "SetNativeElementAsync(object)"Inherited from: IgbCalendarBase
public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"Inherited from: IgbCalendarBase
public void SetNativeElement(object element)Parameters
- element:
object
Returns any
ResolveEventBehavior()
Section titled "ResolveEventBehavior()"Inherited from: BaseRendererControl
Resolves the components event behavior if Auto is selected.
protected ControlEventBehavior ResolveEventBehavior()Returns any
ToSpinal(string)
Section titled "ToSpinal(string)"Inherited from: BaseRendererControl
protected string ToSpinal(string value)Parameters
- value:
string
Returns any
TransformSimpleKey(string)
Section titled "TransformSimpleKey(string)"Inherited from: BaseRendererControl
protected virtual string TransformSimpleKey(string key)Parameters
- key:
string
Returns any
IsTransformedEnumValue(string)
Section titled "IsTransformedEnumValue(string)"Inherited from: BaseRendererControl
protected virtual bool IsTransformedEnumValue(string key)Parameters
- key:
string
Returns any
TransformPotentialEnumValue(string, object)
Section titled "TransformPotentialEnumValue(string, object)"Inherited from: BaseRendererControl
protected virtual object TransformPotentialEnumValue(string key, object value)Parameters
- key:
string - value:
object
Returns any
BuildSequenceInfo(int)
Section titled "BuildSequenceInfo(int)"Inherited from: BaseRendererControl
protected virtual SequenceInfo BuildSequenceInfo(int startSequence)Parameters
- startSequence:
int
Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererControl
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
TemplateContentType(string)
Section titled "TemplateContentType(string)"Inherited from: BaseRendererControl
protected Type TemplateContentType(string templateId)Parameters
- templateId:
string
Returns any
OnAfterRenderAsync(bool)
Section titled "OnAfterRenderAsync(bool)"Inherited from: BaseRendererControl
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
- firstRender:
bool
Returns any
EnsureReady()
Section titled "EnsureReady()"Inherited from: BaseRendererControl
public Task EnsureReady()Returns any
MarkPropDirty(string)
Section titled "MarkPropDirty(string)"Inherited from: BaseRendererControl
protected void MarkPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererControl
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererControl
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererControl
public string Serialize()Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
SuspendNotifications(object)
Section titled "SuspendNotifications(object)"Inherited from: BaseRendererControl
Prevents data change notifications from be propagated to the component.
public void SuspendNotifications(object dataSource)Parameters
- dataSource:
object
Returns any
ResumeNotifications(object, bool)
Section titled "ResumeNotifications(object, bool)"Inherited from: BaseRendererControl
Resumes data change notifications.
public void ResumeNotifications(object dataSource, bool notify = true)Parameters
- dataSource:
object - notify:
bool
Returns any
NotifyInsertItem(object, int, object)
Section titled "NotifyInsertItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyInsertItem(object dataSource, int index, object refItem)Parameters
- dataSource:
object - index:
int - refItem:
object
Returns any
NotifyRemoveItem(object, int, object)
Section titled "NotifyRemoveItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyRemoveItem(object dataSource, int index, object oldItem)Parameters
- dataSource:
object - index:
int - oldItem:
object
Returns any
NotifyClearItems(object)
Section titled "NotifyClearItems(object)"Inherited from: BaseRendererControl
public void NotifyClearItems(object dataSource)Parameters
- dataSource:
object
Returns any
NotifySetItem(object, int, object, object)
Section titled "NotifySetItem(object, int, object, object)"Inherited from: BaseRendererControl
public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)Parameters
- dataSource:
object - index:
int - oldItem:
object - newItem:
object
Returns any
NotifyUpdateItem(object, int, object, bool)
Section titled "NotifyUpdateItem(object, int, object, bool)"Inherited from: BaseRendererControl
public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)Parameters
- dataSource:
object - index:
int - refItem:
object - syncDataOnly:
bool
Returns any
OnRefChanged(string, object)
Section titled "OnRefChanged(string, object)"Inherited from: BaseRendererControl
public void OnRefChanged(string refName, object refValue)Parameters
- refName:
string - refValue:
object
Returns any
OnInvokeReturn(long, object)
Section titled "OnInvokeReturn(long, object)"Inherited from: BaseRendererControl
public void OnInvokeReturn(long invokeId, object returnValue)Parameters
- invokeId:
long - returnValue:
object
Returns any
Camelize(string)
Section titled "Camelize(string)"Inherited from: BaseRendererControl
protected string Camelize(string value)Parameters
- value:
string
Returns any
ToPascal(string)
Section titled "ToPascal(string)"Inherited from: BaseRendererControl
protected string ToPascal(string value)Parameters
- value:
string
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererControl
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
Dispose(bool)
Section titled "Dispose(bool)"Inherited from: BaseRendererControl
protected virtual void Dispose(bool disposing)Parameters
- disposing:
bool
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
SetPropertyValue(object, PropertyInfo, JsonElement)
Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)Parameters
- item:
object - property:
PropertyInfo - jsonElement:
JsonElement
Returns any
SetPropertyValue(object, PropertyInfo, object)
Section titled "SetPropertyValue(object, PropertyInfo, object)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, object value)Parameters
- item:
object - property:
PropertyInfo - value:
object
Returns any
Dispose()
Section titled "Dispose()"Inherited from: BaseRendererControl
public void Dispose()Returns any
EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"protected override void EnsureModulesLoaded()Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
GetCurrentValue()
Section titled "GetCurrentValue()"public DateTime GetCurrentValue()Returns any
GetCurrentValueAsync()
Section titled "GetCurrentValueAsync()"public Task<DateTime> GetCurrentValueAsync()Returns any
GetCurrentValues()
Section titled "GetCurrentValues()"public DateTime[] GetCurrentValues()Returns any
GetCurrentValuesAsync()
Section titled "GetCurrentValuesAsync()"public Task<DateTime[]> GetCurrentValuesAsync()Returns any
ResolveDisplay()
Section titled "ResolveDisplay()"protected override string ResolveDisplay()Returns any
SetCustomizedStringAsync(string, Dictionary<string, string>)
Section titled "SetCustomizedStringAsync(string, Dictionary<string, string>)"Provide a new set of localized strings to use for a given languange.
public Task<object> SetCustomizedStringAsync(string language, Dictionary<string, string> values)Parameters
- language:
string - values:
Dictionary
Returns any
SetCustomizedStringAsync(string, string)
Section titled "SetCustomizedStringAsync(string, string)"Provide a new set of localized strings to use for a given languange.
public Task<object> SetCustomizedStringAsync(string language, string json)Parameters
- language:
string - json:
string
Returns any
SetCustomizedStringAsync(string, string, string)
Section titled "SetCustomizedStringAsync(string, string, string)"Provide a new set of localized strings to use for a given languange.
public Task<object> SetCustomizedStringAsync(string language, string id, string value)Parameters
- language:
string - id:
string - value:
string
Returns any
Events
Section titled "Events"Change
Section titled "Change"[Parameter]
public EventCallback<IgbComponentDataValueChangedEventArgs> Change { get; set; }ValueChanged
Section titled "ValueChanged"[Parameter]
public EventCallback<DateTime> ValueChanged { get; set; }ValuesChanged
Section titled "ValuesChanged"[Parameter]
public EventCallback<DateTime[]> ValuesChanged { get; set; }ChangeScript
Section titled "ChangeScript"[Parameter]
public string ChangeScript { get; set; }