Interface IUiShowModalParameters

Interface representing the parameters for showing a UI modal.

Namespace: Serenity.Modal.Application.Interfaces.Components

Assembly: Serenity.Modal.Application.dll

Syntax

public interface IUiShowModalParameters

Properties

Alignment

Gets or sets the alignment of the modal content.

Declaration

UiComponentAlignmentType Alignment { get; set; }

Property Value

Type	Description
UiComponentAlignmentType	The alignment of the modal content.

Buttons

Gets or sets the list of buttons for the modal.

Declaration

List<SerializedComponentData> Buttons { get; set; }

Property Value

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

Remarks

Deprecated in favor of Options. Retained for one release so existing modal assets deserialize unchanged; they are migrated to Options (each button becomes a UiOption with InteractionType = SUBMIT) the first time the asset is loaded.

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; defaults to HORIZONTAL.

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 for the modal (sliders, toggles, selectors, submits).

Declaration

UiOption[] Options { get; set; }

Property Value

Type	Description
UiOption[]	The options for the modal, modelled exactly like menu options.

OptionsGap

Gets or sets the spacing between consecutive options.

Declaration

float OptionsGap { get; set; }

Property Value

Type	Description
float	The gap, in UI units, applied between options.

Scrollable

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

Declaration

bool Scrollable { get; set; }

Property Value

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

SignalTypeName

Gets or sets the serialized name of the signal type associated with the modal.

Declaration

string SignalTypeName { get; set; }

Property Value

Type	Description
string	The assembly qualified name of the signal type.

Text

Gets or sets the text content of the modal.

Declaration

string Text { get; set; }

Property Value

Type	Description
string	The text content for the modal.

Title

Gets or sets the title of 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.

Methods

GetSignalInstance()

Gets the signal instance associated with the modal.

Declaration

EventDispatcherSignal GetSignalInstance()

Returns

Type	Description
EventDispatcherSignal	An instance of EventDispatcherSignal or null if not set or invalid.