WorkSession.AssembleDocuments Method (String)

WorkSession AssembleDocuments Method (String)

AssembleDocuments causes all contiguous pending document work items (from CurrentWorkItem onwards) to be assembled, and returns the assembled documents.

Namespace: HotDocs.Sdk.Server
Assembly: HotDocs.Sdk.Server (in HotDocs.Sdk.Server.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy to Clipboard Print

public Document[] AssembleDocuments(
	string logRef
)

public Document[] AssembleDocuments(
	string logRef
)

Parameters

logRef: Type: System String
A string identifying the current user or transcation, to be included in HotDocs log entries. This is necessary if you wish to track log entries back to specific users during analysis or troubleshooting.

Return Value

Type: Document

[Missing <returns> documentation for "M:HotDocs.Sdk.Server.WorkSession.AssembleDocuments(System.String)"]

Remarks

If AssembleDocuments is called when the current work item is not a document (i.e. when there are currently no documents to assemble), it will return an empty array of results without performing any work.

If you need to take any actions before or after each assembly, use the alternate constructor that accepts delegates.

TODO: include a table that shows the relationship between members of Document, AssemblyResult, WorkSession and DocumentWorkItem.