Class BOBDateRangePicker

Namespace

BlazOrbit.Components.Forms

Assembly

BlazOrbit.dll

[GenerateComponentInfo]
public class BOBDateRangePicker : BOBComponentBase, IHasSize, IHasDensity, IPickerFamilyComponent

Inheritance

object

ComponentBase

BOBComponentBase

BOBDateRangePicker

Implements

IHasSize

IHasDensity

IPickerFamilyComponent

Inherited Members

BOBComponentBase.OnInitialized()

BOBComponentBase.OnParametersSet()

BOBComponentBase.OnAfterRenderAsync(bool)

BOBComponentBase.DisposeAsync()

BOBComponentBase.AdditionalAttributes

BOBComponentBase.ComputedAttributes

BOBComponentBase.IsDisposed

Constructors

BOBDateRangePicker()

public BOBDateRangePicker()

Properties

ClearText

Localised label for the "clear" preset.

[Parameter]
public string? ClearText { get; set; }

Property Value

string

DaysText

Localised noun used in the summary day-count line ("days" by default).

[Parameter]
public string? DaysText { get; set; }

Property Value

string

Density

Vertical density of the component.

[Parameter]
public BOBDensity Density { get; set; }

Property Value

BOBDensity

EndLabel

Caption for the end-date pane. Defaults to "End".

[Parameter]
public string? EndLabel { get; set; }

Property Value

string

Label

Optional label rendered above the two pickers.

[Parameter]
public string? Label { get; set; }

Property Value

string

Last30DaysText

Localised label for the "last 30 days" preset.

[Parameter]
public string? Last30DaysText { get; set; }

Property Value

string

Last7DaysText

Localised label for the "last 7 days" preset.

[Parameter]
public string? Last7DaysText { get; set; }

Property Value

string

ShowPresets

When true (default), render the preset shortcut buttons.

[Parameter]
public bool ShowPresets { get; set; }

Property Value

bool

ShowSummary

When true (default), render the textual summary below the picker.

[Parameter]
public bool ShowSummary { get; set; }

Property Value

bool

Size

Visual size of the component.

[Parameter]
public BOBSize Size { get; set; }

Property Value

BOBSize

StartLabel

Caption for the start-date pane. Defaults to "Start".

[Parameter]
public string? StartLabel { get; set; }

Property Value

string

ThisMonthText

Localised label for the "this month" preset.

[Parameter]
public string? ThisMonthText { get; set; }

Property Value

string

Value

Currently selected range. Defaults to an empty range.

[Parameter]
public DateRange Value { get; set; }

Property Value

DateRange

ValueChanged

Raised when the user picks a date or applies a preset.

[Parameter]
public EventCallback<DateRange> ValueChanged { get; set; }

Property Value

EventCallback<DateRange>

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder.

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder