Interface IUiModal

Interface representing a UI modal component.

Namespace: Serenity.Modal.Application.Interfaces.Components

Assembly: Serenity.Modal.Application.dll

Syntax

public interface IUiModal : IComponent, IFoundationSettings

Remarks

Extends the IComponent interface.

Properties

ModalParameters

Gets or sets the parameters for the modal.

Declaration

IUiModalParameters ModalParameters { get; set; }

Property Value

Type	Description
IUiModalParameters	The modal parameters.

Methods

DestroyModal()

Destroys the modal component.

Declaration

IEnumerator DestroyModal()

Returns

Type	Description
IEnumerator	An IEnumerator for coroutine handling.

ExecuteChangeOptionValue(UiOptionValue)

Executes the change of the option value.

Declaration

void ExecuteChangeOptionValue(UiOptionValue optionValue)

Parameters

Type	Name	Description
UiOptionValue	optionValue	The option value to change to.

ExecuteSelectOption()

Executes the selection of the currently selected option.

Declaration

void ExecuteSelectOption()

GetOptionByIndex(int)

Gets the option by its index.

Declaration

IUiInteractable GetOptionByIndex(int index)

Parameters

Type	Name	Description
int	index	The index of the option.

Returns

Type	Description
IUiInteractable	The interactable component representing the option.

GetSelectedOption()

Gets the currently selected option in the modal.

Declaration

IUiInteractable GetSelectedOption()

Returns

Type	Description
IUiInteractable	The interactable component representing the selected option.

GetSelectedOptionIndex()

Gets the index of the currently selected option.

Declaration

int GetSelectedOptionIndex()

Returns

Type	Description
int	The index of the selected option.

OnDraggingEnd()

To be called when dragging ends.

Declaration

void OnDraggingEnd()

OnDraggingStart()

To be called when dragging starts.

Declaration

void OnDraggingStart()

SelectNextOption()

Selects the next option in the modal.

Declaration

void SelectNextOption()

SelectPreviousOption()

Selects the previous option in the modal.

Declaration

void SelectPreviousOption()

SetNextOptionValue()

Sets the next option value from options list.

Declaration

void SetNextOptionValue()

SetPreviousOptionValue()

Sets the previous option value from options list.

Declaration

void SetPreviousOptionValue()