Class IgbDialog

Represents a Dialog component.

Inheritance
System.Object
BaseRendererControl
IgbDialog
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbDialog : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbDialog()

Declaration
public IgbDialog()

Properties

Closed

Declaration
public EventCallback<IgbVoidEventArgs> Closed { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

ClosedScript

Declaration
public string ClosedScript { get; set; }
Property Value
Type Description
System.String

CloseOnOutsideClick

Whether the dialog should be closed when clicking outside of it.

Declaration
public bool CloseOnOutsideClick { get; set; }
Property Value
Type Description
System.Boolean

Closing

Declaration
public EventCallback<IgbVoidEventArgs> Closing { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

ClosingScript

Declaration
public string ClosingScript { get; set; }
Property Value
Type Description
System.String

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides

DirectRenderElementName

Declaration
protected override string DirectRenderElementName { get; }
Property Value
Type Description
System.String
Overrides

HideDefaultAction

Whether to hide the default action button for the dialog. When there is projected content in the footer slot this property has no effect.

Declaration
public bool HideDefaultAction { get; set; }
Property Value
Type Description
System.Boolean

KeepOpenOnEscape

Whether the dialog should be kept open when pressing the 'Escape' button.

Declaration
public bool KeepOpenOnEscape { get; set; }
Property Value
Type Description
System.Boolean

Open

Whether the dialog is opened.

Declaration
public bool Open { get; set; }
Property Value
Type Description
System.Boolean

ReturnValue

Sets the return value for the dialog.

Declaration
public string ReturnValue { get; set; }
Property Value
Type Description
System.String

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

Title

Sets the title of the dialog.

Declaration
public string Title { get; set; }
Property Value
Type Description
System.String

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UseDirectRender

Declaration
protected override bool UseDirectRender { get; }
Property Value
Type Description
System.Boolean
Overrides

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

Hide()

Declaration
public bool Hide()
Returns
Type Description
System.Boolean

HideAsync()

Closes the dialog.

Declaration
public Task<bool> HideAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

ResolveDisplay()

Declaration
protected override string ResolveDisplay()
Returns
Type Description
System.String
Overrides

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

Show()

Declaration
public bool Show()
Returns
Type Description
System.Boolean

ShowAsync()

Opens the dialog.

Declaration
public Task<bool> ShowAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Toggle()

Declaration
public bool Toggle()
Returns
Type Description
System.Boolean

ToggleAsync()

Toggles the open state of the dialog.

Declaration
public Task<bool> ToggleAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Implements

System.IDisposable