Assembly.Status Property

[Read-only] This property tells what state the Assembly object is in.

It can be one or more of the following values from the HDASSEMBLYSTATUS enumeration:

Name Value Description
HDASMSTATUSCONFIRMED 2 The Assembly object is awaiting assembly.
HDASMSTATUSASSEMBLING 4 The Assembly object is being assembled.
HDASMSTATUSCOMPLETED 8 The Assembly object has been assembled and the assembly completed with no errors.
HDASMSTATUSERROR 256 Assembly is complete, but an error occurred during assembly and it did not complete successfully.

Because it can be combination of the above values, an integrator needs to check the bitwise AND of the value and a mask to determine if one of the values is set.

Syntax

HotDocs.HDASSEMBLYSTATUS Status [ get ]

Example

The following Visual C# example displays the status of each assembly in the queue:

public class ExampleCode
{
    static void Main()
    {
        HotDocs.Application app = new HotDocs.Application();
         
        foreach (HotDocs.Assembly assembly in app.Assemblies)
        {
            MessageBox.Show("The status for " + assembly.TemplateTitle + "is " + assembly.Status);
        }
    }
}