Class
TelerikDialog

The class for the TelerikDialog component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class TelerikDialog : DialogBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentDialogBaseTelerikDialog

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members DialogBase.ThemeColorBaseComponent.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.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)

Constructors

TelerikDialog()

Declaration

cs-api-definition
public TelerikDialog()

Properties

ButtonsLayout

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

Declaration

cs-api-definition
[Parameter]
public DialogButtonsLayout ButtonsLayout { get; set; }

Property Value

DialogButtonsLayout

CloseOnOverlayClick

Defines if the Dialog should close when the user clicks on the modal page overlay.

Declaration

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

Property Value

bool

DialogButtons

Configure the Dialog Buttons inside the TelerikDialog tag.

Declaration

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

Property Value

RenderFragment

DialogContent

Defines the RenderFragment to be displayed inside the Dialog.

Declaration

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

Property Value

RenderFragment

DialogTitle

Defines the RenderFragment to be displayed instead of the default Dialog Title.

Declaration

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

Property Value

RenderFragment

FocusedElementSelector

Defines the query selector of the auto focusable element in the dialog.

Declaration

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

Property Value

string

Height

Defines the height of the Dialog in any supported CSS unit.

Declaration

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

Property Value

string

ShowCloseButton

Defines if the Dialog should render a close button in the header. The default value is "true".

Declaration

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

Property Value

bool

Title

Defines the title of the Dialog. Default value is null.

Declaration

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

Property Value

string

Visible

Defines if the dialog is rendered. Use the parameter to define initial visibility and toggle visibility at runtime.

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 Dialog in any supported CSS unit.

Declaration

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

Property Value

string

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)

OnParametersSetAsync()

Declaration

cs-api-definition
protected override Task OnParametersSetAsync()

Returns

Task

Overrides ComponentBase.OnParametersSetAsync()

Refresh()

Refreshes the dialog content.

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)