BCSDocument Class

Represents an object that extends the BCDocument.

Inheritance Hierarchy

SystemObject
  BlueCieloECM.InnoCielo.MeridianDisposableObject
    BlueCieloECM.InnoCielo.Meridian.ScriptingBCScriptObject
      BlueCieloECM.InnoCielo.Meridian.ScriptingBCSDocument

Namespace: BlueCieloECM.InnoCielo.Meridian.Scripting
Assembly: BlueCieloECM.InnoCielo.Meridian (in BlueCieloECM.InnoCielo.Meridian.dll) Version: 4.0.0.0 (4.0.111.0)

Syntax

Copy

public class BCSDocument : BCScriptObject

Public Class BCSDocument
	Inherits BCScriptObject

The BCSDocument type exposes the following members.

Properties

	Name	Description
	Briefcase	Gets the briefcase to which the document is checked out.
	Created	Gets the date when the document was created.
	CreatedBy	Gets the user that created the document.
	CWFManagers	Gets the array of user names of the document workflow managers.
	CWFState	Gets the current state of the document in the workflow.
	CWFTodoPersons	Gets the array of user names of the document workflow to-do persons.
	DocumentType	Gets the type of the document.
	FileName	Gets or sets the display name of the document.
	FileType	Gets the file type of the document.
	GlobalID	Gets or sets the value that uniquely identifies the document among all vaults.
	HasIncomingReferences	Gets a value indicating whether the document has incoming references.
	HasOutgoingReferences	Gets a value indicating whether the document has outgoing references.
	HasRedlines	Gets a value indicating whether the document has redlines.
	ID	Gets the value that uniquely identifies the document.
	ImportType	Gets a bitmask that is a combination of bit flags from SImportFlags.
	IsDisposed	Gets a value indicating whether the object has been disposed of. (Inherited from DisposableObject.)
	IsInCurrentWA	Gets a value indicating whether the document is assigned to the current work area.
	IsUnderRevision	Gets a value indicating whether a working copy exists for the document (for any user).
	MasterDocument	Gets the master document.
	Metadata	Gets the metadata for the script object. (Inherited from BCScriptObject.)
	Modified	Gets the date when the document was last edited.
	ModifiedBy	Gets the person who last edited the document.
	ParentFolder	Gets the parent folder of the object.
	ParentProject	Gets the parent project.
	Path	Gets the relative path from the root of the vault.
	Properties	Gets the collection of named properties of the document.
	Property	Obsolete. Gets the collection of named properties of the document.
	Revision	Gets or sets the revision number.
	ShareID	Gets a server ShareID to get a transaction document from another process.
	Size	Gets the file size of the document.
	StatusText	Gets or sets the text to display for the current workflow status.
	UnderlyingObject	Gets the underlying wrapped object. (Inherited from DisposableObject.)
	UnderRevisionBy	Gets a user name who owns the working copy of the document.
	VersionID	Gets the value that uniquely identifies the current document version.
	WorkFlowAction	Gets the description of the action associated with the current workflow state.
	WorkFlowManager	Gets the person assigned to manage the workflow of the document.
	WorkFlowState	Gets the current workflow state.
	WorkFlowTodoPerson	Gets the person assigned to take action on the document.

Top

Methods

	Name	Description
	ApplyPropertyValues	Commits all the changes made to the properties since it was loaded or since the last time the ApplyPropertyValues method was called.
	CalculateFileType	Calculates the type of the document.
	CallRemote(String, String, String, String, String)	Evaluates an expression on the specified remote vault.
	CallRemote(String, String, String, String, String, Object)	Executes an expression on the specified remote vault.
	CallRemote(String, String, String, String, String, Object)	Executes an expression on the specified remote vault.
	CanEditProperty	Determines whether a property with the specified name can be edited.
	ChangeDocumentType	Changes the type of the document.
	ChangeManager	Sets a new workflow manager for the document.
	ChangeTodoPerson	Sets a new to-do person for the document.
	ChangeWorkflowState	Moves the document to another workflow state.
	ClearRedlines	Clears the document redlines.
	ConfirmMerged	Confirms Merged with Master.
	ConfirmSuperseded	Confirms Superseded by Master.
	Dispose	Releases the underlying wrapped object explicitly. (Inherited from DisposableObject.)
	Equals	(Inherited from Object.)
	ExecTransition(String)	Executes a workflow transition.
	ExecTransition(String, String)	Executes a workflow transition.
	ExecTransition(String, String, IEnumerableString)	Executes a workflow transition.
	Finalize	(Inherited from Object.)
	GetExpectedTransitionResult	Returns an expected result of the specified transition.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	IsUniqueValue	Determines whether there are no other documents with the specified property value.
	LockLWS	Locks a local workspace copy of the document.
	LockMasterDocument	Locks the master document.
	Log	Appends a text message to the document log.
	MemberwiseClone	(Inherited from Object.)
	Migrate(String)	Migrates the document to a new configurable workflow.
	Migrate(String, String)	Migrates the document to a new configurable workflow.
	Migrate(String, String, String)	Migrates the document to a new configurable workflow.
	MoveTo(BCSFolder)	Moves the document into the specified folder.
	MoveTo(BCSFolder, SMoveMode)	Moves the document into the specified folder.
	OnDispose	The method is called on the Dispose method call. Derived classes should override the method to perform custom disposing. (Inherited from DisposableObject.)
	ReassignManagers(IEnumerableString)	Assigns workflow managers for the document.
	ReassignManagers(IEnumerableString, String)	Assigns workflow managers for the document.
	ReassignToDoPersons(IEnumerableString)	Assigns workflow to-do persons for the document.
	ReassignToDoPersons(IEnumerableString, String)	Assigns workflow to-do persons for the document.
	ReleaseChange	Releases a working copy (Quick Change).
	Reroute(String)	Reroutes the document in the workflow to a new state.
	Reroute(String, String)	Reroutes the document in the workflow to a new state.
	Reroute(String, String, IEnumerableString)	Reroutes the document in the workflow to a new state.
	ResetPropertyValues	Refreshes the property values (revokes any changes).
	RevokeChange	Revokes a working copy (Quick Change).
	RevokeWorkflow	Revokes the document from a workflow.
	StartChange	Starts a working copy (Quick Change).
	StartWorkFlow(String)	Initiates a workflow for the document.
	StartWorkFlow(String, String)	Initiates a workflow for the document.
	StartWorkFlow(String, String, String)	Initiates a workflow for the document.
	StartWorkFlow(String, String, String, IEnumerableString, IEnumerableString)	Initiates a workflow for the document.
	ThrowIfDisposed	Throws the ObjectDisposedException exception if the underlying object has been disposed. (Inherited from DisposableObject.)
	ToString	(Inherited from Object.)
	UnlockLWS	Unlocks a local workspace copy of the document.
	UnlockMasterDocument	Unlocks the master document.

Top

Reference

BlueCieloECM.InnoCielo.Meridian.Scripting Namespace