A transmittal set is used to package drawing and resource files for sharing or archiving.
Once the Transmittal Object library has been referenced by a project and imported or included as part of a code module as needed, a transmittal set can be created. The ITransmittalOperation interface represents a transmittal set. You will use the methods of the ITransmittalOperation interface to add drawing files to a transmittal set and create a transmittal package from a transmittal set.
An instance of the ITransmittalOperation interface can be created by using one of the following:
Dim tro As TransmittalOperation = New TransmittalOperation()
TransmittalOperation tro = new TransmittalOperation();
Dim tro As New TransmittalOperation
Prior to adding files to a transmittal set, the settings of the transmittal set must first be configured. The settings of a transmittal set are stored in a TransmittalInfo object and the TransmittalInfo object of a TransmittalOperation object can be obtained with the getTransmittalInfoInterface() method. The following demonstrates how to get the TransmittalInfo object of a transmittal set.
Dim ti As TransmittalInfo = tro.getTransmittalInfoInterface() ' Change the properties of the transmittal object ti.destinationRoot = "C:\TransmittalSet\Project1\" ti.preserveSubdirs = True
TransmittalInfo ti = tro.getTransmittalInfoInterface(); // Change the properties of the transmittal object ti.destinationRoot = "C:\\TransmittalSet\\Project1\\"; ti.preserveSubdirs = true;
Dim ti As TransmittalInfo Set ti = tro.getTransmittalInfoInterface ' Change the properties of the transmittal object ti.destinationRoot = "C:\TransmittalSet\Project1\" ti.preserveSubdirs = vbTrue
For information on adding files to a transmittal set, see "About Adding Files to a Transmittal Set."
A transmittal set can be used to determine which external files are referenced by one or more drawings, but a transmittal set is often used to package all the files related to a project for sharing with others or archiving. The createTransmittalPackage() method of a TransmittalOperation object creates a transmittal package based on the properties. The organization of the files in the transmittal package is determined by the values specified for the properties of the TransmittalInfo object assigned to the TransmittalOperation object. When the createTransmittalPackage() method is executed, the files listed in the files graph of the transmittal set are copied and saved to the path specified by the destinationRoot property of the TransmittalInfo object. The following demonstrates how to create a transmittal package.
tro.createTransmittalPackage()
tro.createTransmittalPackage();
tro.createTransmittalPackage
When a transmittal package is created, a report containing information about the files referenced in a transmittal set can be created. The getTransmittalReport() method of a TransmittalOperation object returns a string that can be displayed on screen or written to a file. If the report is written to a file, it should be added to the transmittal set for inclusion in the transmittal package. The following demonstrates how to get the report text from a transmittal set.
Dim tr As String = tro.getTransmittalReport()
string tr = tro.getTransmittalReport();
Dim tr As String tr = tro.getTransmittalReport