Class TelerikWindow

The class for the Telerik Window component.

Inheritance

System.Object

Telerik.Blazor.Components.Common.BaseComponent

TelerikWindow

Namespace: Telerik.Blazor.Components

Assembly: Telerik.Blazor.dll

Syntax

public class TelerikWindow : BaseComponent, IDisposable

Constructors

TelerikWindow()

Declaration

public TelerikWindow()

Properties

Centered

Defines whether the Window will be centered. It is true by default. Not respected if Window has Top or Left Position.

Declaration

public bool Centered { get; set; }

Property Value

System.Boolean

CloseOnOverlayClick

Defines whether the window should close on overlay click action when the window is modal.

Declaration

public bool CloseOnOverlayClick { get; set; }

Property Value

System.Boolean

Draggable

Defines whether the window should be draggable through the titlebar.

Declaration

public bool Draggable { get; set; }

Property Value

System.Boolean

Height

Defines the height of the Window. Overrides a predefined Size.

Declaration

public string Height { get; set; }

Property Value

System.String

HeightChanged

Fires when the height parameter has changed.

Declaration

public EventCallback<string> HeightChanged { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<System.String>

Left

Defines the left position of the Window.

Declaration

public string Left { get; set; }

Property Value

System.String

LeftChanged

Fires when the left parameter has changed.

Declaration

public EventCallback<string> LeftChanged { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<System.String>

MaxHeight

Defines the max height of the Window.

Declaration

public string MaxHeight { get; set; }

Property Value

System.String

MaxWidth

Defines the max width of the Window.

Declaration

public string MaxWidth { get; set; }

Property Value

System.String

MinHeight

Defines the min height of the Window.

Declaration

public string MinHeight { get; set; }

Property Value

System.String

MinWidth

Defines the min width of the Window.

Declaration

public string MinWidth { get; set; }

Property Value

System.String

Modal

Whether the Window is modal.

Declaration

public bool Modal { get; set; }

Property Value

System.Boolean

PersistContent

Defines whether the content should be persisted when the window is minimized.

Declaration

public bool PersistContent { get; set; }

Property Value

System.Boolean

Resizable

Defines whether the window should be resizable. Default value is true.

Declaration

public bool Resizable { get; set; }

Property Value

System.Boolean

Size

Specifies the Size of the Window. See Medium.

Declaration

public string Size { get; set; }

Property Value

System.String

State

Defines the state of the window. To be rendered minimized, maximized or in default state.

Declaration

public WindowState State { get; set; }

Property Value

WindowState

StateChanged

Fires when the State Parameter has changed.

Declaration

public EventCallback<WindowState> StateChanged { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<WindowState>

Top

Defines the top position of the Window.

Declaration

public string Top { get; set; }

Property Value

System.String

TopChanged

Fires when the top parameter has changed.

Declaration

public EventCallback<string> TopChanged { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<System.String>

Visible

Defines whether the Window is rendered. Can define initial visibility and toggle visibility at runtime.

Declaration

public bool Visible { get; set; }

Property Value

System.Boolean

VisibleChanged

Fires when the Visible Parameter has changed.

Declaration

public EventCallback<bool> VisibleChanged { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<System.Boolean>

Width

Defines the width of the Window. Overrides a predefined Size.

Declaration

public string Width { get; set; }

Property Value

System.String

WidthChanged

Fires when the width parameter has changed.

Declaration

public EventCallback<string> WidthChanged { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<System.String>

WindowActions

Defines the action buttons of the Window.

Declaration

public RenderFragment WindowActions { get; set; }

Property Value

Microsoft.AspNetCore.Components.RenderFragment

WindowContent

Defines the content of the Window.

Declaration

public RenderFragment WindowContent { get; set; }

Property Value

Microsoft.AspNetCore.Components.RenderFragment

WindowTitle

Defines the title template of the Window.

Declaration

public RenderFragment WindowTitle { get; set; }

Property Value

Microsoft.AspNetCore.Components.RenderFragment

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

System.Boolean firstRender

Returns

System.Threading.Tasks.Task

Overrides

Telerik.Blazor.Components.Common.BaseComponent.OnAfterRenderAsync(System.Boolean)

OnParametersSet()

Declaration

protected override void OnParametersSet()

Refresh()

Refresh Method to manually re-render the Window. Useful when the component is disposed.

Declaration

public void Refresh()

SetParametersAsync(ParameterView)

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Microsoft.AspNetCore.Components.ParameterView parameters

Returns

System.Threading.Tasks.Task