Class OverviewScreenBase<TModel>

Namespace

Dynamicweb.CoreUI.Screens

Assembly

Dynamicweb.CoreUI.dll

public abstract class OverviewScreenBase<TModel> : ScreenBase<TModel> where TModel : DataViewModelBase

Type Parameters

TModel

Inheritance

object

ScreenBase

ScreenBase<TModel>

OverviewScreenBase<TModel>

Inherited Members

ScreenBase<TModel>.Model

ScreenBase<TModel>.GetNavigationNodePathProviders()

ScreenBase<TModel>.Query

ScreenBase<TModel>.GetNavigationNodePath()

ScreenBase.FocusedComponent

ScreenBase.PresetId

ScreenBase.GetDefinition()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ShowCloseAction

protected bool ShowCloseAction { get; set; }

Property Value

bool

Methods

AddComponent(UiComponentBase?, string?, GroupWidth, Icon?, ContextMenu?, string?)

Adds a Widget to the overview screen with the given heading and width containing the given component.

protected void AddComponent(UiComponentBase? component, string? heading = null, Group.GroupWidth width = GroupWidth.Col_6, Icon? icon = null, ContextMenu? contextMenu = null, string? color = null)

Parameters

component UiComponentBase

The content of the widget.

heading string

The heading of the widget, if given.

width Group.GroupWidth

The width of the container, if given.

icon Icon

contextMenu ContextMenu

color string

AddComponent(string?, UiComponentBase?, string?, GroupWidth, Icon?, ContextMenu?, string?)

Adds a Widget to the overview screen with the given heading and width containing the given component.

protected void AddComponent(string? tabName, UiComponentBase? component, string? heading = null, Group.GroupWidth width = GroupWidth.Col_6, Icon? icon = null, ContextMenu? contextMenu = null, string? color = null)

Parameters

tabName string

The name of the tab in which the widget goes.

component UiComponentBase

The content of the widget.

heading string

The heading of the widget, if given.

width Group.GroupWidth

The width of the container, if given.

icon Icon

contextMenu ContextMenu

color string

AddWidget(Widget, GroupWidth)

protected void AddWidget(Widget widget, Group.GroupWidth width = GroupWidth.Col_6)

Parameters

widget Widget

width Group.GroupWidth

AddWidget(string?, Widget, GroupWidth)

protected void AddWidget(string? tabName, Widget widget, Group.GroupWidth width = GroupWidth.Col_6)

Parameters

tabName string

widget Widget

width Group.GroupWidth

BuildOverviewScreen()

protected abstract void BuildOverviewScreen()

GetDefinitionInternal()

protected override sealed UiComponentBase GetDefinitionInternal()

Returns

UiComponentBase

GetScreenActions()

protected virtual IEnumerable<ActionGroup>? GetScreenActions()

Returns

IEnumerable<ActionGroup>

GetScreenName()

protected abstract string GetScreenName()

Returns

string

SetInfobar(InfoBar?)

protected void SetInfobar(InfoBar? bar)

Parameters

bar InfoBar