PlaceholderCommandHandler Class

Abstract implementation of a Placeholder Command Handler used to validate and expand a placeholder level command.

Definition

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

Constructors

Properties

AcceptsContextTypes The datatype this command handler accepts for the context when expanding.
Command The level's command.
ContextType The datatype this command handler will output.
DefaultClientCommandGenerator  
Initialized Indicates whether the handler has been initialized.
Issues Issues encountered during initialization.
Level The placeholder level this object is handling.
Parameter The level's parameter.
Settings The level's parse and expansion settings.
SupportedTypes Hint to base validation about which types are supported. If null or empty, all formats are considered valid.
Vault The level's vault.

Methods

ClassVisibleToUser Determines if the ObjectClass is visible to the current user session.
Expand Expands the placeholder level based on the given context.
GetClientCommandGenerator  
GetClientDefinitions  
GetResolvedStructureReferences Provides all structure references that exist and were resolved in this placeholder level.
GetSupportedTypes  
Init Initializes the handler for a specific placeholder level. Sets the level, and performs base validation and kicks off custom initialization.
Initialize Performs custom initialization.
ObjTypeVisibleToUser Determines if the ObjType is visible to the current user session.
PropertyVisibleToUser Determines if the PropertyDef is visible to the current user session.
ValueListItemVisibleToUser Determines if the ObjectClass is visible to the current user session.

See Also