New to Kendo UI for AngularStart a free 30-day trial

DialogRef

Holds references to the object instance and published events of the Dialog. Controls the Dialogs that were opened through the DialogService (see example).

NameTypeDefaultDescription

close

Function

Closes the Dialog programmatically.

When called without a value, the result Observable emits an empty DialogCloseResult object.

When called with a value, the result Observable emits the provided value.

Usage Examples:

typescript
// Close without arguments: Returns an empty `DialogCloseResult` object.
dialogRef.close();

// Simulate clicking an action button: Pass a `DialogAction` object.
dialogRef.close({ text: 'OK', primary: true });

// Return custom data: Pass a custom object.
dialogRef.close({ success: true, data: { id: 123 } });

content

ComponentRef<any>

A reference to the child component of the Dialog. Available when the Dialog is opened with component content.

dialog

ComponentRef<DialogComponent>

A reference to the Dialog instance.

result

Observable<DialogResult>

Emits events when the Dialog is closed either through the Close button of the title bar or through the action buttons. If the Close button of the title bar is clicked, DialogResult is a DialogCloseResult instance. If the Dialog is closed through the action buttons, DialogResult contains the object that was passed when the Dialog was opened. When close is called with an argument, the result is the passed argument.

Constructors

DialogRef

()

In this article
ConstructorsDialogRef
Not finding the help you need?
Contact Support