Class
TelerikWindow

The class for the Telerik Window component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class TelerikWindow : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikWindow

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members BaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.Dispose()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnParametersSetAsync()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)

Constructors

TelerikWindow()

Declaration

cs-api-definition
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

cs-api-definition
[Parameter]
public bool Centered { get; set; }

Property Value

bool

CloseOnOverlayClick

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

Declaration

cs-api-definition
[Parameter]
public bool CloseOnOverlayClick { get; set; }

Property Value

bool

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

cs-api-definition
[Parameter]
public string ContainmentSelector { get; set; }

Property Value

string

Draggable

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

Declaration

cs-api-definition
[Parameter]
public bool Draggable { get; set; }

Property Value

bool

FooterLayoutAlign

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

Declaration

cs-api-definition
[Parameter]
public WindowFooterLayoutAlign FooterLayoutAlign { get; set; }

Property Value

WindowFooterLayoutAlign

Height

Defines the height of the Window as a CSS value.

Declaration

cs-api-definition
[Parameter]
public string Height { get; set; }

Property Value

string

HeightChanged

Fires when the height parameter has changed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<string> HeightChanged { get; set; }

Property Value

EventCallback<string>

Left

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

Declaration

cs-api-definition
[Parameter]
public string Left { get; set; }

Property Value

string

LeftChanged

Fires when the left parameter has changed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<string> LeftChanged { get; set; }

Property Value

EventCallback<string>

MaxHeight

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

Declaration

cs-api-definition
[Parameter]
public string MaxHeight { get; set; }

Property Value

string

MaxWidth

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

Declaration

cs-api-definition
[Parameter]
public string MaxWidth { get; set; }

Property Value

string

MinHeight

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

Declaration

cs-api-definition
[Parameter]
public string MinHeight { get; set; }

Property Value

string

MinWidth

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

Declaration

cs-api-definition
[Parameter]
public string MinWidth { get; set; }

Property Value

string

Modal

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

Declaration

cs-api-definition
[Parameter]
public bool Modal { get; set; }

Property Value

bool

PersistContent

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

Declaration

cs-api-definition
[Parameter]
public bool PersistContent { get; set; }

Property Value

bool

Resizable

Defines if the window should be resizable. The default value is true.

Declaration

cs-api-definition
[Parameter]
public bool Resizable { get; set; }

Property Value

bool

Size

Specifies the Size of the Window. See Medium.

Declaration

cs-api-definition
[Parameter]
public string Size { get; set; }

Property Value

string

State

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

Declaration

cs-api-definition
[Parameter]
public WindowState State { get; set; }

Property Value

WindowState

StateChanged

Fires when the State Parameter has changed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<WindowState> StateChanged { get; set; }

Property Value

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

cs-api-definition
[Parameter]
public string ThemeColor { get; set; }

Property Value

string

Top

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

Declaration

cs-api-definition
[Parameter]
public string Top { get; set; }

Property Value

string

TopChanged

Fires when the top parameter has changed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<string> TopChanged { get; set; }

Property Value

EventCallback<string>

Visible

Defines whether the Window is rendered. Can define initial visibility and toggle visibility at runtime. The default value is false.

Declaration

cs-api-definition
[Parameter]
public bool Visible { get; set; }

Property Value

bool

VisibleChanged

Fires when the Visible Parameter has changed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<bool> VisibleChanged { get; set; }

Property Value

EventCallback<bool>

Width

Defines the width of the Window as a CSS value.

Declaration

cs-api-definition
[Parameter]
public string Width { get; set; }

Property Value

string

WidthChanged

Fires when the width parameter has changed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<string> WidthChanged { get; set; }

Property Value

EventCallback<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

cs-api-definition
[Parameter]
public RenderFragment WindowActions { get; set; }

Property Value

RenderFragment

WindowContent

Defines the content of the Window.

Declaration

cs-api-definition
[Parameter]
public RenderFragment WindowContent { get; set; }

Property Value

RenderFragment

WindowFooter

Defines the footer content of the Window.

Declaration

cs-api-definition
[Parameter]
public RenderFragment WindowFooter { get; set; }

Property Value

RenderFragment

WindowTitle

Defines the title template of the Window.

Declaration

cs-api-definition
[Parameter]
public RenderFragment WindowTitle { get; set; }

Property Value

RenderFragment

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnAfterRenderAsync(bool)

Declaration

cs-api-definition
protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)

OnInitialized()

Declaration

cs-api-definition
protected override void OnInitialized()

Overrides ComponentBase.OnInitialized()

OnParametersSet()

Declaration

cs-api-definition
protected override void OnParametersSet()

Overrides ComponentBase.OnParametersSet()

Refresh()

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

Declaration

cs-api-definition
public void Refresh()

SetParametersAsync(ParameterView)

Declaration

cs-api-definition
public override Task SetParametersAsync(ParameterView parameters)

Parameters

parameters

ParameterView

Returns

Task

Overrides ComponentBase.SetParametersAsync(ParameterView)