ClassTelerikWindow
The class for the Telerik Window component.
Definition
Namespace:Telerik.Blazor.Components
Assembly:Telerik.Blazor.dll
Syntax:
public class TelerikWindow : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Inheritance: objectComponentBaseBaseComponentTelerikWindow
Implements:
Inherited Members
Constructors
TelerikWindow()
Declaration
public TelerikWindow()
Properties
CloseOnOverlayClick
Defines if the window should close when the user clicks or taps on the modal overlay click.
Declaration
[Parameter]
public bool CloseOnOverlayClick { get; set; }
Property Value
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
[Parameter]
public string ContainmentSelector { get; set; }
Property Value
Draggable
Defines if the window should be draggable through the titlebar.
The default value is true
.
FooterLayoutAlign
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
Height
Defines the height of the Window as a CSS value.
HeightChanged
Fires when the height parameter has changed.
Declaration
[Parameter]
public EventCallback<string> HeightChanged { get; set; }
Property Value
Id
The id of the window HTML element.
Left
Defines the left position of the Window relative to the viewport (where the TelerikRootComponent is declared). See Dimensions.
LeftChanged
Fires when the left parameter has changed.
Declaration
[Parameter]
public EventCallback<string> LeftChanged { get; set; }
Property Value
MaxHeight
Defines the max height of the Window as a CSS value.
Declaration
[Parameter]
public string MaxHeight { get; set; }
Property Value
MaxWidth
Defines the max width of the Window as a CSS value.
Declaration
[Parameter]
public string MaxWidth { get; set; }
Property Value
MinHeight
Defines the min height of the Window as a CSS value.
Declaration
[Parameter]
public string MinHeight { get; set; }
Property Value
MinWidth
Defines the min width of the Window as a CSS value.
Declaration
[Parameter]
public string MinWidth { get; set; }
Property Value
Modal
Specifies if the Window is modal. See Modal Window.
The default value is false
.
PersistContent
Defines if the content should be persisted when the window is minimized.
Declaration
[Parameter]
public bool PersistContent { get; set; }
Property Value
Resizable
Defines if the window should be resizable.
The default value is true
.
State
Defines the state of the Window. To be rendered minimized, maximized or in default state.
Declaration
[Parameter]
public WindowState State { get; set; }
Property Value
StateChanged
Fires when the State Parameter has changed.
Declaration
[Parameter]
public EventCallback<WindowState> StateChanged { get; set; }
Property Value
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
[Parameter]
public string ThemeColor { get; set; }
Property Value
Top
Defines the top position of the Window relative to the viewport (where the TelerikRootComponent is declared). See Dimensions.
TopChanged
Fires when the top parameter has changed.
Declaration
[Parameter]
public EventCallback<string> TopChanged { get; set; }
Property Value
Visible
Defines whether the Window is rendered. Can define initial visibility and toggle visibility at runtime.
The default value is false
.
VisibleChanged
Fires when the Visible Parameter has changed.
Declaration
[Parameter]
public EventCallback<bool> VisibleChanged { get; set; }
Property Value
Width
Defines the width of the Window as a CSS value.
WidthChanged
Fires when the width parameter has changed.
Declaration
[Parameter]
public EventCallback<string> WidthChanged { get; set; }
Property Value
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
[Parameter]
public RenderFragment WindowActions { get; set; }
Property Value
WindowContent
Defines the content of the Window.
Declaration
[Parameter]
public RenderFragment WindowContent { get; set; }
Property Value
WindowFooter
Defines the footer content of the Window.
Declaration
[Parameter]
public RenderFragment WindowFooter { get; set; }
Property Value
WindowTitle
Defines the title template of the Window.
Declaration
[Parameter]
public RenderFragment WindowTitle { get; set; }
Property Value
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
__builder
Overrides
OnInitialized()
Declaration
protected override void OnInitialized()
Overrides
OnParametersSet()
Declaration
protected override void OnParametersSet()
Overrides
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
parameters
Returns
Overrides