Click or drag to resize

RelationshipPlaceholder Class

Expands to objects related to the context object.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.PlaceholdersPlaceholderCommandHandler
    MFiles.VAF.Placeholders.CommandsRelationshipPlaceholder

Namespace:  MFiles.VAF.Placeholders.Commands
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.1.0.1 (2.1.0.1)
Syntax
C#
public class RelationshipPlaceholder : PlaceholderCommandHandler, 
	IClonablePlaceholderCommandHandler

The RelationshipPlaceholder type exposes the following members.

Constructors
  NameDescription
Public methodRelationshipPlaceholder
Constructor.
Top
Properties
  NameDescription
Public propertyAcceptsContextTypes
The datatype this command handler accepts for the context when expanding.
(Overrides PlaceholderCommandHandlerAcceptsContextTypes.)
Public propertyClass
The filtering Class definition.
Public propertyCommand
The level's command.
(Inherited from PlaceholderCommandHandler.)
Public propertyContextType
The datatype this command handler will output.
(Overrides PlaceholderCommandHandlerContextType.)
Public propertyFilter
The filter id if present and resolved.
Public propertyFilterType
The filter type to pass to MFIdentifier for filter reference resolution.
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 propertyMode
The relationship mode for expansion.
Public propertyObjType
The filtering ObjType definition.
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 methodClone
Clones the placeholder.
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.
(Overrides PlaceholderCommandHandlerExpand(IExpansionContext, ObjVerExReadCache).)
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 methodStatic memberGetProvider
Creates a provider for this command with the specified parameters.
Public methodGetResolvedStructureReferences
Provides all structure references that exist and were resolved in this placeholder level.
(Overrides PlaceholderCommandHandlerGetResolvedStructureReferences.)
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.
(Inherited from PlaceholderCommandHandler.)
Protected methodInitialize
Performs custom initialization.
(Overrides PlaceholderCommandHandlerInitialize.)
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.
(Inherited from PlaceholderCommandHandler.)
Protected methodPropertyVisibleToUser
Determines if the PropertyDef is visible to the current user session.
(Inherited from PlaceholderCommandHandler.)
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.
(Inherited from PlaceholderCommandHandler.)
Top
See Also