The BCRepository type exposes the following members.
Constructors
Name | Description | |
---|---|---|
BCRepository()()()() |
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.
| |
BCRepository(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.
| |
BCRepository(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.
| |
BCRepository(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.
| |
BCRepository(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.
| |
BCRepository(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.
| |
BCRepository(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.
| |
BCRepository(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
Name | Description | |
---|---|---|
Clone |
Returns a new BCRepository instance that has the same state
and connection parameters as this repository.
| |
CloseRepository()()()() | Obsolete.
Revokes any changes made during the transaction and closes the repository.
| |
CloseRepository(Boolean) | Obsolete.
Closes the repository with changes either committed or rolled back.
| |
Commit |
Commits changes made during the transaction.
All transaction objects will be disposed.
| |
ConvertToHybrid |
Converts a document to a hybrid document.
| |
ConvertToProject |
Converts the folder to a project of the specified type.
| |
Dispose |
Releases the underlying wrapped object explicitly.
(Inherited from DisposableObject.) | |
Equals | (Inherited from Object.) | |
ExecuteMultiContextQuery(BCSearchQuery) |
Executes a search query that can find documents in any work area.
| |
ExecuteMultiContextQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>)) |
Executes a search query that can find documents in any work area.
| |
ExecuteMultiContextQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind) |
Executes a search query that can find documents in any work area.
| |
ExecuteMultiContextQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind, String) |
Executes a search query that can find documents in any work area.
| |
ExecuteMultiContextQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind, String, OperatorKind) |
Executes a search query that can find documents in any work area.
| |
ExecuteMultiContextQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind, String, OperatorKind, Boolean) |
Executes a search query that can find documents in any work area.
| |
ExecuteQuery(BCSearchQuery) |
Returns a collection of documents matching the given query.
| |
ExecuteQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>)) |
Returns a collection of documents matching the given query.
| |
ExecuteQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind) |
Returns a collection of documents matching the given query.
| |
ExecuteQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind, BCSearchQuery) |
Returns a collection of documents matching the given query.
| |
ExecuteQuery(BCSearchQuery, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind, BCSelection) |
Returns a collection of documents matching the given query.
| |
ExecuteReport(String) |
Executes a report with the specified ID property value.
DefaultSearchQuery is used as the scope of the report.
| |
ExecuteReport(String, IEnumerable<(Of <<'(String>)>>)) |
Executes a report with the specified ID property value.
| |
ExecuteReport(String, String) |
Executes a report with the specified ID property value.
| |
ExecuteReport(String, IEnumerable<(Of <<'(String>)>>), Boolean) |
Executes a report with the specified ID property value.
| |
ExecuteReport(String, String, Boolean) |
Executes a report with the specified ID property value.
| |
Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
FSObjectExists |
Determines whether the specified file system object exists.
| |
GetAnyWorkPackage |
Gets a work area with the specified ID property value.
| |
GetBaseline |
Returns a baseline with the specified ID property value.
| |
GetBaselineByMoment |
Returns a baseline for the specified moment in time.
| |
GetCreatableFolderTypes |
Returns the collection of folder types that are creatable in the specified folder.
| |
GetCreatableProjects |
Returns the collection of project definitions
that are available to create projects inside the specified folder.
| |
GetDistinctValues(BCPropertyDef) |
Returns distinct values of all documents in the vault for a given property.
| |
GetDistinctValues(BCPropertyDef, Int32) | Obsolete.
Returns a given maximum number of distinct values of all documents in the vault,
for a given property.
| |
GetDocumentIDWithGlobalID |
Returns the ID property value of a document with the specified GlobalID property value.
| |
GetFSObject |
Returns a file system object with the specified ID property value or full path.
| |
GetFSObjectIDWithVersionID |
Returns the ID property value of a document with the specified revision ID property value.
| |
GetFullUserName |
Returns the full name of the Windows user account of the given user.
| |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetNavigationItems(BCNavigationView) |
Returns top-level navigation items for the given navigation view.
| |
GetNavigationItems(BCNavigationView, array<Object>[]()[][]) |
Returns navigation items for the given navigation view and path.
| |
GetNavigationItems(BCNavigationView, array<Object>[]()[][], BCCollectionBase<(Of <<'(BCPropertyDef>)>>)) |
Returns document property values for the given navigation view.
Values are sorted ascending on the DisplayName property value.
| |
GetNavigationItems(BCNavigationView, array<Object>[]()[][], BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind) |
Returns document property values for the given navigation view.
| |
GetObjectSequence |
Returns an object's sequence with the specified name.
If the sequence does not exist, creates it.
| |
GetSelection |
Returns a selection with the specified ID property value.
| |
GetSequenceList()()()() |
Returns an array of all available sequences.
| |
GetSequenceList(String, String) |
Returns an array of sequences.
| |
GetSubWorkPackage |
Returns a sub-work area with the specified ID property value.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetUserPrivileges(String, String) |
Returns all privileges for the specified user on the specified enclosure.
| |
GetUserPrivileges(String, String, Boolean) |
Returns all privileges for the specified user on the specified enclosure.
| |
GetWorkList |
Returns a work list with the specified ID property value.
| |
GetWorkListFromMainArea |
Returns the collection of work lists from the main area.
| |
GetWorkPackageIDFromDocumentID |
Returns an ID property value of a work area which a document is assigned to.
| |
HasPrivilege |
Determines whether the given user has the specified privilege.
| |
IDToPath |
Returns the full path to a file system object with the specified ID property value.
| |
ImportDocument |
Imports a new document into the repository.
| |
Invalidate |
Invalidates all changes in the repository.
| |
IsUniqueValue(String, Object) |
Determines whether there are no other documents with
the specified property value.
| |
IsUniqueValue(String, Object, BCDocument) |
Determines whether there are no other documents with
the specified property value.
| |
LoadPropertyValue(BCRepositoryObject, String) |
Returns the value of an object of the specified property.
| |
LoadPropertyValue(BCRepositoryObject, String, PropertyDefFlags) |
Returns the value of an object of the specified property.
| |
LoadPropertyValues(BCRepositoryObject, BCCollectionBase<(Of <<'(BCPropertyDef>)>>)) |
Returns the values of an object of the specified set of properties.
| |
LoadPropertyValues(BCRepositoryObject, IEnumerable<(Of <<'(String>)>>)) |
Returns the values of an object of the specified set of properties.
| |
LoadPropertyValues(BCRepositoryObject, String) |
Returns the values of an object of the specified set of properties.
| |
LoadPropertyValues(BCRepositoryObject, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), PropertyDefFlags) |
Returns the values of an object of the specified set of properties.
| |
LoadPropertyValues(BCRepositoryObject, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), Int32%) |
Returns the values of an object of the specified set of properties.
| |
LoadPropertyValues(BCRepositoryObject, IEnumerable<(Of <<'(String>)>>), PropertyDefFlags) |
Returns the values of an object of the specified set of properties.
| |
MakeSelection |
Returns a new selection object from the given collection of documents.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
NewBaseline |
Creates a new baseline.
| |
NewConfigurableFolder(BCFolder, BCFolderType) | Obsolete.
Creates a new sub-folder with the specified type and name.
| |
NewConfigurableFolder(BCFolder, BCFolderType, String) | Obsolete.
Creates a new sub-folder with the specified type and name.
| |
NewDocument(BCFolder, BCDocumentType) |
Creates a new document.
| |
NewDocument(BCFolder, BCDocumentType, BCDocumentTemplate) |
Creates a new document.
| |
NewFolder(BCFolder) | Obsolete.
Creates a new sub-folder.
| |
NewFolder(BCFolder, BCFolderType) | Obsolete.
Creates a new sub-folder of the specified type.
| |
NewFolder(BCFolder, BCFolderType, String) | Obsolete.
Creates a new sub-folder in the specified folder.
| |
NewProject(BCFolder, BCProjectDefinition) | Obsolete.
Creates a new project sub-folder in the specified folder.
| |
NewProject(BCFolder, BCProjectDefinition, String) | Obsolete.
Creates a new project sub-folder in the specified folder.
| |
NewSearchQuery |
Creates a new temporary search.
| |
NewSelection |
Creates a new selection.
| |
NewSubWorkPackage |
Returns a new sub-work area.
| |
NewTransaction()()()() |
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.
| |
NewTransaction(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.
| |
NewTransaction(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.
| |
NewTransaction(Boolean, String) |
Returns a new BCRepository instance that is connected
to the same vault, opened at the specified moment and work area.
| |
NewTransaction(Nullable<(Of <<'(DateTime>)>>), String) |
Returns a new BCRepository instance that is connected
to the same vault, opened at the specified moment and work area.
| |
NextSequenceNumber |
Increments and returns a sequence number with the specified name.
| |
OnDispose |
The method is called on Dispose()()()().
(Overrides DisposableObject..::..OnDispose()()()().) | |
Path |
Returns the (context) path in which the repository was opened.
| |
PathToID |
Returns the ID property value of a file system object with the specified full path.
| |
PurgeDocumentWithID |
Purges a document with the specified ID property value from the vault.
| |
Refresh |
Flushes the cache and starts caching new data.
| |
RemoveAndPurgeSelection |
Removes and purges a selection with the specified ID property value.
| |
RemoveSubWorkPackage |
Removes the given work area.
| |
ReOpen()()()() | 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.
| |
ReOpen(Boolean) | Obsolete.
Reopens the repository at the Moment time and the same as
the CurrentWorkPackage work area.
All transaction objects will be disposed.
| |
ReOpen(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.
| |
ReOpen(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.
| |
ReOpen(Boolean, Boolean, String) |
Reopens the repository in the specified work area and mode.
All transaction objects will be disposed.
| |
ReOpen(Boolean, Nullable<(Of <<'(DateTime>)>>), String) |
Reopens the repository at the specified moment and in the specified work area.
All transaction objects will be disposed.
| |
ResetSequence |
Resets a sequence number with the specified name.
| |
Rollback |
Revokes any changes made during the transaction.
All transaction objects will be disposed.
| |
SavePropertyValue(BCRepositoryObject, String, Object) |
Saves the value of the given property for an object.
| |
SavePropertyValue(BCRepositoryObject, String, Object, PropertyDefFlags) |
Saves the value of the given property for an object.
| |
SavePropertyValues(BCRepositoryObject, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), IEnumerable<(Of <<'(Object>)>>)) |
Saves the values of the given set of properties for an object.
| |
SavePropertyValues(BCRepositoryObject, IEnumerable<(Of <<'(String>)>>), IEnumerable<(Of <<'(Object>)>>)) |
Saves the values of the given set of properties for an object.
| |
SavePropertyValues(BCRepositoryObject, String, IEnumerable<(Of <<'(Object>)>>)) |
Saves the values of the given set of properties for an object.
| |
SavePropertyValues(BCRepositoryObject, BCCollectionBase<(Of <<'(BCPropertyDef>)>>), IEnumerable<(Of <<'(Object>)>>), PropertyDefFlags) |
Saves the values of the given set of properties for an object.
| |
SavePropertyValues(BCRepositoryObject, IEnumerable<(Of <<'(String>)>>), IEnumerable<(Of <<'(Object>)>>), PropertyDefFlags) |
Saves the values of the given set of properties for an object.
| |
SequenceNumber |
Returns a sequence number with the specified name.
| |
ThrowIfDisposed |
Throws the ObjectDisposedException exception if
the underlying object has been disposed.
(Inherited from DisposableObject.) | |
ToString | (Inherited from Object.) | |
TryGetBaselineByMoment |
Gets a baseline for the specified moment in time.
|
Properties
Name | Description | |
---|---|---|
AMFSSharePath |
Gets the UNC share path of the local AMFS drive.
| |
AMLicense |
Gets the license information for the repository.
| |
AMServer |
Gets the server information for the repository.
| |
APWFEnabled |
Gets or sets a value indicating whether Advanced Project Workflow module
has been enabled for the vault.
| |
AuditTrail |
Gets the audit trailer for the repository.
| |
Baselines |
Gets the collection of baselines.
| |
ContextPath |
Gets the path describing the context in which this repository is currently opened.
| |
CreationDate |
Gets the creation date of the repository.
| |
CurrentWorkList |
Gets the work list for the current user in the current work area.
| |
CurrentWorkPackage |
Gets the current opened work area.
| |
DataStoreName |
Gets the name of the data store.
| |
DetectChangedDocuments |
Gets or sets a value indicating whether to enable
the detection of documents chnaged during the transaction.
| |
DisableWorkAreas |
Gets or sets a value indicating whether
work areas have been disabled for the vault.
| |
DisplayName |
Gets or sets the display name of the repository.
| |
DocumentCount |
Gets the total number of documents in the vault.
| |
EDMServerVersion |
Gets the server version.
| |
Environment |
Gets the environment settings.
| |
IgnoreDocumentLockID |
Gets or sets the current session document LockID property value
that should be ignored on restricted operations.
| |
ImportFilter |
Gets AMFS no-import filter.
| |
IsDisposed |
Gets a value indicating whether the object has been disposed of.
(Inherited from DisposableObject.) | |
IsOpen | Obsolete.
Gets a value indicating whether the repository is currently opened.
| |
IsRevoked |
Gets a value indicating whether the current transaction has been revoked.
| |
IsUserMode |
Gets a value indicating whether the repository is opened in writable mode.
| |
IsWorkIsolationMode | Obsolete.
Gets a value indicating whether the Work Isolation mode has been enabled for the vault.
| |
MainWorkPackages |
Gets the collection of main-level work areas.
| |
Moment |
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.
| |
MomentDate |
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)).
| |
Name |
Gets the internal name of the repository.
| |
OnImportDocument |
Gets or sets the state to set when a document is imported.
| |
OtherWLAccessRights |
Gets access rights for the current user
to access/modify work lists of other people.
| |
PatchCode |
Gets the license type.
| |
RequireChangeThroughSubWP |
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.
| |
RollbackOnDispose |
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).
| |
Root |
Gets the root folder of the repository.
| |
RootObjectID |
Gets the value that uniquely identifies the root object of the repository.
| |
Selections |
Gets the collection of selections in the current work area.
| |
ServerTime |
Gets the current server time.
| |
SessionIdentification |
Gets or sets the session identification.
| |
SubWorkPackages |
Gets the collection of sub-work packages.
| |
UnderlyingObject |
Gets the underlying wrapped object.
(Inherited from DisposableObject.) | |
UseAMFS |
Gets or sets a value indicating whether to use AMFS.
| |
UseObjectContext |
Gets or sets a value indicating whether to use the
object context mode of the current transaction.
| |
User |
Gets the name of the user.
| |
UsesExternalEnvironment |
Gets a value indicating whether the vault was opened with an external environment.
| |
WebAccessLocationID |
Gets or sets the unique value that identifies the
published location of the vault which can be used by Web Access.
| |
WebAccessLocationName |
Gets or sets the name of the Web Location.
| |
WebAccessVirtualDirectory |
Gets or sets the base URL of the vault which can be used by Web Access.
| |
WorkIsolationMode |
Gets or sets a value indicating whether
the Work Isolation mode has been enabled for the vault.
| |
WorkLists |
Gets the collection of work lists.
|