Interface ICompositeViewService

Registry and coordinator for composite views. Mirrors the role the menu service plays for menus: it owns the built composites, can show/hide them, and routes child-activation requests (e.g. from a navigation rail) to the right composite.

Namespace: Serenity.Ui.Application.Interfaces.Services

Assembly: Serenity.Ui.Application.dll

Syntax

public interface ICompositeViewService : IService, IFoundationSettings, IViewProvider

Remarks

As an Serenity.Global.Application.Interfaces.IViewProvider, the composite-view service can be driven by the top-level view router to show composites by id alongside other view subsystems. ShowView(string) already satisfies the provider contract; implementations add Serenity.Global.Application.Interfaces.IViewProvider.HasView(System.String).

Methods

ActivateChild(string, string)

Activates a child within a composite — the operation a navigation rail triggers to swap the content area. Resolves the composite by id and delegates to it.

Declaration

void ActivateChild(string compositeViewId, string childViewId)

Parameters

Type	Name	Description
string	compositeViewId	The composite that owns the child.
string	childViewId	The child to activate.

GetActiveInputView()

The view that should currently receive input control: the active child of a shown SWITCHER composite (e.g. a detail menu a navigation rail opened). Returns null when no switcher currently shows a child, so an input controller can fall back to its default target (e.g. a persistent predominant menu). This lets input follow the active detail region without per-frame wiring.

Declaration

IViewBase GetActiveInputView()

Returns

Type	Description
IViewBase	The focused input view, or null when none.

GetView(string)

Resolves a registered composite by id, or null when not found.

Declaration

ICompositeView GetView(string compositeViewId)

Parameters

Type	Name	Description
string	compositeViewId	The composite view's id.

Returns

Type	Description
ICompositeView	The composite view, or null.

GetViews()

All registered composite views.

Declaration

IReadOnlyCollection<ICompositeView> GetViews()

Returns

Type	Description
IReadOnlyCollection<ICompositeView>	The registered composites.

HideView(string)

Hides the composite with the given id.

Declaration

void HideView(string compositeViewId)

Parameters

Type	Name	Description
string	compositeViewId	The composite view's id.

RegisterView(ICompositeView)

Registers a built composite view so the service can resolve and coordinate it.

Declaration

void RegisterView(ICompositeView view)

Parameters

Type	Name	Description
ICompositeView	view	The composite view to register.

ShowView(string)

Shows the composite with the given id.

Declaration

void ShowView(string compositeViewId)

Parameters

Type	Name	Description
string	compositeViewId	The composite view's id.

See Also

IService