PublicAPI.Docflow.Document

ELMA API Documentation

Document

Methods

	Name	Description
	AddComment(Document, Comment)	Add a comment
	AddComment(Document, String)	Add a comment to the document
	AddComment(Document, String, User, IEnumerable DocumentAttachment , IEnumerable Attachment )	Add a comment to the document
	AddDocumentCreatePermission(OrganizationItem, Type)	Add the organization item permissions to create documents of a certain type
	AddDocumentCreatePermission(User, Type)	Add the user permissions to create documents of a certain type
	AddDocumentCreatePermission(UserGroup, Type)	Add the user group permissions to create documents of a certain type
	AddEditPermission(Document, OrganizationItem)	Method for adding permissions to edit the document
	AddEditPermission(Document, User)	Method for adding permissions to edit the document
	AddEditPermission(Document, UserGroup)	Method for adding permissions to edit the document
	AddFullAccessPermission(Document, OrganizationItem)	Method for adding the full access to the document
	AddFullAccessPermission(Document, User)	Method for adding the full access to the document
	AddFullAccessPermission(Document, UserGroup)	Method for adding the full access to the document
	AddManageAccessPermission(Document, OrganizationItem)	Method for adding access permissions to the document
	AddManageAccessPermission(Document, User)	Method for adding access permissions to the document
	AddManageAccessPermission(Document, UserGroup)	Grant admin permissions to this document
	AddQuestion(Document, Question)	Add a question to the document
	AddQuestion(Document, User, String, IEnumerable Attachment , Boolean)	Add a question to the document
	AddViewPermission(Document, OrganizationItem)	Grant the organization item users permissions to view the document
	AddViewPermission(Document, User)	Grant the user permissions to view the document
	AddViewPermission(Document, UserGroup)	Method for adding a user group permissions to view the document
	Archive	Send Document to archive
	Count	Returns the total number of objects of this type
	Count(IEntityFilter)	Get Total Number of Objects by Filter
	Create	Create New Entity (without a Database entry)
	Create(Folder, String)	Create a document of a certain type. Creates an object without saving to the database
	Create(BinaryFile, Folder, String)	Create a document of a certain type
	CreateLink	Create document link
	Delete	Delete Entity from Database
	DeleteDocumentCreatePermission(OrganizationItem, Type)	Delete the organization item permissions to create documents of a certain type
	DeleteDocumentCreatePermission(User, Type)	Delete the user permissions to create documents of a certain type
	DeleteDocumentCreatePermission(UserGroup, Type)	Delete the user group permissions to create documents of a certain type
	DeleteLinks	Delete all the document links
	DeletePermissions(Document, OrganizationItem)	Delete the organization item's permissions to the document
	DeletePermissions(Document, User)	Delete the user's permissions to the document
	DeletePermissions(Document, UserGroup)	Delete the user group's permissions to the document
	Filter	Creates an assistant for working with the "Document" object filter
	Find(FetchOptions)	Find objects according to fetch options
	Find(String)	Find objects according to the filter in the EQL language
	Find(IEntityFilter, FetchOptions)	Fing objects according to fetch options and filter
	FindByIdArray	Find All Objects by Array IDs
	GetAllLinkedDocuments	Get all the linked documents
	GetFileByDocumentId	Get the file of the current document version
	IsDirty	Check, if there are unsaved changes in the object
	IsNew	Check, if the object is new (not saved in the database)
	Load(Guid)	Load by UID. If not found, an exception is invoked
	Load(Int64)	Load by ID. If not found, an exception is invoked
	LoadOrCreate(Guid)	Load by ID. If not found, the new object is returned
	LoadOrCreate(Int64)	Load by ID. If not found, the new object is returned
	LoadOrNull(Guid)	Load by UID. If not found, null is returned
	LoadOrNull(Int64)	Load by ID. If not found, null is returned
	LoadRegVariant	Load registration variant by ID
	Move	Move the document to another folder
	Refresh	Refresh (read over) Object from Database
	Register(Document, RegistrationVariant)	Register document using a registration variant
	Register(Document, Depository, DocumentFlowType)	Register document by category and document flow
	Register(Document, RegistrationVariant, ReservedRegNumber)	Register document using a registration variant
	Register(Document, Depository, DocumentFlowType, ReservedRegNumber)	Register document by category and document flow
	Register(Document, RegistrationVariant, ReservedRegNumber, Nullable DateTime )
	Register(Document, Depository, DocumentFlowType, ReservedRegNumber, Nullable DateTime )
	Save	Save Object to Database
	UnArchive	Extract the document from the archive

Properties

	Name	Description
	TypeUid	Returns the unique object identifier "Document"

Remarks

Section containing methods for managing documents

Examples

Create a document to work with. The document will be stored in the folder created here:

Copy to Clipboard Print

var myDocument = PublicAPI.Docflow.Types.File.Create(context.File, myFolder, "New Sample Document");

var myDocument = PublicAPI.Docflow.Types.File.Create(context.File, myFolder, "New Sample Document");

context.File - file that will be a default version of the document

After additions of document versions and changes of theirs statuses , register the document

Copy to Clipboard Print

//load the registration variant required to register the document 
var regVariant = PublicAPI.Docflow.Document.LoadRegVariant(1);
//register the document
PublicAPI.Docflow.Document.Register(myDocument, regVariant);

//load the registration variant required to register the document 
var regVariant = PublicAPI.Docflow.Document.LoadRegVariant(1);
//register the document
PublicAPI.Docflow.Document.Register(myDocument, regVariant);

The registration function is available only with configured records classification scheme and registration variants

Add the document "edit" permission to the user

Copy to Clipboard Print

PublicAPI.Docflow.Document.AddEditPermission(myDocument, context.User);

PublicAPI.Docflow.Document.AddEditPermission(myDocument, context.User);

context.User is the user to whom the permission is added. If the user already has this permission, no changes will be applied

Please save the object in the database to ensure it's functioning properly

Copy to Clipboard Print

myDocument.Save();

myDocument.Save();

You can archive your document or restore it from the archive

Copy to Clipboard Print

//Archive the document
PublicAPI.Docflow.Document.Archive(myDocument);
//restore the document from archive
PublicAPI.Docflow.Document.UnArchive(myDocument);

//Archive the document
PublicAPI.Docflow.Document.Archive(myDocument);
//restore the document from archive
PublicAPI.Docflow.Document.UnArchive(myDocument);

Add a comment to the document

Copy to Clipboard Print

PublicAPI.Docflow.Document.AddComment(myDocument, "The document is successfully restored from the archive");

PublicAPI.Docflow.Document.AddComment(myDocument, "The document is successfully restored from the archive");

Learn how to send the document for acquaintance, consideration and approval here