Class

TelerikWindow

Declaration

public TelerikWindow()

Sets the animation duration in milliseconds for show/hide effects. Shorter values (100-200ms) provide snappy animations, while longer values (500ms+) create smoother transitions. The default value is 300.

Declaration

[Parameter]
public int AnimationDuration { get; set; }

Property Value

Controls the animation effect when the Window appears or disappears. Options include Fade, ZoomIn, or None for no animation. The default value is None.

Declaration

[Parameter]
public WindowAnimationType AnimationType { get; set; }

Property Value

Allows the modal Window to be closed when users click on the backdrop overlay. Only applies to modal windows where Modal is true. Provides an alternative way to close the window besides using action buttons.

Declaration

[Parameter]
public bool CloseOnOverlayClick { get; set; }

Property Value

Specifies a CSS selector for the element that will constrain the Window's movement. The window cannot be dragged outside the boundaries of the specified element. Cannot be used with Modal windows.

Declaration

[Parameter]
public string ContainmentSelector { get; set; }

Property Value

Enables users to drag the Window by its titlebar to reposition it. Drag operation is constrained by ContainmentSelector if specified. The default value is true.

Declaration

[Parameter]
public bool Draggable { get; set; }

Property Value

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

Declaration

[Parameter]
public WindowFooterLayoutAlign FooterLayoutAlign { get; set; }

Property Value

Defines the height of the Window as a CSS value. Supports units like px, %, em, rem, or viewport units (e.g., "300px", "40vh", "15em"). If not specified, the window uses content-based sizing.

Declaration

[Parameter]
public string Height { get; set; }

Property Value

Fires when the height parameter has changed.

Declaration

[Parameter]
public EventCallback<string> HeightChanged { get; set; }

Property Value

The id of the window HTML element.

Declaration

[Parameter]
public string Id { get; set; }

Property Value

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

Declaration

[Parameter]
public string Left { get; set; }

Property Value

Fires when the left parameter has changed.

Declaration

[Parameter]
public EventCallback<string> LeftChanged { get; set; }

Property Value

Sets the maximum height constraint for the Window as a CSS value. Prevents the window from being resized larger than this value (e.g., "600px", "80vh"). Useful for maintaining responsive layouts.

Declaration

[Parameter]
public string MaxHeight { get; set; }

Property Value

Sets the maximum width constraint for the Window as a CSS value. Prevents the window from being resized larger than this value (e.g., "800px", "90vw"). Useful for maintaining responsive layouts.

Declaration

[Parameter]
public string MaxWidth { get; set; }

Property Value

Sets the minimum height constraint for the Window as a CSS value. Prevents the window from being resized smaller than this value (e.g., "150px", "10em"). When Resizable is true, defaults to "100px".

Declaration

[Parameter]
public string MinHeight { get; set; }

Property Value

Sets the minimum width constraint for the Window as a CSS value. Prevents the window from being resized smaller than this value (e.g., "200px", "15em"). When Resizable is true, defaults to "120px".

Declaration

[Parameter]
public string MinWidth { get; set; }

Property Value

Determines whether the Window displays as a modal dialog that blocks interaction with the rest of the page. When true, shows a backdrop overlay and traps focus within the window. Cannot be used with ContainmentSelector. The default value is false.

Declaration

[Parameter]
public bool Modal { get; set; }

Property Value

Maintains the Window content in the DOM when minimized, preserving component state and user input. When false, content is removed from DOM during minimization, which may improve performance but loses state.

Declaration

[Parameter]
public bool PersistContent { get; set; }

Property Value

Enables users to resize the Window by dragging its edges or corners. Resize operation respects MinWidth, MinHeight, MaxWidth, and MaxHeight constraints. The default value is true.

Declaration

[Parameter]
public bool Resizable { get; set; }

Property Value

Specifies the Size of the Window. See Medium.

Declaration

[Parameter]
public string Size { get; set; }

Property Value

Controls the Window's display state and behavior. Options include Default, Minimized, or Maximized for different presentation modes.

Declaration

[Parameter]
public WindowState State { get; set; }

Property Value

Fires when the State Parameter has changed.

Declaration

[Parameter]
public EventCallback<WindowState> StateChanged { get; set; }

Property Value

Applies a theme color to the Window titlebar for visual emphasis. Accepts theme color names like "primary", "secondary", "success", "warning", "error", or "info". The default value is string.Empty for standard header styling.

Declaration

[Parameter]
public string ThemeColor { get; set; }

Property Value

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

Declaration

[Parameter]
public string Top { get; set; }

Property Value

Fires when the top parameter has changed.

Declaration

[Parameter]
public EventCallback<string> TopChanged { get; set; }

Property Value

Controls whether the Window is visible and rendered in the DOM. Set to true to show the window or false to hide it. Can be used for initial visibility and runtime toggling. The default value is false.

Declaration

[Parameter]
public bool Visible { get; set; }

Property Value

Fires when the Visible Parameter has changed.

Declaration

[Parameter]
public EventCallback<bool> VisibleChanged { get; set; }

Property Value

Defines the width of the Window as a CSS value. Supports units like px, %, em, rem, or viewport units (e.g., "400px", "50%", "20em"). If not specified, the window uses content-based sizing.

Declaration

[Parameter]
public string Width { get; set; }

Property Value

Fires when the width parameter has changed.

Declaration

[Parameter]
public EventCallback<string> WidthChanged { get; set; }

Property Value

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. Children: WindowAction tags.

Declaration

[Parameter]
public RenderFragment WindowActions { get; set; }

Property Value

Defines the content of the Window.

Declaration

[Parameter]
public RenderFragment WindowContent { get; set; }

Property Value

Defines the footer content of the Window.

Declaration

[Parameter]
public RenderFragment WindowFooter { get; set; }

Property Value

Defines the title template of the Window.

Declaration

[Parameter]
public RenderFragment WindowTitle { get; set; }

Property Value

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Returns

Overrides BaseComponent.OnAfterRenderAsync(bool)

Declaration

protected override void OnInitialized()

Overrides ComponentBase.OnInitialized()

Declaration

protected override void OnParametersSet()

Overrides ComponentBase.OnParametersSet()

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

Declaration

public void Refresh()

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Returns

Overrides ComponentBase.SetParametersAsync(ParameterView)