HtmlForgeX

API Reference

Command

New-HtmlXCalendar

Namespace HtmlForgeX.PowerShell
Outputs
HtmlForgeX.FullCalendar

Creates a FullCalendar instance and adds it to the DSL context.

Remarks

Part of the HtmlForgeX.PowerShell DSL.

Examples

Authored help example

Example 1: Create a calendar with a couple of events.


New-HtmlXCalendar -WeekNumbers -NowIndicator {
    New-HtmlXCalendarEvent -Title "Maintenance" -Start (Get-Date) -End (Get-Date).AddHours(2) -AllDay:$false
    New-HtmlXCalendarEvent -Title "Release" -Start (Get-Date).AddDays(1)
}
        

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

New-HtmlXCalendar [-Content <ScriptBlock>] [-BusinessHours] [-ButtonIcons] [-DayMaxEventRows] [-Editable] [-InitialDate <DateTime>] [-NavLinks] [-NowIndicator] [-Selectable] [-SelectMirror] [-WeekNumberCalculation <string>] [-WeekNumbers] [<CommonParameters>]
#

Parameters

Content ScriptBlock optionalposition: 0pipeline: false
Scriptblock that emits calendar events.
BusinessHours SwitchParameter optionalposition: namedpipeline: false
Highlights business hours.
ButtonIcons SwitchParameter optionalposition: namedpipeline: false
Uses icons for button text.
DayMaxEventRows SwitchParameter optionalposition: namedpipeline: false
Limits rows per day with "more" links.
Editable SwitchParameter optionalposition: namedpipeline: false
Enables drag/drop event editing.
InitialDate DateTime optionalposition: namedpipeline: false
Sets the initial date displayed by the calendar.
NavLinks SwitchParameter optionalposition: namedpipeline: false
Enables navigation links on day/week names.
NowIndicator SwitchParameter optionalposition: namedpipeline: false
Shows a marker for the current time.
Selectable SwitchParameter optionalposition: namedpipeline: false
Allows date selection.
SelectMirror SwitchParameter optionalposition: namedpipeline: false
Mirrors selection while dragging.
WeekNumberCalculation string optionalposition: namedpipeline: false
Week number calculation mode.
WeekNumbers SwitchParameter optionalposition: namedpipeline: false
Shows week numbers.

Outputs

HtmlForgeX.FullCalendar