PublicAPI.Docflow.Document.Register

ELMA API Documentation

Access path: PublicAPI.Docflow.Document.Register

Syntax

public string Register(
	Document document,
	Depository deal,
	DocumentFlowType documentFlow,
	ReservedRegNumber reservedRegNumber
)

Parameters

document: Type: Document
Document to register. Object. Access path: PublicAPI.Docflow.Document

deal: Type: Depository
Category to register in. Object. Access path: PublicAPI.Docflow.Objects.Nomenclature.Depository

documentFlow: Type: DocumentFlowType
Document flow to register in. Enumeration. Access path: PublicAPI.Enums.Documents.DocumentFlowType

reservedRegNumber: Type: ReservedRegNumber
Reserved registration number. Object. Access path: PublicAPI.Docflow.Objects.Nomenclature.ReservedRegNumber

Return Value

Type: String
String with the registration number

Examples

Copy to Clipboard Print

//load document by ID 
var doc = PublicAPI.Docflow.Document.Load(3);
//load category by ID 
var deal = PublicAPI.Docflow.Objects.Nomenclature.Depository.Load(3);
//get "Internal" document flow 
var myDocFlow = PublicAPI.Enums.Documents.DocumentFlowType.Internal;

//register the document 
var regNumber = PublicAPI.Docflow.Document.Register(doc, deal, myDocFlow);

//regNumber - registration number of the doc document