Click or drag to resize

PlaceholderCommandHandler Class

Abstract implementation of a Placeholder Command Handler used to validate and expand a placeholder level command.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.PlaceholdersPlaceholderCommandHandler
    More...

Namespace:  MFiles.VAF.Placeholders
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.1.0.1 (2.1.0.1)
Syntax
C#
public abstract class PlaceholderCommandHandler : IPlaceholderCommandHandler

The PlaceholderCommandHandler type exposes the following members.

Constructors
  NameDescription
Protected methodPlaceholderCommandHandler
Initializes a new instance of the PlaceholderCommandHandler class
Top
Properties
  NameDescription
Public propertyAcceptsContextTypes
The datatype this command handler accepts for the context when expanding.
Public propertyCommand
The level's command.
Public propertyContextType
The datatype this command handler will output.
Protected propertyInitialized
Indicates whether the handler has been initialized.
Public propertyIssues
Issues encountered during initialization.
Public propertyLevel
The placeholder level this object is handling.
Public propertyParameter
The level's parameter.
Public propertySettings
The level's parse and expansion settings.
Protected propertySupportedTypes
Hint to base validation about which types are supported. If null or empty, all formats are considered valid.
Public propertyVault
The level's vault.
Top
Methods
  NameDescription
Protected methodClassVisibleToUser
Determines if the ObjectClass is visible to the current user session.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExpand
Expands the placeholder level based on the given context.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetResolvedStructureReferences
Provides all structure references that exist and were resolved in this placeholder level.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInit
Initializes the handler for a specific placeholder level. Sets the level, and performs base validation and kicks off custom initialization.
Protected methodInitialize
Performs custom initialization.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodObjTypeVisibleToUser
Determines if the ObjType is visible to the current user session.
Protected methodPropertyVisibleToUser
Determines if the PropertyDef is visible to the current user session.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodValueListItemVisibleToUser
Determines if the ObjectClass is visible to the current user session.
Top
See Also
Inheritance Hierarchy
SystemObject
  MFiles.VAF.PlaceholdersPlaceholderCommandHandler
    MFiles.VAF.PlaceholdersBlockCommandHandler
    MFiles.VAF.Placeholders.CommandsCountPlaceholder
    MFiles.VAF.Placeholders.CommandsCurrentContextPlaceholder
    MFiles.VAF.Placeholders.CommandsDaysAgoPlaceholder
    MFiles.VAF.Placeholders.CommandsDaysUntilPlaceholder
    MFiles.VAF.Placeholders.CommandsEncodingPlaceholderCommandHandler
    MFiles.VAF.Placeholders.CommandsFileNamesPlaceholder
    MFiles.VAF.Placeholders.CommandsFirstVersionPlaceholder
    MFiles.VAF.Placeholders.CommandsInternalIDPlaceholder
    MFiles.VAF.Placeholders.CommandsObjIDPlaceholder
    MFiles.VAF.Placeholders.CommandsObjTypeIDPlaceholder
    MFiles.VAF.Placeholders.CommandsObjTypePlaceholder
    MFiles.VAF.Placeholders.CommandsParentPlaceholder
    MFiles.VAF.Placeholders.CommandsPreviousVersionPlaceholder
    MFiles.VAF.Placeholders.CommandsPropertyPlaceholder
    MFiles.VAF.Placeholders.CommandsRelationshipPlaceholder
    MFiles.VAF.Placeholders.CommandsRequirePlaceholder
    MFiles.VAF.Placeholders.CommandsSimpleObjectToTextPlaceholderBase
    MFiles.VAF.Placeholders.CommandsSpecificVersionPlaceholder
    MFiles.VAF.Placeholders.CommandsStaticContextPlaceholder
    MFiles.VAF.Placeholders.CommandsToDatePlaceholder
    MFiles.VAF.Placeholders.CommandsTodayPlaceholder
    MFiles.VAF.Placeholders.CommandsUniquePlaceholder
    MFiles.VAF.Placeholders.CommandsUnknownPlaceholder
    MFiles.VAF.Placeholders.CommandsUserCausedWorkflowStatePlaceholder
    MFiles.VAF.Placeholders.CommandsVaultGuidPlaceholder
    MFiles.VAF.Placeholders.CommandsVaultNamePlaceholder