Interface IUiModalParameters

Interface representing the parameters for a UI modal component.

Namespace: Serenity.Modal.Application.Interfaces.Components

Assembly: Serenity.Modal.Application.dll

Syntax

public interface IUiModalParameters : IUiComponentParameters, IComponentParameters, IFoundationSettings

Properties

Alignment

Gets or sets the alignment type for the modal components.

Declaration

UiComponentAlignmentType Alignment { get; set; }

Property Value

Type	Description
UiComponentAlignmentType	The alignment type for the modal components.

Buttons

Gets or sets the list of buttons for the modal.

Declaration

List<IUiInteractable> Buttons { get; set; }

Property Value

Type	Description
List<IUiInteractable>	The list of buttons for the modal.

Direction

Gets or sets the axis along which the modal lays out its options.

Declaration

ModalDirection Direction { get; set; }

Property Value

Type	Description
ModalDirection	The modal layout direction.

IsTranslatingText

Gets or sets whether the text is treated as a localization key and translated.

Declaration

bool IsTranslatingText { get; set; }

Property Value

Type	Description
bool	true when the text should be localized at runtime.

IsTranslatingTitle

Gets or sets whether the title is treated as a localization key and translated.

Declaration

bool IsTranslatingTitle { get; set; }

Property Value

Type	Description
bool	true when the title should be localized at runtime.

Options

Gets or sets the rich options that built the modal's interactables (modelled like menu options).

Declaration

UiOption[] Options { get; set; }

Property Value

Type	Description
UiOption[]	The options for the modal.

OptionsGap

Gets or sets the spacing between consecutive options.

Declaration

float OptionsGap { get; set; }

Property Value

Type	Description
float	The gap applied between options.

Scrollable

Gets or sets whether the options area clamps to VisibleOptionsCount and scrolls.

Declaration

bool Scrollable { get; set; }

Property Value

Type	Description
bool	true when the modal options area should scroll.

SelectedButtonIndex

Gets or sets the index of the selected button.

Declaration

int SelectedButtonIndex { get; set; }

Property Value

Type	Description
int	The index of the selected button.

SerializedButtons

Gets or sets the serialized data for the buttons.

Declaration

List<SerializedComponentData> SerializedButtons { get; set; }

Property Value

Type	Description
List<SerializedComponentData>	The serialized data for the buttons.

SignalTypeTemplate

Gets or sets the signal type template for the modal.

Declaration

EventDispatcherSignal SignalTypeTemplate { get; set; }

Property Value

Type	Description
EventDispatcherSignal	The signal type template for the modal.

Text

Gets or sets the text content for the modal.

Declaration

string Text { get; set; }

Property Value

Type	Description
string	The text content for the modal.

TextFontSize

Gets or sets the font size for the text content.

Declaration

float TextFontSize { get; set; }

Property Value

Type	Description
float	The font size for the text content.

Title

Gets or sets the title for the modal.

Declaration

string Title { get; set; }

Property Value

Type	Description
string	The title for the modal.

VisibleOptionsCount

Gets or sets how many options are visible at once when Scrollable is on.

Declaration

int VisibleOptionsCount { get; set; }

Property Value

Type	Description
int	The number of options visible before scrolling; 0 or less disables clamping.