Class TelerikWindow

The class for the Telerik Window component.

Inheritance
System.Object
BaseComponent
TelerikWindow
Inherited Members
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. Not respected if Window has Top or Left Position. The default value is true.

Declaration
public bool Centered { get; set; }
Property Value
System.Boolean

CloseOnOverlayClick

Defines if the window should close when the user clicks or taps on the modal overlay click.

Declaration
public bool CloseOnOverlayClick { get; set; }
Property Value
System.Boolean

ContainmentSelector

The selector of the element that will contain the window. The window will not be able to leave the boundaries of the specified element.

Declaration
public string ContainmentSelector { get; set; }
Property Value
System.String

Draggable

Defines if the window should be draggable through the titlebar. The default value is true.

Declaration
public bool Draggable { get; set; }
Property Value
System.Boolean

FooterLayoutAlign

Defines the layout of the content in the footer. Default value is Stretch. The possible options are Stretch, Start, End, Center.

Declaration
public WindowFooterLayoutAlign FooterLayoutAlign { get; set; }
Property Value
WindowFooterLayoutAlign

Height

Defines the height of the Window as a CSS value.

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 relative to the viewport (where the TelerikRootComponent is declared). See Dimensions.

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 as a CSS value.

Declaration
public string MaxHeight { get; set; }
Property Value
System.String

MaxWidth

Defines the max width of the Window as a CSS value.

Declaration
public string MaxWidth { get; set; }
Property Value
System.String

MinHeight

Defines the min height of the Window as a CSS value.

Declaration
public string MinHeight { get; set; }
Property Value
System.String

MinWidth

Defines the min width of the Window as a CSS value.

Declaration
public string MinWidth { get; set; }
Property Value
System.String

Modal

Specifies if the Window is modal. See Modal Window. The default value is false.

Declaration
public bool Modal { get; set; }
Property Value
System.Boolean

PersistContent

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

Declaration
public bool PersistContent { get; set; }
Property Value
System.Boolean

Resizable

Defines if the window should be resizable. The 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>

ThemeColor

Defines the theme color of the Window titlebar. The default value is string.Empty and the titlebar has the theme's header style.

Declaration
public string ThemeColor { get; set; }
Property Value
System.String

Top

Defines the top position of the Window relative to the viewport (where the TelerikRootComponent is declared). See Dimensions.

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. The default value is false.

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 as a CSS value.

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 container tag for the Wizard buttons. This setting lets you define the predefined actions of the Window or create your custom actions. See https://docs.telerik.com/blazor-ui/components/window/actions.

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

WindowFooter

Defines the footer content of the Window.

Declaration
public RenderFragment WindowFooter { 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

OnInitialized()

Declaration
protected override void OnInitialized()

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