Click or drag to resize

BCSDocument Class

Represents an object that extends the BCDocument.
Inheritance Hierarchy

Namespace:  BlueCieloECM.InnoCielo.Meridian.Scripting
Assembly:  BlueCieloECM.InnoCielo.Meridian (in BlueCieloECM.InnoCielo.Meridian.dll) Version: 4.0.0.0 (4.0.111.0)
Syntax
public class BCSDocument : BCScriptObject

The BCSDocument type exposes the following members.

Properties
  NameDescription
Public propertyBriefcase
Gets the briefcase to which the document is checked out.
Public propertyCreated
Gets the date when the document was created.
Public propertyCreatedBy
Gets the user that created the document.
Public propertyCWFManagers
Gets the array of user names of the document workflow managers.
Public propertyCWFState
Gets the current state of the document in the workflow.
Public propertyCWFTodoPersons
Gets the array of user names of the document workflow to-do persons.
Public propertyDocumentType
Gets the type of the document.
Public propertyFileName
Gets or sets the display name of the document.
Public propertyFileType
Gets the file type of the document.
Public propertyGlobalID
Gets or sets the value that uniquely identifies the document among all vaults.
Public propertyHasIncomingReferences
Gets a value indicating whether the document has incoming references.
Public propertyHasOutgoingReferences
Gets a value indicating whether the document has outgoing references.
Public propertyHasRedlines
Gets a value indicating whether the document has redlines.
Public propertyID
Gets the value that uniquely identifies the document.
Public propertyImportType
Gets a bitmask that is a combination of bit flags from SImportFlags.
Public propertyIsDisposed
Gets a value indicating whether the object has been disposed of.
(Inherited from DisposableObject.)
Public propertyIsInCurrentWA
Gets a value indicating whether the document is assigned to the current work area.
Public propertyIsUnderRevision
Gets a value indicating whether a working copy exists for the document (for any user).
Public propertyMasterDocument
Gets the master document.
Public propertyMetadata
Gets the metadata for the script object.
(Inherited from BCScriptObject.)
Public propertyModified
Gets the date when the document was last edited.
Public propertyModifiedBy
Gets the person who last edited the document.
Public propertyParentFolder
Gets the parent folder of the object.
Public propertyParentProject
Gets the parent project.
Public propertyPath
Gets the relative path from the root of the vault.
Public propertyProperties
Gets the collection of named properties of the document.
Public propertyProperty Obsolete.
Gets the collection of named properties of the document.
Public propertyRevision
Gets or sets the revision number.
Public propertyShareID
Gets a server ShareID to get a transaction document from another process.
Public propertySize
Gets the file size of the document.
Public propertyStatusText
Gets or sets the text to display for the current workflow status.
Public propertyUnderlyingObject
Gets the underlying wrapped object.
(Inherited from DisposableObject.)
Public propertyUnderRevisionBy
Gets a user name who owns the working copy of the document.
Public propertyVersionID
Gets the value that uniquely identifies the current document version.
Public propertyWorkFlowAction
Gets the description of the action associated with the current workflow state.
Public propertyWorkFlowManager
Gets the person assigned to manage the workflow of the document.
Public propertyWorkFlowState
Gets the current workflow state.
Public propertyWorkFlowTodoPerson
Gets the person assigned to take action on the document.
Top
Methods
  NameDescription
Public methodApplyPropertyValues
Commits all the changes made to the properties since it was loaded or since the last time the ApplyPropertyValues method was called.
Public methodCalculateFileType
Calculates the type of the document.
Public methodCallRemote(String, String, String, String, String)
Evaluates an expression on the specified remote vault.
Public methodCallRemote(String, String, String, String, String, Object)
Executes an expression on the specified remote vault.
Public methodCallRemote(String, String, String, String, String, Object)
Executes an expression on the specified remote vault.
Public methodCanEditProperty
Determines whether a property with the specified name can be edited.
Public methodChangeDocumentType
Changes the type of the document.
Public methodChangeManager
Sets a new workflow manager for the document.
Public methodChangeTodoPerson
Sets a new to-do person for the document.
Public methodChangeWorkflowState
Moves the document to another workflow state.
Public methodClearRedlines
Clears the document redlines.
Public methodConfirmMerged
Confirms Merged with Master.
Public methodConfirmSuperseded
Confirms Superseded by Master.
Public methodDispose
Releases the underlying wrapped object explicitly.
(Inherited from DisposableObject.)
Public methodEquals (Inherited from Object.)
Public methodExecTransition(String)
Executes a workflow transition.
Public methodExecTransition(String, String)
Executes a workflow transition.
Public methodExecTransition(String, String, IEnumerableString)
Executes a workflow transition.
Protected methodFinalize (Inherited from Object.)
Public methodGetExpectedTransitionResult
Returns an expected result of the specified transition.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodIsUniqueValue
Determines whether there are no other documents with the specified property value.
Public methodLockLWS
Locks a local workspace copy of the document.
Public methodLockMasterDocument
Locks the master document.
Public methodLog
Appends a text message to the document log.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodMigrate(String)
Migrates the document to a new configurable workflow.
Public methodMigrate(String, String)
Migrates the document to a new configurable workflow.
Public methodMigrate(String, String, String)
Migrates the document to a new configurable workflow.
Public methodMoveTo(BCSFolder)
Moves the document into the specified folder.
Public methodMoveTo(BCSFolder, SMoveMode)
Moves the document into the specified folder.
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 methodReassignManagers(IEnumerableString)
Assigns workflow managers for the document.
Public methodReassignManagers(IEnumerableString, String)
Assigns workflow managers for the document.
Public methodReassignToDoPersons(IEnumerableString)
Assigns workflow to-do persons for the document.
Public methodReassignToDoPersons(IEnumerableString, String)
Assigns workflow to-do persons for the document.
Public methodReleaseChange
Releases a working copy (Quick Change).
Public methodReroute(String)
Reroutes the document in the workflow to a new state.
Public methodReroute(String, String)
Reroutes the document in the workflow to a new state.
Public methodReroute(String, String, IEnumerableString)
Reroutes the document in the workflow to a new state.
Public methodResetPropertyValues
Refreshes the property values (revokes any changes).
Public methodRevokeChange
Revokes a working copy (Quick Change).
Public methodRevokeWorkflow
Revokes the document from a workflow.
Public methodStartChange
Starts a working copy (Quick Change).
Public methodStartWorkFlow(String)
Initiates a workflow for the document.
Public methodStartWorkFlow(String, String)
Initiates a workflow for the document.
Public methodStartWorkFlow(String, String, String)
Initiates a workflow for the document.
Public methodStartWorkFlow(String, String, String, IEnumerableString, IEnumerableString)
Initiates a workflow for the document.
Protected methodThrowIfDisposed
Throws the ObjectDisposedException exception if the underlying object has been disposed.
(Inherited from DisposableObject.)
Public methodToString (Inherited from Object.)
Public methodUnlockLWS
Unlocks a local workspace copy of the document.
Public methodUnlockMasterDocument
Unlocks the master document.
Top
See Also