Interface IUiComponent

Interface for a UI component.

Namespace: Serenity.Ui.Application.Interfaces.Components

Assembly: Serenity.Ui.Application.dll

Syntax

public interface IUiComponent : IComponent, IFoundationSettings

Properties

ComponentActions

Gets the actions for the UI component.

Declaration

IUiComponentActions ComponentActions { get; }

Property Value

Type	Description
IUiComponentActions	The actions for the UI component.

ComponentParameters

Gets the parameters for the UI component.

Declaration

IUiComponentParameters ComponentParameters { get; }

Property Value

Type	Description
IUiComponentParameters	The parameters for the UI component.

Methods

Awake()

Method called when the component is awakened.

Declaration

void Awake()

GetUiElement()

Gets the UI element associated with the component.

Declaration

IFoundationViewElement GetUiElement()

Returns

Type	Description
IFoundationViewElement	The UI element associated with the component.

GetView()

Gets the view associated with the component.

Declaration

IViewBase GetView()

Returns

Type	Description
IViewBase	The view associated with the component.

OnDestroy()

Method called when the component is destroyed.

Declaration

void OnDestroy()

OnDisable()

Method called when the component is disabled.

Declaration

void OnDisable()

OnEnable()

Method called when the component is enabled.

Declaration

void OnEnable()

SetUiElement(IFoundationViewElement)

Sets the UI element associated with the component.

Declaration

void SetUiElement(IFoundationViewElement uiElement)

Parameters

Type	Name	Description
IFoundationViewElement	uiElement	The UI element to associate with the component.

SetView(IViewBase)

Sets the view associated with the component.

Declaration

void SetView(IViewBase view)

Parameters

Type	Name	Description
IViewBase	view	The view to associate with the component.

Update()

Method called when the component is updated.

Declaration

void Update()