HtmlForgeX

API Reference

Class

TablerAgendaRail

Edit on GitHub
Namespace HtmlForgeX
Assembly HtmlForgeX
Source Containers/Tabler/Card/TablerDashboardBusinessComponents.cs:12
Base Element
Modifiers sealed

Right-side agenda rail for schedules, appointments, handoffs, and compact event feeds.

Inheritance

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

Methods

public TablerAgendaRail Accent(TablerColor color) #
Containers/Tabler/Card/TablerDashboardBusinessComponents.cs:55
Returns: TablerAgendaRail

Sets the ambient accent color for the rail.

Parameters

color HtmlForgeX.TablerColor requiredposition: 0
AddDay 3 overloads
public TablerAgendaRail AddDay(String label, String value, Boolean active = false, Nullable<TablerColor> color = null) #
Containers/Tabler/Card/TablerDashboardBusinessComponents.cs:63
Returns: TablerAgendaRail

Adds a day chip to the compact date strip.

Parameters

label System.String requiredposition: 0
value System.String requiredposition: 1
active System.Boolean = false optionalposition: 2
color System.Nullable{HtmlForgeX.TablerColor} = null optionalposition: 3
public TablerAgendaRail AddDay(DateTimeOffset date, Boolean active = false, Nullable<TablerColor> color = null) #
Containers/Tabler/Card/TablerDashboardBusinessComponents.cs:78
Returns: TablerAgendaRail

Adds one day chip using invariant weekday and day-of-month labels.

Parameters

date System.DateTime requiredposition: 0
active System.Boolean = false optionalposition: 1
color System.Nullable{HtmlForgeX.TablerColor} = null optionalposition: 2
AddDay(System.DateTimeOffset date, System.Boolean active, System.Nullable{HtmlForgeX.TablerColor} color) #

Adds one day chip using invariant weekday and day-of-month labels.

Parameters

date System.DateTimeOffset required
active System.Boolean required
color System.Nullable{HtmlForgeX.TablerColor} required
AddEvent 3 overloads
public TablerAgendaRail AddEvent(String time, String title, String description = null, Nullable<TablerColor> color = null, Action<TablerAgendaEventBuilder> configure = null) #
Containers/Tabler/Card/TablerDashboardBusinessComponents.cs:85
Returns: TablerAgendaRail

Adds an agenda event card.

Parameters

time System.String requiredposition: 0
title System.String requiredposition: 1
description System.String = null optionalposition: 2
color System.Nullable{HtmlForgeX.TablerColor} = null optionalposition: 3
configure System.Action{HtmlForgeX.TablerAgendaEventBuilder} = null optionalposition: 4
public TablerAgendaRail AddEvent(DateTimeOffset start, DateTimeOffset end, String title, String description = null, Nullable<TablerColor> color = null, Action<TablerAgendaEventBuilder> configure = null) #
Containers/Tabler/Card/TablerDashboardBusinessComponents.cs:102
Returns: TablerAgendaRail

Adds an agenda event card using an invariant short-time range.

Parameters

start System.DateTime requiredposition: 0
end System.DateTime requiredposition: 1
title System.String requiredposition: 2
description System.String = null optionalposition: 3
color System.Nullable{HtmlForgeX.TablerColor} = null optionalposition: 4
configure System.Action{HtmlForgeX.TablerAgendaEventBuilder} = null optionalposition: 5
AddEvent(System.DateTimeOffset start, System.DateTimeOffset end, System.String title, System.String description, System.Nullable{HtmlForgeX.TablerColor} color, System.Action{HtmlForgeX.TablerAgendaEventBuilder} configure) #

Adds an agenda event card using an invariant short-time range.

Parameters

start System.DateTimeOffset required
end System.DateTimeOffset required
title System.String required
description System.String required
color System.Nullable{HtmlForgeX.TablerColor} required
configure System.Action{HtmlForgeX.TablerAgendaEventBuilder} required
AddUpdate 3 overloads
public TablerAgendaRail AddUpdate(DateTimeOffset date, String title, String note = null, Nullable<TablerColor> color = null, Nullable<TablerIconType> icon = null) #
Containers/Tabler/Card/TablerDashboardBusinessComponents.cs:124
Returns: TablerAgendaRail

Adds a dated update row below the schedule.

Parameters

date System.String requiredposition: 0
title System.String requiredposition: 1
note System.String = null optionalposition: 2
color System.Nullable{HtmlForgeX.TablerColor} = null optionalposition: 3
icon System.Nullable{HtmlForgeX.TablerIconType} = null optionalposition: 4
AddUpdate(System.DateTime date, System.String title, System.String note, System.Nullable{HtmlForgeX.TablerColor} color, System.Nullable{HtmlForgeX.TablerIconType} icon) #

Adds an update row using an invariant compact date label.

Parameters

date System.DateTime required
title System.String required
note System.String required
color System.Nullable{HtmlForgeX.TablerColor} required
icon System.Nullable{HtmlForgeX.TablerIconType} required
AddUpdate(System.DateTimeOffset date, System.String title, System.String note, System.Nullable{HtmlForgeX.TablerColor} color, System.Nullable{HtmlForgeX.TablerIconType} icon) #

Adds an update row using an invariant compact date label.

Parameters

date System.DateTimeOffset required
title System.String required
note System.String required
color System.Nullable{HtmlForgeX.TablerColor} required
icon System.Nullable{HtmlForgeX.TablerIconType} required
public TablerAgendaRail Period(String period) #
Containers/Tabler/Card/TablerDashboardBusinessComponents.cs:47
Returns: TablerAgendaRail

Sets the period label shown above the day strip.

Parameters

period System.String requiredposition: 0
RegisterLibraries() #
public TablerAgendaRail Settings(Action<TablerAgendaRailSettings> configure) #
Containers/Tabler/Card/TablerDashboardBusinessComponents.cs:131
Returns: TablerAgendaRail

Groups less-common display options under a smaller fluent surface.

Parameters

configure System.Action{HtmlForgeX.TablerAgendaRailSettings} requiredposition: 0
public TablerAgendaRail Subtitle(String subtitle) #
Containers/Tabler/Card/TablerDashboardBusinessComponents.cs:39
Returns: TablerAgendaRail

Sets supporting copy shown under the rail title.

Parameters

subtitle System.String requiredposition: 0
public TablerAgendaRail Title(String title) #
Containers/Tabler/Card/TablerDashboardBusinessComponents.cs:31
Returns: TablerAgendaRail

Sets the rail title.

Parameters

title System.String requiredposition: 0
public override String ToString() #
Containers/Tabler/Card/TablerDashboardBusinessComponents.cs:172
Returns: String