Click or drag to resize

BCVaultLink Class

Represents an object that manages the connection to a vault.
Inheritance Hierarchy

Namespace:  BlueCieloECM.InnoCielo.Meridian.Client
Assembly:  BlueCieloECM.InnoCielo.Meridian (in BlueCieloECM.InnoCielo.Meridian.dll) Version: 4.0.0.0 (4.0.111.0)
Syntax
public class BCVaultLink : DisposableObject

The BCVaultLink type exposes the following members.

Constructors
  NameDescription
Public methodBCVaultLink
Initializes a new instance of the BCVaultLink class.
Public methodBCVaultLink(BCRepository)
Initializes a new instance of the BCVaultLink class.
Top
Properties
  NameDescription
Public propertyBaseLineDisplayName
Gets or sets the display name of the selected baseline.
Public propertyBaseLineID
Gets or sets the ID property value of the selected baseline.
Public propertyDataStoreName
Gets or sets the name of the selected data store.
Public propertyDateTimeUTC
Gets or sets the selected date value of History mode.
Public propertyIsBaseline
Gets a value indicating whether a baseline was used to select a moment in history.
Public propertyIsDisposed
Gets a value indicating whether the object has been disposed of.
(Inherited from DisposableObject.)
Public propertyIsWorkMode
Gets a value indicating whether the vault is in writable mode.
Public propertyIsWorkPackage
Gets a value indicating whether the work area is selected.
Public propertyMachineName
Gets or sets the name of the selected server machine.
Public propertySectionAddress
Gets or sets the address of the selected section in format: "\\{MachineName}\{DataStoreName}\{VaultName}".
Public propertyUnderlyingObject
Gets the underlying wrapped object.
(Inherited from DisposableObject.)
Public propertyVaultDisplayName
Gets or sets the display name of the selected vault.
Public propertyVaultName
Gets or sets the name of the selected vault.
Public propertyWorkMode
Gets or sets a value indicating whether the vault is in writable mode.
Public propertyWorkPackageDisplayName
Gets or sets the display name of the selected work area.
Public propertyWorkPackageID
Gets or sets the ID property value of the selected work area.
Top
Methods
  NameDescription
Public methodCreateVault
Returns an instance of the BCRepository class that represents a connection to the server. The connection has been opened using the information set on the BCVaultLink. The application should call Dispose to release the repository instance.
Public methodDateTimeAsText
Returns a human-friendly string representation of the moment of time the vault was opened. It can be a baseline name, or a formatted date. For the current moment it may be the word "Current" (localized).
Public methodDateTimeAsText(Boolean)
Returns a string representation of the moment of time the vault was opened. It can be a baseline name, or a formatted date. For the current moment it may be the word "Current" (localized).
Public methodDispose
Releases the underlying wrapped object explicitly.
(Inherited from DisposableObject.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodLoadFromFile
Loads connection settings from a file created with SaveToFile(String).
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnDispose (Overrides DisposableObjectOnDispose.)
Public methodSaveToFile
Stores connection settings to the file.
Protected methodThrowIfDisposed
Throws the ObjectDisposedException exception if the underlying object has been disposed.
(Inherited from DisposableObject.)
Public methodToString (Inherited from Object.)
Top
Remarks
The properties of this object together define a specific context within a specific vault. Applications can use this information to connect to the vault and start a transaction.
See Also