Share via


ForEachElement Class

Definition

Executes a set of actions once for each item in an in-memory list or collection.

public class ForEachElement : Microsoft.Bot.Builder.Dialogs.DialogContainer, Microsoft.Bot.Builder.Dialogs.IDialogDependencies
type ForEachElement = class
    inherit DialogContainer
    interface IDialogDependencies
Public Class ForEachElement
Inherits DialogContainer
Implements IDialogDependencies
Inheritance
ForEachElement
Implements

Constructors

ForEachElement(IEnumerable<Dialog>)

Initializes a new instance of the ForEachElement class.

Fields

Kind

Class identifier.

Properties

Actions

Gets or sets the actions to execute.

Dialogs

Gets or sets the containers DialogSet.

(Inherited from DialogContainer)
Disabled

Gets or sets an optional expression which if is true will disable this action.

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.

(Inherited from DialogContainer)
Index

Gets or sets property path expression to item index.

ItemsProperty

Gets or sets property path expression to the collection of items.

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.

(Inherited from DialogContainer)
Value

Gets or sets property path expression to item value.

Methods

BeginDialogAsync(DialogContext, Object, CancellationToken)

Called when the dialog is started and pushed onto the dialog stack.

CheckForVersionChangeAsync(DialogContext, CancellationToken)

CheckForVersionChangeAsync.

(Inherited from DialogContainer)
ContinueDialogAsync(DialogContext, CancellationToken)

Called when the dialog is continued, where it is the active dialog and the user replies with a new activity.

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.

(Inherited from DialogContainer)
FindDialog(String)

Finds a child dialog that was previously added to the container.

(Inherited from DialogContainer)
GetDependencies()

Enumerates child dialog dependencies so they can be added to the containers dialog set.

GetInternalVersion()

GetInternalVersion - Returns internal version identifier for this container.

(Inherited from DialogContainer)
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.

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