BlockCommandHandler Class

The base handler for placeholders that open or close template blocks .

Definition

Namespace: MFiles.VAF.Placeholders
Assembly: MFiles.VAF (in MFiles.VAF.dll) Version: 24.1.706.1
C#
public abstract class BlockCommandHandler : PlaceholderCommandHandler
Inheritance
Object    PlaceholderCommandHandler    BlockCommandHandler
Derived

Constructors

Properties

AcceptsContextTypes The datatype this command handler accepts for the context when expanding.
(Inherited from PlaceholderCommandHandler)
ClosedBlock The block this handler's level's placeholder closed (if any).
Command The level's command.
(Inherited from PlaceholderCommandHandler)
ContextType The datatype this command handler will output.
(Inherited from PlaceholderCommandHandler)
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).
Parameter The level's parameter.
(Inherited from PlaceholderCommandHandler)
Settings The level's parse and expansion settings.
(Inherited from PlaceholderCommandHandler)
SupportedTypes Hint to base validation about which types are supported. If null or empty, all formats are considered valid.
(Inherited from PlaceholderCommandHandler)
Vault The level's vault.
(Inherited from PlaceholderCommandHandler)

Methods

ClassVisibleToUser Determines if the ObjectClass is visible to the current user session.
(Inherited from PlaceholderCommandHandler)
ClosesBlock Determines if this command can close a block.
Expand Expands the placeholder level based on the given context.
(Inherited from PlaceholderCommandHandler)
GetClientCommandGenerator
(Inherited from PlaceholderCommandHandler)
GetClientDefinitions
(Inherited from PlaceholderCommandHandler)
GetResolvedStructureReferences Provides all structure references that exist and were resolved in this placeholder level.
(Inherited from PlaceholderCommandHandler)
GetSupportedTypes
(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.
(Inherited from PlaceholderCommandHandler)
ObjTypeVisibleToUser Determines if the ObjType is visible to the current user session.
(Inherited from PlaceholderCommandHandler)
OpensBlock Determines if this command starts a new block.
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