ForEachPlaceholder Class |
Handler that begins a foreach template block. Closed by NextPlaceholder.
The block is expanded for each object in the context.
Inheritance HierarchySystemObject
MFiles.VAF.PlaceholdersPlaceholderCommandHandler
MFiles.VAF.PlaceholdersBlockCommandHandler
MFiles.VAF.Placeholders.CommandsForEachPlaceholder
MFiles.VAF.PlaceholdersPlaceholderCommandHandler
MFiles.VAF.PlaceholdersBlockCommandHandler
MFiles.VAF.Placeholders.CommandsForEachPlaceholder
Namespace: MFiles.VAF.Placeholders.Commands
Assembly: MFiles.VAF (in MFiles.VAF.dll) Version: 2.3.623.2
SyntaxThe ForEachPlaceholder type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ForEachPlaceholder | Initializes a new instance of the ForEachPlaceholder class |
Properties| Name | Description | |
|---|---|---|
 | AcceptsContextTypes |
The datatype this command handler accepts for the context when expanding.
(Overrides PlaceholderCommandHandlerAcceptsContextTypes.) |
| ClosedBlock |
The block this handler's level's placeholder closed (if any).
(Inherited from BlockCommandHandler.) |
| Command |
The level's command.
(Inherited from PlaceholderCommandHandler.) |
| ContextType |
The datatype this command handler will output.
(Overrides PlaceholderCommandHandlerContextType.) |
 | Initialized |
Indicates whether the handler has been initialized.
(Inherited from PlaceholderCommandHandler.) |
| Issues |
Issues encountered during initialization.
(Inherited from PlaceholderCommandHandler.) |
| Level |
The placeholder level this object is handling.
(Inherited from PlaceholderCommandHandler.) |
| OpenedBlock |
The block this handler's level's placeholder opened (if any).
(Inherited from BlockCommandHandler.) |
| Parameter |
The level's parameter.
(Inherited from PlaceholderCommandHandler.) |
| Settings |
The level's parse and expansion settings.
(Inherited from PlaceholderCommandHandler.) |
| SupportedTypes |
The level types supported by this handler.
(Overrides PlaceholderCommandHandlerSupportedTypes.) |
| Vault |
The level's vault.
(Inherited from PlaceholderCommandHandler.) |
Methods| Name | Description | |
|---|---|---|
 | ClassVisibleToUser |
Determines if the ObjectClass is visible to the current user session.
(Inherited from PlaceholderCommandHandler.) |
| ClosesBlock |
Determines if this command can close a block.
(Inherited from BlockCommandHandler.) |
| Expand |
Expands this node in the given context.
(Overrides PlaceholderCommandHandlerExpand(IExpansionContext, ObjVerExReadCache).) |
| GetResolvedStructureReferences |
Provides all structure references that exist and were resolved in this placeholder level.
(Inherited from PlaceholderCommandHandler.) |
| Init |
Initializes the handler for a specific placeholder level.
Sets the level, and performs base validation and kicks off custom initialization.
(Inherited from PlaceholderCommandHandler.) |
| Initialize |
Performs custom initialization.
(Overrides PlaceholderCommandHandlerInitialize.) |
| ObjTypeVisibleToUser |
Determines if the ObjType is visible to the current user session.
(Inherited from PlaceholderCommandHandler.) |
| OpensBlock |
Determines if this command starts a new block.
(Overrides BlockCommandHandlerOpensBlock.) |
| PropertyVisibleToUser |
Determines if the PropertyDef is visible to the current user session.
(Inherited from PlaceholderCommandHandler.) |
| ValueListItemVisibleToUser |
Determines if the ObjectClass is visible to the current user session.
(Inherited from PlaceholderCommandHandler.) |
See Also