Click or drag to resize

ForEachPlaceholder Class

Handler that begins a foreach template block. Closed by NextPlaceholder. The block is expanded for each object in the context.
Inheritance Hierarchy

Namespace:  MFiles.VAF.Placeholders.Commands
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.2.0.9
Syntax
C#
public class ForEachPlaceholder : BlockCommandHandler

The ForEachPlaceholder type exposes the following members.

Constructors
  NameDescription
Public methodForEachPlaceholder
Top
Properties
  NameDescription
Public propertyAcceptsContextTypes
The datatype this command handler accepts for the context when expanding.
(Overrides PlaceholderCommandHandlerAcceptsContextTypes.)
Public propertyClosedBlock
The block this handler's level's placeholder closed (if any).
(Inherited from BlockCommandHandler.)
Public propertyCommand
The level's command.
(Inherited from PlaceholderCommandHandler.)
Public propertyContextType
The datatype this command handler will output.
(Overrides PlaceholderCommandHandlerContextType.)
Protected propertyInitialized
Indicates whether the handler has been initialized.
(Inherited from PlaceholderCommandHandler.)
Public propertyIssues
Issues encountered during initialization.
(Inherited from PlaceholderCommandHandler.)
Public propertyLevel
The placeholder level this object is handling.
(Inherited from PlaceholderCommandHandler.)
Public propertyOpenedBlock
The block this handler's level's placeholder opened (if any).
(Inherited from BlockCommandHandler.)
Public propertyParameter
The level's parameter.
(Inherited from PlaceholderCommandHandler.)
Public propertySettings
The level's parse and expansion settings.
(Inherited from PlaceholderCommandHandler.)
Protected propertySupportedTypes
The level types supported by this handler.
(Overrides PlaceholderCommandHandlerSupportedTypes.)
Public propertyVault
The level's vault.
(Inherited from PlaceholderCommandHandler.)
Top
Methods
  NameDescription
Protected methodClassVisibleToUser
Determines if the ObjectClass is visible to the current user session.
(Inherited from PlaceholderCommandHandler.)
Public methodClosesBlock
Determines if this command can close a block.
(Inherited from BlockCommandHandler.)
Public methodExpand
Expands this node in the given context.
(Overrides PlaceholderCommandHandlerExpand(IExpansionContext, ObjVerExReadCache).)
Public methodGetResolvedStructureReferences
Provides all structure references that exist and were resolved in this placeholder level.
(Inherited from PlaceholderCommandHandler.)
Public methodInit
Initializes the handler for a specific placeholder level. Sets the level, and performs base validation and kicks off custom initialization.
(Inherited from PlaceholderCommandHandler.)
Protected methodInitialize
Performs custom initialization.
(Overrides PlaceholderCommandHandlerInitialize.)
Protected methodObjTypeVisibleToUser
Determines if the ObjType is visible to the current user session.
(Inherited from PlaceholderCommandHandler.)
Public methodOpensBlock
Determines if this command starts a new block.
(Overrides BlockCommandHandlerOpensBlock.)
Protected methodPropertyVisibleToUser
Determines if the PropertyDef is visible to the current user session.
(Inherited from PlaceholderCommandHandler.)
Protected methodValueListItemVisibleToUser
Determines if the ObjectClass is visible to the current user session.
(Inherited from PlaceholderCommandHandler.)
Top
See Also