HtmlForgeX

API Reference

Class

FullCalendarEvent

Namespace HtmlForgeX
Assembly HtmlForgeX

Represents an event in the FullCalendar library.

Inheritance

  • Object
  • FullCalendarEvent

Constructors

FullCalendarEvent 2 overloads
public FullCalendarEvent(String title, DateTime start) #

Initializes a new instance of the FullCalendarEvent class with the specified title and start date.

Parameters

title System.String requiredposition: 0
The title of the event.
start System.DateTime requiredposition: 1
The start date of the event.
public FullCalendarEvent(String title, String description, DateTime start, Nullable<DateTime> end = null) #

Initializes a new instance of the FullCalendarEvent class with the specified title, description, start date, and end date.

Parameters

title System.String requiredposition: 0
The title of the event.
description System.String requiredposition: 1
The description of the event.
start System.DateTime requiredposition: 2
The start date of the event.
end System.Nullable{System.DateTime} = null optionalposition: 3
The end date of the event. If null, the event is considered to last one day.

Methods

public FullCalendarEvent AllDay(Boolean value) #
Returns: FullCalendarEvent

Sets whether the event spans the entire day.

Parameters

value System.Boolean requiredposition: 0
True when the event is all day.

Returns

The current event instance.

public FullCalendarEvent BackgroundColor(RGBColor value) #
Returns: FullCalendarEvent

Sets the background color of the event.

Parameters

value HtmlForgeX.RGBColor requiredposition: 0
Background color.

Returns

The current event instance.

public FullCalendarEvent BorderColor(RGBColor value) #
Returns: FullCalendarEvent

Sets the border color of the event.

Parameters

value HtmlForgeX.RGBColor requiredposition: 0
Border color.

Returns

The current event instance.

public FullCalendarEvent Color(RGBColor value) #
Returns: FullCalendarEvent

Sets the primary color for the event.

Parameters

value HtmlForgeX.RGBColor requiredposition: 0
The color.

Returns

The current event instance.

public FullCalendarEvent Description(String value) #
Returns: FullCalendarEvent

Updates the event description.

Parameters

value System.String requiredposition: 0
Description text.

Returns

The current event instance.

public FullCalendarEvent End(Nullable<DateTime> value) #
Returns: FullCalendarEvent

Sets the end date for the event.

Parameters

value System.Nullable{System.DateTime} requiredposition: 0
End time.

Returns

The current event instance.

public FullCalendarEvent Interactive(Boolean value) #
Returns: FullCalendarEvent

Specifies whether the event is interactive.

Parameters

value System.Boolean requiredposition: 0
True when interactive.

Returns

The current event instance.

public FullCalendarEvent Start(DateTime value) #
Returns: FullCalendarEvent

Sets the start date for the event.

Parameters

value System.DateTime requiredposition: 0
Start time.

Returns

The current event instance.

public FullCalendarEvent TextColor(RGBColor value) #
Returns: FullCalendarEvent

Sets the text color of the event.

Parameters

value HtmlForgeX.RGBColor requiredposition: 0
Text color.

Returns

The current event instance.

public FullCalendarEvent Title(String value) #
Returns: FullCalendarEvent

Changes the title of the event.

Parameters

value System.String requiredposition: 0
New title.

Returns

The current event instance.

public FullCalendarEvent Url(String value) #
Returns: FullCalendarEvent

Sets the URL associated with the event.

Parameters

value System.String requiredposition: 0
URL value.

Returns

The current event instance.

Properties

public String TitleValue { get; set; } #
JsonPropertyName("title")

Gets or sets the title of the event.

public String UrlValue { get; set; } #
JsonIgnore(Condition = 3) JsonPropertyName("url")

Gets or sets the URL of the event.

public String DescriptionValue { get; set; } #
JsonIgnore(Condition = 3) JsonPropertyName("description")

Gets or sets the description of the event.

public DateTime StartValue { get; set; } #
JsonPropertyName("start")

Gets or sets the start date of the event.

public Nullable<DateTime> EndValue { get; set; } #
JsonIgnore(Condition = 3) JsonPropertyName("end")

Gets or sets the end date of the event.

public Nullable<Boolean> AllDayValue { get; set; } #
JsonIgnore(Condition = 3) JsonPropertyName("allDay")

Gets or sets a value indicating whether the event lasts all day.

public Nullable<Boolean> InteractiveValue { get; set; } #
JsonIgnore(Condition = 3) JsonPropertyName("interactive")

Gets or sets a value indicating whether the event is interactive.

public RGBColor ColorValue { get; set; } #
JsonConverter(typeof(RGBColorConverter)) JsonIgnore(Condition = 3) JsonPropertyName("color")

Gets or sets the color of the event.

public RGBColor BackgroundColorValue { get; set; } #
JsonConverter(typeof(RGBColorConverter)) JsonIgnore(Condition = 3) JsonPropertyName("backgroundColor")

Gets or sets the background color of the event.

public RGBColor BorderColorValue { get; set; } #
JsonConverter(typeof(RGBColorConverter)) JsonIgnore(Condition = 3) JsonPropertyName("borderColor")

Gets or sets the border color of the event.

public RGBColor TextColorValue { get; set; } #
JsonConverter(typeof(RGBColorConverter)) JsonIgnore(Condition = 3) JsonPropertyName("textColor")

Gets or sets the text color of the event.