HtmlForgeX

API Reference

Class

FullCalendar

Namespace HtmlForgeX
Assembly HtmlForgeX
Base Element

Represents a FullCalendar instance used to display events.

Inheritance

Constructors

public FullCalendar() #

Initializes a new instance of the FullCalendar class with a random identifier.

Methods

AddEvent 3 overloads
public FullCalendarEvent AddEvent(String title, String description, DateTime start, Nullable<DateTime> end = null) #
Returns: FullCalendarEvent

Adds a new event to the calendar with a description.

Parameters

title System.String requiredposition: 0
Event title.
description System.String requiredposition: 1
Event description.
start System.DateTime requiredposition: 2
Start date.
end System.Nullable{System.DateTime} = null optionalposition: 3
Optional end date.

Returns

The created event.

public FullCalendarEvent AddEvent(String title, DateTime start) #
Returns: FullCalendarEvent

Adds a new single-day event to the calendar.

Parameters

title System.String requiredposition: 0
Event title.
start System.DateTime requiredposition: 1
Start date.

Returns

The created event.

public FullCalendarEvent AddEvent(FullCalendarEvent eventItem) #
Returns: FullCalendarEvent

Adds an existing event instance to the calendar.

Parameters

eventItem HtmlForgeX.FullCalendarEvent requiredposition: 0
Event instance.

Returns

The added event.

public FullCalendarToolbar AddFooterToolbar() #
Returns: FullCalendarToolbar

Adds and returns a toolbar displayed at the bottom of the calendar.

Returns

The created toolbar.

public FullCalendarToolbar AddHeaderToolbar() #
Returns: FullCalendarToolbar

Adds and returns a toolbar displayed at the top of the calendar.

Returns

The created toolbar.

public FullCalendar BusinessHours(Boolean value) #
Returns: FullCalendar

Sets whether business hours are highlighted.

Parameters

value System.Boolean requiredposition: 0
If set to true, business hours will be shown.

Returns

The current instance.

public FullCalendar ButtonIcons(Boolean value) #
Returns: FullCalendar

Determines if button text should use icons.

Parameters

value System.Boolean requiredposition: 0
If true, icons will be used.

Returns

The current instance.

public FullCalendar DayMaxEventRows(Boolean value) #
Returns: FullCalendar

Sets whether days should display a "more" link when too many events exist.

Parameters

value System.Boolean requiredposition: 0
If true, event rows will be collapsed.

Returns

The current instance.

public FullCalendar Editable(Boolean value) #
Returns: FullCalendar

Enables or disables event editing via drag and drop.

Parameters

value System.Boolean requiredposition: 0
If true, events can be edited.

Returns

The current instance.

public FullCalendar Height(String value) #
Returns: FullCalendar

Sets the rendered height of the calendar.

Parameters

value System.String requiredposition: 0
public FullCalendar InitialDate(DateTime value) #
Returns: FullCalendar

Sets the initial date displayed by the calendar.

Parameters

value System.DateTime requiredposition: 0
Initial date.

Returns

The current instance.

public FullCalendar InitialView(FullCalendarInitialView value) #
Returns: FullCalendar

Sets the initial view displayed when the calendar loads.

Parameters

value HtmlForgeX.FullCalendarInitialView requiredposition: 0
public FullCalendar NowIndicator(Boolean value) #
Returns: FullCalendar

Enables or disables the now indicator.

Parameters

value System.Boolean requiredposition: 0
Whether the indicator should be displayed.

Returns

The current FullCalendar instance.

RegisterLibraries() #

Registers the required libraries for FullCalendar.

public FullCalendar Selectable(Boolean value) #
Returns: FullCalendar

Defines whether dates can be selected.

Parameters

value System.Boolean requiredposition: 0
If true, date selection is allowed.

Returns

The current instance.

public FullCalendar SelectMirror(Boolean value) #
Returns: FullCalendar

Mirrors selection to create an event-like placeholder.

Parameters

value System.Boolean requiredposition: 0
Whether mirror selection is active.

Returns

The current instance.

public FullCalendar Settings(Action<FullCalendarSettings> configure) #
Returns: FullCalendar

Groups less-common options under a single fluent entry point to keep IntelliSense lean.

Parameters

configure System.Action{HtmlForgeX.FullCalendarSettings} requiredposition: 0
public override String ToString() #
Returns: String

Builds the HTML and script necessary to render the calendar.

Returns

The HTML string representation.

public FullCalendar WeekNumberCalculation(String value) #
Returns: FullCalendar

Sets the week number calculation method.

Parameters

value System.String requiredposition: 0
The calculation mode.

Returns

The current instance.

public FullCalendar WeekNumbers(Boolean value) #
Returns: FullCalendar

Shows or hides week numbers.

Parameters

value System.Boolean requiredposition: 0
Whether week numbers are displayed.

Returns

The current instance.

Properties

public String Id { get; set; } #

Gets or sets the identifier of the calendar container.

public List<FullCalendarEvent> Events { get; set; } #

Gets or sets events displayed on the calendar.

public FullCalendarOptions Options { get; set; } #

Gets or sets configuration options for the calendar.