Interface IMenuSettingsDefinition

Defines the settings required for a Menu.

Namespace: Serenity.Menu.Domain.Interfaces
Assembly: Serenity.Menu.Domain.dll
Syntax
public interface IMenuSettingsDefinition : IFoundationSettings
Remarks

This interface extends IFoundationSettings to include menu-specific configuration properties.

Properties

InstantiationMode

Gets the configured instantiation mode that controls when this menu's visual instance is created.

Declaration
MenuInstantiationMode InstantiationMode { get; }
Property Value
Type Description
MenuInstantiationMode

The configured MenuInstantiationMode for this menu.
Remarks

Configuration-only in this iteration; defaults to PreloadOnStartup and is not yet honored by any runtime code.

IsTranslatingTitle

Gets whether the title is being translated.

Declaration
bool IsTranslatingTitle { get; }
Property Value
Type Description
bool

True if the title is being translated; otherwise, false.

MenuAlignment

Gets the alignment of the menu.

Declaration
UiAnchorType MenuAlignment { get; }
Property Value
Type Description
UiAnchorType

The alignment of the menu as a UiAnchorType.

OnHide

Gets the signals to dispatch when the menu is hidden.

Declaration
IReadOnlyList<EventDispatcherSignal> OnHide { get; }
Property Value
Type Description
IReadOnlyList<EventDispatcherSignal>

A read-only list of event dispatcher signals fired on the hide transition.

OnShow

Gets the signals to dispatch when the menu is shown.

Declaration
IReadOnlyList<EventDispatcherSignal> OnShow { get; }
Property Value
Type Description
IReadOnlyList<EventDispatcherSignal>

A read-only list of event dispatcher signals fired on the show transition.

OptionAlignment

Gets the alignment of the menu options.

Declaration
UiComponentAlignmentType OptionAlignment { get; }
Property Value
Type Description
UiComponentAlignmentType

The alignment of the menu options as a UiComponentAlignmentType.

Options

Gets the array of options available in the menu.

Declaration
UiOption[] Options { get; }
Property Value
Type Description
UiOption[]

An array of UiOption representing the options in the menu.

OptionsGap

Gets the gap between menu options.

Declaration
float OptionsGap { get; }
Property Value
Type Description
float

The gap between menu options as a float.

Title

Gets the title of the menu.

Declaration
string Title { get; }
Property Value
Type Description
string

The title of the menu as a string.

TitleGap

Gets the gap between the title and the options.

Declaration
float TitleGap { get; }
Property Value
Type Description
float

The gap between the title and the options as a float.

See Also