The BCDocument type exposes the following members.

Constructors

  NameDescription
Protected methodBCDocument
Initializes a new instance of the BCDocument class.

Methods

  NameDescription
Public methodBeginNewRedlineVersion
Begins the new redline version of the document.
Public methodBeginNewThumbnailVersion
Begins the new thumbnail version of the document.
Public methodCopy(BCFolder)
Creates a copy of the object.
(Inherited from BCFSObject.)
Public methodCopy(BCFolder, DocumentCopyFlags)
Creates a copy of the document.
Public methodCreateGlobalID
Generates a new value that uniquely identifies the document among all vaults.
(Overrides BCFSObject..::..CreateGlobalID()()()().)
Public methodDeleteOutGoingDocRefWithID
Removes the reference to another document using the ID property value of the reference.
Public methodDerive(BCFolder)
Creates a new derived document. The CopyWithParent property value is ignored.
Public methodDerive(BCFolder, DocumentCopyFlags)
Creates a new derived document.
Public methodDispose
Releases the underlying wrapped object explicitly.
(Inherited from DisposableObject.)
Public methodEndNewRedlineVersion
Ends the new redline version of the document.
Public methodEndNewThumbnailVersion
Ends the new thumbnail version of the document.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
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 methodGetDocReferences()()()()
Returns the collection of outgoing document references (not recursively).
Public methodGetDocReferences(BCDocRefType)
Returns the collection of outgoing document references (not recursively).
Public methodGetDocReferences(DocRefTypeFlags)
Returns the collection of outgoing document references (not recursively).
Public methodGetDocReferences(BCDocRefType, Boolean)
Returns the collection of outgoing document references.
Public methodGetDocReferences(DocRefTypeFlags, Boolean)
Returns the collection of outgoing document references.
Public methodGetDocReferences(BCDocRefType, Boolean, Boolean)
Returns the collection of document references.
Public methodGetDocReferences(DocRefTypeFlags, Boolean, Boolean)
Returns the collection of document references.
Public methodGetDocumentInfo
Returns various document information in a single call.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetNavigationPath
Returns a navigation path according to the given navigation view.
Public methodGetReferencedDocuments()()()()
Returns the collection of outgoing referenced documents (not recursively).
Public methodGetReferencedDocuments(BCDocRefType)
Returns the collection of outgoing referenced documents (not recursively).
Public methodGetReferencedDocuments(DocRefTypeFlags)
Returns the collection of outgoing referenced documents (not recursively).
Public methodGetReferencedDocuments(BCDocRefType, Boolean)
Returns the collection of outgoing referenced documents.
Public methodGetReferencedDocuments(DocRefTypeFlags, Boolean)
Returns the collection of outgoing referenced documents.
Public methodGetReferencedDocuments(BCDocRefType, Boolean, Boolean)
Returns the collection of referenced documents.
Public methodGetReferencedDocuments(DocRefTypeFlags, Boolean, Boolean)
Returns the collection of referenced documents.
Public methodGetSequence
Returns a sequence with the specified name. If the sequence does not exist, creates it.
(Inherited from BCRepositoryObject.)
Public methodGetSequenceList
Returns an array of all available sequences.
(Inherited from BCRepositoryObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasRedlineData
Checks if any redline information is stored for the document.
Public methodIncomingDocRefs()()()()
Returns a collection of all BCDocRef objects that reference the document (not recursively).
Public methodIncomingDocRefs(BCDocRefType)
Returns a collection of BCDocRef objects that reference the document (not recursively).
Public methodIncomingDocRefs(BCDocRefType, Boolean)
Returns a collection of BCDocRef objects that reference the document.
Public methodIncomingDocuments()()()()
Returns a collection of BCDocument objects that reference the document (not recursively).
Public methodIncomingDocuments(BCDocRefType)
Returns a collection of BCDocument objects that reference the document (not recursively).
Public methodIncomingDocuments(BCDocRefType, Boolean)
Returns a collection of BCDocument objects that reference the document.
Public methodLoadProperties
Returns a property collection for a property set with the specified name.
(Overrides BCRepositoryObject..::..LoadProperties(String).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMove
Moves the object to another folder.
(Inherited from BCFSObject.)
Public methodNewDocRef
Creates a reference between the document (source) and a specified one (destination).
Protected methodOnDispose
The method is called on the Dispose()()()() method call. Derived classes should override the method to perform custom disposing.
(Inherited from DisposableObject.)
Public methodOutgoingDocRefs()()()()
Returns a collection of BCDocRef objects that reference other documents (not recursively).
Public methodOutgoingDocRefs(BCDocRefType)
Returns a collection of BCDocRef objects that reference to other documents (not recursively).
Public methodOutgoingDocRefs(BCDocRefType, Boolean)
Returns a collection of BCDocRef objects that reference other documents.
Public methodOutgoingDocuments()()()()
Returns a collection of BCDocument objects referenced by the document (not recursively).
Public methodOutgoingDocuments(BCDocRefType)
Returns a collection of BCDocument objects referenced by the document (not recursively).
Public methodOutgoingDocuments(BCDocRefType, Boolean)
Returns a collection of BCDocument objects referenced by the document.
Public methodReplace(BCFolder)
Replaces the document from the given instance. Sets the document state to DWFS_RETIRED.
Public methodReplace(BCFolder, DocumentCopyFlags)
Replaces the document from the given instance. Sets the document state to DWFS_RETIRED.
Public methodSaveProperties
Saves a property collection.
(Overrides BCRepositoryObject..::..SaveProperties(BCPropertyCollection).)
Public methodSetFullTextReindex
Resets property _FTUPDATED.
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.)

Properties

  NameDescription
Public propertyAccessRights
Gets access rights of the document.
(Overrides BCFSObject..::..AccessRights.)
Public propertyArchive
Gets or sets a value indicating whether the object is archive.
(Inherited from BCFSObject.)
Public propertyCanDelete
Gets a value indicating whether the object can be deleted.
(Inherited from BCFSObject.)
Public propertyCanEditContent
Gets a value indicating whether the current user can edit the document content, taking privileges and state into account.
Public propertyCanEditRedlines
Gets a value indicating whether the current user can edit the document redlines, taking privileges and state into account.
Public propertyCanViewContent
Gets a value indicating whether the current user can view the document content, taking privileges and state into account.
Public propertyCanViewRedlines
Gets a value indicating whether the current user can view the document redlines, taking privileges and state into account.
Public propertyCreated
Gets the date when the object was created.
(Inherited from BCFSObject.)
Public propertyCreatedBy
Gets the name of the person who created the object.
(Inherited from BCFSObject.)
Public propertyDisplayName
Gets or sets the display name of the object.
(Inherited from BCFSObject.)
Public propertyDocumentType
Gets or sets the type of the document.
Public propertyDocumentTypeDisplayName
Gets the DisplayName property value of the document type.
Public propertyDocumentTypeName
Gets the Name property value of the document type.
Public propertyExtendable
Gets the extended object.
(Inherited from BCRepositoryObject.)
Public propertyFileType
Gets or sets the Windows-defined file type of the object.
(Inherited from BCFSObject.)
Public propertyGlobalID
Gets or sets the value that uniquely identifies the document among all vaults.
(Overrides BCFSObject..::..GlobalID.)
Public propertyHasRedlines
Gets a value indicating whether the document contains redline information.
Public propertyID
Gets the value that uniquely identifies the object.
(Inherited from BCFSObject.)
Public propertyImportedFrom
Gets or sets the path to the document/folder from which the object was imported.
(Inherited from BCFSObject.)
Public propertyIsDisposed
Gets a value indicating whether the object has been disposed of.
(Inherited from DisposableObject.)
Public propertyIsFolder Obsolete.
Gets a value indicating whether the object is a folder.
(Inherited from BCFSObject.)
Public propertyLockID
Gets the value that uniquely identifies the lock.
Public propertyMasterCopy
Gets the master document.
Public propertyMasterCopyID
Gets the ID property value of the master document.
Public propertyModified
Gets or sets the date when the object was last edited.
(Inherited from BCFSObject.)
Public propertyModifiedBy
Gets or sets the name of the person who last edited the object.
(Inherited from BCFSObject.)
Public propertyName
Gets the internal name of the object.
(Inherited from BCFSObject.)
Public propertyParentFolder
Gets the parent folder of the object.
(Inherited from BCFSObject.)
Public propertyPath
Gets the relative path where the object is located.
(Inherited from BCFSObject.)
Public propertyProjectScopeID
Gets the ID property value of a project scope for the document.
Public propertyRedlineAccessRights
Gets access rights of the document redlines.
Public propertyRepository
Gets the repository to which the object belongs.
(Inherited from BCRepositoryObject.)
Public propertyRetention
Gets a BCRetentionControl object to control document retention.
Public propertySecurable
Gets the secured object.
(Inherited from BCRepositoryObject.)
Public propertySize
Gets or sets the file size of the object.
(Inherited from BCFSObject.)
Public propertyStatus
Gets the Status property value of the current workflow status of the document.
Public propertyThumbnailUpdated
Gets or sets the date when the thumbnail was last updated.
Public propertyUnderlyingObject
Gets the underlying wrapped object.
(Inherited from DisposableObject.)
Public propertyVersionable
Gets the object that manages document revisions.
Public propertyViewerData
Gets or sets the viewer data field.
Public propertyWorkflow
Gets the workflow of the document.

See Also