DialogContainer Class

Reference

Definition

Namespace:: Microsoft.Bot.Builder.Dialogs

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

Package:: Microsoft.Bot.Builder.Dialogs v4.22.7

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A container for a set of Dialogs.

public abstract class DialogContainer : Microsoft.Bot.Builder.Dialogs.Dialog

type DialogContainer = class
    inherit Dialog

Public MustInherit Class DialogContainer
Inherits Dialog

Inheritance: Object

Dialog
DialogContainer

Derived: Microsoft.Bot.Builder.Dialogs.Adaptive.Actions.ForEachElement

Microsoft.Bot.Builder.Dialogs.Adaptive.AdaptiveDialog

Microsoft.Bot.Builder.Dialogs.ComponentDialog

Constructors

DialogContainer(Boolean, String)	Initializes a new instance of the DialogContainer class.
DialogContainer(String)	Initializes a new instance of the DialogContainer class.

Properties

Dialogs	Gets or sets the containers DialogSet.
Id	Gets or sets id for the dialog. (Inherited from Dialog)
IgnoreMemoryScopeBinding	Gets or sets a value indicating whether or not this DialogContainer should interact with Memory Scopes.
Source	Gets the information of the cref="SourceRange"/>. (Inherited from Dialog)
TelemetryClient	Gets or sets the IBotTelemetryClient to use for logging. When setting this property, all of the contained dialogs' TelemetryClient properties are also set.

Methods

BeginDialogAsync(DialogContext, Object, CancellationToken)	Called when the dialog is started and pushed onto the dialog stack. (Inherited from Dialog)
CheckForVersionChangeAsync(DialogContext, CancellationToken)	CheckForVersionChangeAsync.
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)
CreateChildContext(DialogContext)	Creates an inner dialog context for the containers active child.
EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)	Called when the dialog is ending. (Inherited from Dialog)
FindDialog(String, DialogContext)	Finds a child dialog that was previously added to the container. Uses DialogContext as fallback to gather the dialog.
FindDialog(String)	Finds a child dialog that was previously added to the container.
GetInternalVersion()	GetInternalVersion - Returns internal version identifier for this container.
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()	Builds the compute Id for the 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.
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

Share via