Click or drag to resize

ReferenceTreeMFDynamicIdentifier Class

Inheritance Hierarchy
SystemObject
  MFiles.VAF.ConfigurationMFIdentifier
    MFiles.VAF.CommonReferenceTreeMFDynamicIdentifier

Namespace:  MFiles.VAF.Common
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.1.0.1 (2.1.0.1)
Syntax
C#
public class MFDynamicIdentifier : MFIdentifier

The ReferenceTreeMFDynamicIdentifier type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAlias
Alias string. Setting this will clear the resolved ID value.
(Inherited from MFIdentifier.)
Public propertyEmpty
Is this MFIdentifier empty == unset value. Use IsEmpty.
(Inherited from MFIdentifier.)
Public propertyGuid
GUID if original string value was valid GUID, else empty string. AsOfNow the Alias will also return valid GUID, this might change in the future.
(Inherited from MFIdentifier.)
Public propertyGUID Obsolete.
Alias for the Guid member.
(Inherited from MFIdentifier.)
Public propertyID
ID integer.
(Inherited from MFIdentifier.)
Public propertyIsEmpty
Indicates if the identifier is not set, or set to empty.
(Inherited from MFIdentifier.)
Public propertyIsGuid
Indicates if the set identifier is valid GUID format.
(Inherited from MFIdentifier.)
Public propertyIsIDAvailable
Indicates if there is a valid ID value available (even if it wasn't resolved). Returns true if the id has been resolved, or if the identifier was set with an id or ObjID and the id isn't considered unresolved (-1).
(Inherited from MFIdentifier.)
Public propertyIsObjID
Indicates if the identifier is valid ObjID format.
(Inherited from MFIdentifier.)
Public propertyIsObjVer
Indicates if the identifier is valid ObjVer format.
(Inherited from MFIdentifier.)
Public propertyIsReference
True when this object is a dynamic reference. False when the value is a non-lookup type.
Public propertyIsResolved
Indicates if the set identifier is already resolved.
(Inherited from MFIdentifier.)
Public propertyObjID
The ObjID of the item. Only relevant for ValueListItems and ObjIDs.
(Inherited from MFIdentifier.)
Public propertyResolved
Is this identifier is resolved to valid ID. Use IsResolved.
(Inherited from MFIdentifier.)
Public propertyResolvedType
The type which the identifier was resolved as. Null if the identifier is not resolved.
(Inherited from MFIdentifier.)
Protected propertyUnresolvedID
Value of unresolved ID used as "error-value" (for this structure type).
(Inherited from MFIdentifier.)
Public propertyUnsafeID
Returns an ID value if available (even if it wasn't resolved). The ID is available if it has been resolved, or if the identifier was set with an id or ObjID and the id isn't considered unresolved (-1). It is unsafe because it hasn't necessary been resolved (verified to exist) in the current vault.
(Inherited from MFIdentifier.)
Public propertyValueList
The value list related to the resolved id (if relevant)
(Inherited from MFIdentifier.)
Top
Methods
  NameDescription
Protected method_Resolve
Internal resolving method.
(Inherited from MFIdentifier.)
Public methodEquals(Object)
Equality with any other object.
(Inherited from MFIdentifier.)
Public methodEquals(MFIdentifier)
Equality of two MFIdentifiers. For resolved identifiers, type and ID must match. If either one is unresolved, aliases or original ids must match.
(Inherited from MFIdentifier.)
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
Get Hash Code.
(Inherited from MFIdentifier.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodResolve(Vault, ObjVer, PropertyValues)
Dynamic Type Resolver.
Public methodResolve(Vault, Type, Boolean)
Update this MFIdentifier to contain resolved ID of the alias, if it is not already resolved. Returns itself to allow command chaining.
(Inherited from MFIdentifier.)
Public methodResolve(Vault, Type, Int32, Boolean)
Update this MFIdentifier to contain resolved ID of the alias, if it is not already resolved. Returns itself to allow command chaining.
(Inherited from MFIdentifier.)
Public methodSet
Helper function able to set the identifier value to almost any object type. Accepts MFIdentifier, string, int, enum, and other that cast to string. Returns itself to allow command chaining.
(Inherited from MFIdentifier.)
Public methodSetAsID
Indicates whether the MFIdentifier was intially set as an id. Allows serialization to match deserialized values, or to skip resolution.
(Inherited from MFIdentifier.)
Public methodShouldSerializeAlias
Method deciding should we include Alias into serialization output. Yes when we have an alias.
(Inherited from MFIdentifier.)
Public methodShouldSerializeID
Method deciding should we include ID into serialization output. Yes only when we dont have an alias.
(Inherited from MFIdentifier.)
Public methodToString
Returns this instance of Alias value, if not avail, returns string of ID.
(Overrides MFIdentifierToString.)
Top
Operators
Fields
  NameDescription
Protected fieldSetAs
Internal information keeping track which type of value was set into this identifier.
(Inherited from MFIdentifier.)
Protected fieldtype
Last used target type.
(Inherited from MFIdentifier.)
Top
See Also