CancelDialog Class

Definition

Namespace:: Microsoft.Bot.Builder.Dialogs.Adaptive.Actions

Assembly:: Microsoft.Bot.Builder.Dialogs.Adaptive.dll

Package:: Microsoft.Bot.Builder.Dialogs.Adaptive v4.11.1

Command to cancel all of the current dialogs by emitting an event which must be caught to prevent cancelation from propagating.

public class CancelDialog : Microsoft.Bot.Builder.Dialogs.Adaptive.Actions.CancelAllDialogsBase

type CancelDialog = class
    inherit CancelAllDialogsBase

Public Class CancelDialog
Inherits CancelAllDialogsBase

Inheritance: Object

Dialog

CancelAllDialogsBase
CancelDialog

Constructors

CancelDialog(String, Int32)

Initializes a new instance of the CancelDialog class.

Fields

Kind	Class identifier.

Properties

ActivityProcessed	Gets or sets a value indicating whether to have the calling dialog should process the activity. (Inherited from CancelAllDialogsBase)
Disabled	Gets or sets an optional expression which if is true will disable this action. (Inherited from CancelAllDialogsBase)
EventName	Gets or sets event name. (Inherited from CancelAllDialogsBase)
EventValue	Gets or sets value expression for EventValue. (Inherited from CancelAllDialogsBase)
Id	Gets or sets id for the dialog. (Inherited from Dialog)
Source	Gets the information of the cref="SourceRange"/>. (Inherited from Dialog)
TelemetryClient	Gets or sets the IBotTelemetryClient to use for logging. (Inherited from Dialog)

Methods

BeginDialogAsync(DialogContext, Object, CancellationToken)	Called when the dialog is started and pushed onto the dialog stack. (Inherited from CancelAllDialogsBase)
ContinueDialogAsync(DialogContext, CancellationToken)	Called when the dialog is continued, where it is the active dialog and the user replies with a new activity. (Inherited from Dialog)
EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)	Called when the dialog is ending. (Inherited from Dialog)
GetVersion()	Gets a unique string which represents the version of this dialog. If the version changes between turns the dialog system will emit a DialogChanged event. (Inherited from Dialog)
OnComputeId()	Computes an unique ID for a dialog. (Inherited from Dialog)
OnDialogEventAsync(DialogContext, DialogEvent, CancellationToken)	Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. (Inherited from Dialog)
OnPostBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)	Called after an event was bubbled to all parents and wasn't handled. (Inherited from Dialog)
OnPreBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)	Called before an event is bubbled to its parent. (Inherited from Dialog)
RegisterSourceLocation(String, Int32)	Registers a cref="SourceRange"/> in the provided location. (Inherited from Dialog)
RepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken)	Called when the dialog should re-prompt the user for input. (Inherited from Dialog)
ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken)	Called when a child dialog completed this turn, returning control to this dialog. (Inherited from Dialog)

Extension Methods

RunAsync(Dialog, ITurnContext, IStatePropertyAccessor<DialogState>, CancellationToken)

Creates a dialog stack and starts a dialog, pushing it onto the stack.

Applies to