The BCDocument type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | BCDocument |
Initializes a new instance of the BCDocument class.
|
Methods
| Name | Description | |
|---|---|---|
 | BeginNewRedlineVersion |
Begins the new redline version of the document.
|
| BeginNewThumbnailVersion |
Begins the new thumbnail version of the document.
|
| Copy(BCFolder) |
Creates a copy of the object.
(Inherited from BCFSObject.) |
| Copy(BCFolder, DocumentCopyFlags) |
Creates a copy of the document.
|
| CreateGlobalID |
Generates a new value that uniquely
identifies the document among all vaults.
(Overrides BCFSObject..::..CreateGlobalID()()()().) |
| DeleteOutGoingDocRefWithID |
Removes the reference to another document
using the ID property value of the reference.
|
| Derive(BCFolder) |
Creates a new derived document. The CopyWithParent property value is ignored.
|
| Derive(BCFolder, DocumentCopyFlags) |
Creates a new derived document.
|
| Dispose |
Releases the underlying wrapped object explicitly.
(Inherited from DisposableObject.) |
| EndNewRedlineVersion |
Ends the new redline version of the document.
|
| EndNewThumbnailVersion |
Ends the new thumbnail version of the document.
|
| Equals | (Inherited from Object.) |
| 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.) |
| GetDocReferences()()()() |
Returns the collection of outgoing document references (not recursively).
|
| GetDocReferences(BCDocRefType) |
Returns the collection of outgoing document references (not recursively).
|
| GetDocReferences(DocRefTypeFlags) |
Returns the collection of outgoing document references (not recursively).
|
| GetDocReferences(BCDocRefType, Boolean) |
Returns the collection of outgoing document references.
|
| GetDocReferences(DocRefTypeFlags, Boolean) |
Returns the collection of outgoing document references.
|
| GetDocReferences(BCDocRefType, Boolean, Boolean) |
Returns the collection of document references.
|
| GetDocReferences(DocRefTypeFlags, Boolean, Boolean) |
Returns the collection of document references.
|
| GetDocumentInfo |
Returns various document information in a single call.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetNavigationPath |
Returns a navigation path according to the given navigation view.
|
| GetReferencedDocuments()()()() |
Returns the collection of outgoing referenced documents (not recursively).
|
| GetReferencedDocuments(BCDocRefType) |
Returns the collection of outgoing referenced documents (not recursively).
|
| GetReferencedDocuments(DocRefTypeFlags) |
Returns the collection of outgoing referenced documents (not recursively).
|
| GetReferencedDocuments(BCDocRefType, Boolean) |
Returns the collection of outgoing referenced documents.
|
| GetReferencedDocuments(DocRefTypeFlags, Boolean) |
Returns the collection of outgoing referenced documents.
|
| GetReferencedDocuments(BCDocRefType, Boolean, Boolean) |
Returns the collection of referenced documents.
|
| GetReferencedDocuments(DocRefTypeFlags, Boolean, Boolean) |
Returns the collection of referenced documents.
|
| GetSequence |
Returns a sequence with the specified name.
If the sequence does not exist, creates it.
(Inherited from BCRepositoryObject.) |
| GetSequenceList |
Returns an array of all available sequences.
(Inherited from BCRepositoryObject.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasRedlineData |
Checks if any redline information is stored for the document.
|
| IncomingDocRefs()()()() |
Returns a collection of all BCDocRef objects
that reference the document (not recursively).
|
| IncomingDocRefs(BCDocRefType) |
Returns a collection of BCDocRef objects
that reference the document (not recursively).
|
| IncomingDocRefs(BCDocRefType, Boolean) |
Returns a collection of BCDocRef objects
that reference the document.
|
| IncomingDocuments()()()() |
Returns a collection of BCDocument objects
that reference the document (not recursively).
|
| IncomingDocuments(BCDocRefType) |
Returns a collection of BCDocument objects
that reference the document (not recursively).
|
| IncomingDocuments(BCDocRefType, Boolean) |
Returns a collection of BCDocument objects
that reference the document.
|
| LoadProperties |
Returns a property collection for a property set with the specified name.
(Overrides BCRepositoryObject..::..LoadProperties(String).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Move |
Moves the object to another folder.
(Inherited from BCFSObject.) |
| NewDocRef |
Creates a reference between the document (source) and a specified one (destination).
|
| OnDispose |
The method is called on the Dispose()()()() method call.
Derived classes should override the method to perform custom disposing.
(Inherited from DisposableObject.) |
| OutgoingDocRefs()()()() |
Returns a collection of BCDocRef objects
that reference other documents (not recursively).
|
| OutgoingDocRefs(BCDocRefType) |
Returns a collection of BCDocRef objects
that reference to other documents (not recursively).
|
| OutgoingDocRefs(BCDocRefType, Boolean) |
Returns a collection of BCDocRef objects
that reference other documents.
|
| OutgoingDocuments()()()() |
Returns a collection of BCDocument objects
referenced by the document (not recursively).
|
| OutgoingDocuments(BCDocRefType) |
Returns a collection of BCDocument objects
referenced by the document (not recursively).
|
| OutgoingDocuments(BCDocRefType, Boolean) |
Returns a collection of BCDocument objects
referenced by the document.
|
| Replace(BCFolder) |
Replaces the document from the given instance.
Sets the document state to DWFS_RETIRED.
|
| Replace(BCFolder, DocumentCopyFlags) |
Replaces the document from the given instance.
Sets the document state to DWFS_RETIRED.
|
| SaveProperties |
Saves a property collection.
(Overrides BCRepositoryObject..::..SaveProperties(BCPropertyCollection).) |
| SetFullTextReindex |
Resets property _FTUPDATED.
|
| ThrowIfDisposed |
Throws the ObjectDisposedException exception if
the underlying object has been disposed.
(Inherited from DisposableObject.) |
| ToString | (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | AccessRights |
Gets access rights of the document.
(Overrides BCFSObject..::..AccessRights.) |
| Archive |
Gets or sets a value indicating whether the object is archive.
(Inherited from BCFSObject.) |
| CanDelete |
Gets a value indicating whether the object can be deleted.
(Inherited from BCFSObject.) |
| CanEditContent |
Gets a value indicating whether the current user can edit the document content,
taking privileges and state into account.
|
| CanEditRedlines |
Gets a value indicating whether the current user can edit the document redlines,
taking privileges and state into account.
|
| CanViewContent |
Gets a value indicating whether the current user can view the document content,
taking privileges and state into account.
|
| CanViewRedlines |
Gets a value indicating whether the current user can view the document redlines,
taking privileges and state into account.
|
| Created |
Gets the date when the object was created.
(Inherited from BCFSObject.) |
| CreatedBy |
Gets the name of the person who created the object.
(Inherited from BCFSObject.) |
| DisplayName |
Gets or sets the display name of the object.
(Inherited from BCFSObject.) |
| DocumentType |
Gets or sets the type of the document.
|
| DocumentTypeDisplayName |
Gets the DisplayName property value of the document type.
|
| DocumentTypeName |
Gets the Name property value of the document type.
|
| Extendable |
Gets the extended object.
(Inherited from BCRepositoryObject.) |
| FileType |
Gets or sets the Windows-defined file type of the object.
(Inherited from BCFSObject.) |
| GlobalID |
Gets or sets the value that uniquely identifies
the document among all vaults.
(Overrides BCFSObject..::..GlobalID.) |
| HasRedlines |
Gets a value indicating whether the document contains redline information.
|
| ID |
Gets the value that uniquely identifies the object.
(Inherited from BCFSObject.) |
| ImportedFrom |
Gets or sets the path to the document/folder from which the object was imported.
(Inherited from BCFSObject.) |
| IsDisposed |
Gets a value indicating whether the object has been disposed of.
(Inherited from DisposableObject.) |
| IsFolder | Obsolete.
Gets a value indicating whether the object is a folder.
(Inherited from BCFSObject.) |
| LockID |
Gets the value that uniquely identifies the lock.
|
| MasterCopy |
Gets the master document.
|
| MasterCopyID |
Gets the ID property value of the master document.
|
| Modified |
Gets or sets the date when the object was last edited.
(Inherited from BCFSObject.) |
| ModifiedBy |
Gets or sets the name of the person who last edited the object.
(Inherited from BCFSObject.) |
| Name |
Gets the internal name of the object.
(Inherited from BCFSObject.) |
| ParentFolder |
Gets the parent folder of the object.
(Inherited from BCFSObject.) |
| Path |
Gets the relative path where the object is located.
(Inherited from BCFSObject.) |
| ProjectScopeID |
Gets the ID property value of a project scope for the document.
|
| RedlineAccessRights |
Gets access rights of the document redlines.
|
| Repository |
Gets the repository to which the object belongs.
(Inherited from BCRepositoryObject.) |
| Retention |
Gets a BCRetentionControl object to control document retention.
|
| Securable |
Gets the secured object.
(Inherited from BCRepositoryObject.) |
| Size |
Gets or sets the file size of the object.
(Inherited from BCFSObject.) |
| Status |
Gets the Status property value of the current workflow status of the document.
|
| ThumbnailUpdated |
Gets or sets the date when the thumbnail was last updated.
|
| UnderlyingObject |
Gets the underlying wrapped object.
(Inherited from DisposableObject.) |
| Versionable |
Gets the object that manages document revisions.
|
| ViewerData |
Gets or sets the viewer data field.
|
| Workflow |
Gets the workflow of the document.
|
See Also
