MFilesUrlPlaceholder Class

Expands to an M-Files URL that shows the latest version of the object in question.

Definition

Namespace: MFiles.VAF.Placeholders.Commands
Assembly: MFiles.VAF (in MFiles.VAF.dll) Version: 24.1.706.1
C#
public class MFilesUrlPlaceholder : SimpleObjectToTextPlaceholderBase
Inheritance
Object    PlaceholderCommandHandler    SimpleObjectToTextPlaceholderBase    MFilesUrlPlaceholder

Constructors

MFilesUrlPlaceholder Constructor.

Properties

AcceptsContextTypes The datatype this command handler accepts for the context when expanding.
(Inherited from SimpleObjectToTextPlaceholderBase)
Command The level's command.
(Inherited from PlaceholderCommandHandler)
ContextType The datatype this command handler will output.
(Inherited from SimpleObjectToTextPlaceholderBase)
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)
LoadObjects Indicates whether the objects should be preloaded before passed to the GetObjectText() method.
(Overrides SimpleObjectToTextPlaceholderBaseLoadObjects)
Parameter The level's parameter.
(Inherited from PlaceholderCommandHandler)
Platform The platform the url should target.
Settings The level's parse and expansion settings.
(Inherited from PlaceholderCommandHandler)
SpecificVersion Indicates if the generated URL's will point to a specific version of the object, or the latest.
SupportedTypes The level types supported by this handler.
(Inherited from SimpleObjectToTextPlaceholderBase)
UrlType Indicates the behavior of the generated url.
Vault The level's vault.
(Inherited from PlaceholderCommandHandler)

Methods

ClassVisibleToUser Determines if the ObjectClass is visible to the current user session.
(Inherited from PlaceholderCommandHandler)
Expand Expands the placeholder level based on the given context.
(Inherited from SimpleObjectToTextPlaceholderBase)
GetClientCommandGenerator
(Inherited from PlaceholderCommandHandler)
GetClientDefinitions
(Inherited from PlaceholderCommandHandler)
GetObjectText Expands an object to a text value.
(Overrides SimpleObjectToTextPlaceholderBaseGetObjectText(ObjVerEx))
GetProvider  
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 SimpleObjectToTextPlaceholderBase)
ObjTypeVisibleToUser Determines if the ObjType is visible to the current user session.
(Inherited from PlaceholderCommandHandler)
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