The BCRepository type exposes the following members.

Constructors

  NameDescription
Public methodBCRepository()()()()
Initializes a new instance of the BCRepository class. Connects to local server and opens the default vault for reading or writing in the context of the main area. Connection is closed when the instance is disposed.
Public methodBCRepository(String)
Initializes a new instance of the BCRepository class. Connects to a local server and opens a vault for reading or writing in the context of the main area. Connection is closed when the instance is disposed.
Public methodBCRepository(String, String)
Initializes a new instance of the BCRepository class. Connects to the server and opens a vault for reading or writing in the context of the main area. Connection is closed when the instance being disposed.
Public methodBCRepository(String, String, Boolean)
Initializes a new instance of the BCRepository class. Connects to the server and opens a vault for reading or writing in the context of the main area. Connection is closed when the instance is disposed.
Public methodBCRepository(String, String, DateTime)
Initializes a new instance of the BCRepository class. Connects to the server and opens a vault for reading or writing in the context of the main area. Connection is closed when the instance is disposed.
Public methodBCRepository(String, String, Boolean, String)
Initializes a new instance of the BCRepository class. Connects to the server and opens a vault for reading or writing. Connection is closed when the instance is disposed.
Public methodBCRepository(String, String, DateTime, String)
Initializes a new instance of the BCRepository class. Connects to the server and opens a vault for reading or writing. Connection is closed when the instance is disposed.
Public methodBCRepository(String, String, String, String)
Initializes a new instance of the BCRepository class. Connects to the server and opens a vault for reading or writing. Connection is closed when the instance is disposed.

Methods

  NameDescription
Public methodClone
Returns a new BCRepository instance that has the same state and connection parameters as this repository.
Public methodCloseRepository()()()() Obsolete.
Revokes any changes made during the transaction and closes the repository.
Public methodCloseRepository(Boolean) Obsolete.
Closes the repository with changes either committed or rolled back.
Public methodCommit
Commits changes made during the transaction. All transaction objects will be disposed.
Public methodConvertToHybrid
Converts a document to a hybrid document.
Public methodConvertToProject
Converts the folder to a project of the specified type.
Public methodDispose
Releases the underlying wrapped object explicitly.
(Inherited from DisposableObject.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExecuteMultiContextQuery(BCSearchQuery)
Executes a search query that can find documents in any work area.
Public methodExecuteMultiContextQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>))
Executes a search query that can find documents in any work area.
Public methodExecuteMultiContextQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind)
Executes a search query that can find documents in any work area.
Public methodExecuteMultiContextQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind, String)
Executes a search query that can find documents in any work area.
Public methodExecuteMultiContextQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind, String, OperatorKind)
Executes a search query that can find documents in any work area.
Public methodExecuteMultiContextQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind, String, OperatorKind, Boolean)
Executes a search query that can find documents in any work area.
Public methodExecuteQuery(BCSearchQuery)
Returns a collection of documents matching the given query.
Public methodExecuteQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>))
Returns a collection of documents matching the given query.
Public methodExecuteQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind)
Returns a collection of documents matching the given query.
Public methodExecuteQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind, BCSearchQuery)
Returns a collection of documents matching the given query.
Public methodExecuteQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind, BCSelection)
Returns a collection of documents matching the given query.
Public methodExecuteReport(String)
Executes a report with the specified ID property value. DefaultSearchQuery is used as the scope of the report.
Public methodExecuteReport(String, IEnumerable<(Of <<'(String>)>>))
Executes a report with the specified ID property value.
Public methodExecuteReport(String, String)
Executes a report with the specified ID property value.
Public methodExecuteReport(String, IEnumerable<(Of <<'(String>)>>), Boolean)
Executes a report with the specified ID property value.
Public methodExecuteReport(String, String, Boolean)
Executes a report with the specified ID property value.
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFSObjectExists
Determines whether the specified file system object exists.
Public methodGetAnyWorkPackage
Gets a work area with the specified ID property value.
Public methodGetBaseline
Returns a baseline with the specified ID property value.
Public methodGetBaselineByMoment
Returns a baseline for the specified moment in time.
Public methodGetCreatableFolderTypes
Returns the collection of folder types that are creatable in the specified folder.
Public methodGetCreatableProjects
Returns the collection of project definitions that are available to create projects inside the specified folder.
Public methodGetDistinctValues(BCPropertyDef)
Returns distinct values of all documents in the vault for a given property.
Public methodGetDistinctValues(BCPropertyDef, Int32) Obsolete.
Returns a given maximum number of distinct values of all documents in the vault, for a given property.
Public methodGetDocumentIDWithGlobalID
Returns the ID property value of a document with the specified GlobalID property value.
Public methodGetFSObject
Returns a file system object with the specified ID property value or full path.
Public methodGetFSObjectIDWithVersionID
Returns the ID property value of a document with the specified revision ID property value.
Public methodGetFullUserName
Returns the full name of the Windows user account of the given user.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetNavigationItems(BCNavigationView)
Returns top-level navigation items for the given navigation view.
Public methodGetNavigationItems(BCNavigationView, array<Object>[]()[][])
Returns navigation items for the given navigation view and path.
Public methodGetNavigationItems(BCNavigationView, array<Object>[]()[][], BCCollectionBase<(Of <<'(BCPropertyDef>)>>))
Returns document property values for the given navigation view. Values are sorted ascending on the DisplayName property value.
Public methodGetNavigationItems(BCNavigationView, array<Object>[]()[][], BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind)
Returns document property values for the given navigation view.
Public methodGetObjectSequence
Returns an object's sequence with the specified name. If the sequence does not exist, creates it.
Public methodGetSelection
Returns a selection with the specified ID property value.
Public methodGetSequenceList()()()()
Returns an array of all available sequences.
Public methodGetSequenceList(String, String)
Returns an array of sequences.
Public methodGetSubWorkPackage
Returns a sub-work area with the specified ID property value.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUserPrivileges(String, String)
Returns all privileges for the specified user on the specified enclosure.
Public methodGetUserPrivileges(String, String, Boolean)
Returns all privileges for the specified user on the specified enclosure.
Public methodGetWorkList
Returns a work list with the specified ID property value.
Public methodGetWorkListFromMainArea
Returns the collection of work lists from the main area.
Public methodGetWorkPackageIDFromDocumentID
Returns an ID property value of a work area which a document is assigned to.
Public methodHasPrivilege
Determines whether the given user has the specified privilege.
Public methodIDToPath
Returns the full path to a file system object with the specified ID property value.
Public methodImportDocument
Imports a new document into the repository.
Public methodInvalidate
Invalidates all changes in the repository.
Public methodIsUniqueValue(String, Object)
Determines whether there are no other documents with the specified property value.
Public methodIsUniqueValue(String, Object, BCDocument)
Determines whether there are no other documents with the specified property value.
Public methodLoadPropertyValue(BCRepositoryObject, String)
Returns the value of an object of the specified property.
Public methodLoadPropertyValue(BCRepositoryObject, String, PropertyDefFlags)
Returns the value of an object of the specified property.
Public methodLoadPropertyValues(BCRepositoryObject, BCCollectionBase<(Of <<'(BCPropertyDef>)>>))
Returns the values of an object of the specified set of properties.
Public methodLoadPropertyValues(BCRepositoryObject, IEnumerable<(Of <<'(String>)>>))
Returns the values of an object of the specified set of properties.
Public methodLoadPropertyValues(BCRepositoryObject, String)
Returns the values of an object of the specified set of properties.
Public methodLoadPropertyValues(BCRepositoryObject, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), PropertyDefFlags)
Returns the values of an object of the specified set of properties.
Public methodLoadPropertyValues(BCRepositoryObject, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), Int32%)
Returns the values of an object of the specified set of properties.
Public methodLoadPropertyValues(BCRepositoryObject, IEnumerable<(Of <<'(String>)>>), PropertyDefFlags)
Returns the values of an object of the specified set of properties.
Public methodMakeSelection
Returns a new selection object from the given collection of documents.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNewBaseline
Creates a new baseline.
Public methodNewConfigurableFolder(BCFolder, BCFolderType) Obsolete.
Creates a new sub-folder with the specified type and name.
Public methodNewConfigurableFolder(BCFolder, BCFolderType, String) Obsolete.
Creates a new sub-folder with the specified type and name.
Public methodNewDocument(BCFolder, BCDocumentType)
Creates a new document.
Public methodNewDocument(BCFolder, BCDocumentType, BCDocumentTemplate)
Creates a new document.
Public methodNewFolder(BCFolder) Obsolete.
Creates a new sub-folder.
Public methodNewFolder(BCFolder, BCFolderType) Obsolete.
Creates a new sub-folder of the specified type.
Public methodNewFolder(BCFolder, BCFolderType, String) Obsolete.
Creates a new sub-folder in the specified folder.
Public methodNewProject(BCFolder, BCProjectDefinition) Obsolete.
Creates a new project sub-folder in the specified folder.
Public methodNewProject(BCFolder, BCProjectDefinition, String) Obsolete.
Creates a new project sub-folder in the specified folder.
Public methodNewSearchQuery
Creates a new temporary search.
Public methodNewSelection
Creates a new selection.
Public methodNewSubWorkPackage
Returns a new sub-work area.
Public methodNewTransaction()()()()
Returns a new BCRepository instance that is connected to the same vault, opened in the same mode and work area in which the current repository was initially opened.
Public methodNewTransaction(Boolean)
Returns a new BCRepository instance that is connected to the same vault, opened at the specified moment and work area in which the current repository was initially opened.
Public methodNewTransaction(Nullable<(Of <<'(DateTime>)>>))
Returns a new BCRepository instance that is connected to the same vault, opened at the specified moment and work area in which the current repository was initially opened.
Public methodNewTransaction(Boolean, String)
Returns a new BCRepository instance that is connected to the same vault, opened at the specified moment and work area.
Public methodNewTransaction(Nullable<(Of <<'(DateTime>)>>), String)
Returns a new BCRepository instance that is connected to the same vault, opened at the specified moment and work area.
Public methodNextSequenceNumber
Increments and returns a sequence number with the specified name.
Protected methodOnDispose
The method is called on Dispose()()()().
(Overrides DisposableObject..::..OnDispose()()()().)
Public methodPath
Returns the (context) path in which the repository was opened.
Public methodPathToID
Returns the ID property value of a file system object with the specified full path.
Public methodPurgeDocumentWithID
Purges a document with the specified ID property value from the vault.
Public methodRefresh
Flushes the cache and starts caching new data.
Public methodRemoveAndPurgeSelection
Removes and purges a selection with the specified ID property value.
Public methodRemoveSubWorkPackage
Removes the given work area.
Public methodReOpen()()()() Obsolete.
Commits changes made during the current transaction and reopens the repository at the Moment time and the same as the CurrentWorkPackage work area. All transaction objects will be disposed.
Public methodReOpen(Boolean) Obsolete.
Reopens the repository at the Moment time and the same as the CurrentWorkPackage work area. All transaction objects will be disposed.
Public methodReOpen(Boolean, Boolean)
Reopens the repository in the specified mode and work area in which the repository was initially opened. All transaction objects will be disposed.
Public methodReOpen(Boolean, Nullable<(Of <<'(DateTime>)>>))
Reopens the repository at the specified time and work area in which the repository was initially opened. All transaction objects will be disposed.
Public methodReOpen(Boolean, Boolean, String)
Reopens the repository in the specified work area and mode. All transaction objects will be disposed.
Public methodReOpen(Boolean, Nullable<(Of <<'(DateTime>)>>), String)
Reopens the repository at the specified moment and in the specified work area. All transaction objects will be disposed.
Public methodResetSequence
Resets a sequence number with the specified name.
Public methodRollback
Revokes any changes made during the transaction. All transaction objects will be disposed.
Public methodSavePropertyValue(BCRepositoryObject, String, Object)
Saves the value of the given property for an object.
Public methodSavePropertyValue(BCRepositoryObject, String, Object, PropertyDefFlags)
Saves the value of the given property for an object.
Public methodSavePropertyValues(BCRepositoryObject, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), IEnumerable<(Of <<'(Object>)>>))
Saves the values of the given set of properties for an object.
Public methodSavePropertyValues(BCRepositoryObject, IEnumerable<(Of <<'(String>)>>), IEnumerable<(Of <<'(Object>)>>))
Saves the values of the given set of properties for an object.
Public methodSavePropertyValues(BCRepositoryObject, String, IEnumerable<(Of <<'(Object>)>>))
Saves the values of the given set of properties for an object.
Public methodSavePropertyValues(BCRepositoryObject, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), IEnumerable<(Of <<'(Object>)>>), PropertyDefFlags)
Saves the values of the given set of properties for an object.
Public methodSavePropertyValues(BCRepositoryObject, IEnumerable<(Of <<'(String>)>>), IEnumerable<(Of <<'(Object>)>>), PropertyDefFlags)
Saves the values of the given set of properties for an object.
Public methodSequenceNumber
Returns a sequence number with the specified name.
Protected methodThrowIfDisposed
Throws the ObjectDisposedException exception if the underlying object has been disposed.
(Inherited from DisposableObject.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodTryGetBaselineByMoment
Gets a baseline for the specified moment in time.

Properties

  NameDescription
Public propertyAMFSSharePath
Gets the UNC share path of the local AMFS drive.
Public propertyAMLicense
Gets the license information for the repository.
Public propertyAMServer
Gets the server information for the repository.
Public propertyAPWFEnabled
Gets or sets a value indicating whether Advanced Project Workflow module has been enabled for the vault.
Public propertyAuditTrail
Gets the audit trailer for the repository.
Public propertyBaselines
Gets the collection of baselines.
Public propertyContextPath
Gets the path describing the context in which this repository is currently opened.
Public propertyCreationDate
Gets the creation date of the repository.
Public propertyCurrentWorkList
Gets the work list for the current user in the current work area.
Public propertyCurrentWorkPackage
Gets the current opened work area.
Public propertyDataStoreName
Gets the name of the data store.
Public propertyDetectChangedDocuments
Gets or sets a value indicating whether to enable the detection of documents chnaged during the transaction.
Public propertyDisableWorkAreas
Gets or sets a value indicating whether work areas have been disabled for the vault.
Public propertyDisplayName
Gets or sets the display name of the repository.
Public propertyDocumentCount
Gets the total number of documents in the vault.
Public propertyEDMServerVersion
Gets the server version.
Public propertyEnvironment
Gets the environment settings.
Public propertyIgnoreDocumentLockID
Gets or sets the current session document LockID property value that should be ignored on restricted operations.
Public propertyImportFilter
Gets AMFS no-import filter.
Public propertyIsDisposed
Gets a value indicating whether the object has been disposed of.
(Inherited from DisposableObject.)
Public propertyIsOpen Obsolete.
Gets a value indicating whether the repository is currently opened.
Public propertyIsRevoked
Gets a value indicating whether the current transaction has been revoked.
Public propertyIsUserMode
Gets a value indicating whether the repository is opened in writable mode.
Public propertyIsWorkIsolationMode Obsolete.
Gets a value indicating whether the Work Isolation mode has been enabled for the vault.
Public propertyMainWorkPackages
Gets the collection of main-level work areas.
Public propertyMoment
Gets the date when the repository was opened. The current transaction will view the vault as it existed at that point in time. Gets nullNothingnullptra null reference (Nothing in Visual Basic) if the repository was opened in the present time.
Public propertyMomentDate
Gets the date when the repository was opened. The current transaction will view the vault as it existed at that point in time. Gets the current server time if the transaction is in the present time (the Moment property returns nullNothingnullptra null reference (Nothing in Visual Basic)).
Public propertyName
Gets the internal name of the repository.
Public propertyOnImportDocument
Gets or sets the state to set when a document is imported.
Public propertyOtherWLAccessRights
Gets access rights for the current user to access/modify work lists of other people.
Public propertyPatchCode
Gets the license type.
Public propertyRequireChangeThroughSubWP
Gets or sets a value indicating whether documents can be edited in the work area. If falseFalsefalsefalse (False in Visual Basic) then documents should be assigned to a sub-work area first.
Public propertyRollbackOnDispose
Gets or sets a value indicating whether the repository should be closed without commitment when the repository is disposed. Default value is trueTruetruetrue (True in Visual Basic).
Public propertyRoot
Gets the root folder of the repository.
Public propertyRootObjectID
Gets the value that uniquely identifies the root object of the repository.
Public propertySelections
Gets the collection of selections in the current work area.
Public propertyServerTime
Gets the current server time.
Public propertySessionIdentification
Gets or sets the session identification.
Public propertySubWorkPackages
Gets the collection of sub-work packages.
Public propertyUnderlyingObject
Gets the underlying wrapped object.
(Inherited from DisposableObject.)
Public propertyUseAMFS
Gets or sets a value indicating whether to use AMFS.
Public propertyUseObjectContext
Gets or sets a value indicating whether to use the object context mode of the current transaction.
Public propertyUser
Gets the name of the user.
Public propertyUsesExternalEnvironment
Gets a value indicating whether the vault was opened with an external environment.
Public propertyWebAccessLocationID
Gets or sets the unique value that identifies the published location of the vault which can be used by Web Access.
Public propertyWebAccessLocationName
Gets or sets the name of the Web Location.
Public propertyWebAccessVirtualDirectory
Gets or sets the base URL of the vault which can be used by Web Access.
Public propertyWorkIsolationMode
Gets or sets a value indicating whether the Work Isolation mode has been enabled for the vault.
Public propertyWorkLists
Gets the collection of work lists.

See Also