Class Transmittal

Items combined together into a single package that is to be sent off for approval

Inheritance

System.Object

Transmittal

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: DesignData.SDS2.Detail

Assembly: DesignData.SDS2.Detail.dll

Syntax

public sealed class Transmittal

Constructors

Transmittal()

Start a new transmittal

Declaration

public Transmittal()

Properties

AddressOne

The first address line for this transmittal

Declaration

public string AddressOne { get; set; }

Property Value

Type	Description
System.String

AddressTwo

The second address line for this transmittal

Declaration

public string AddressTwo { get; set; }

Property Value

Type	Description
System.String

City

The city this transmittal is being sent from

Declaration

public string City { get; set; }

Property Value

Type	Description
System.String

Due

The date this transmittal is due back

Declaration

public DateTime? Due { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

From

Contact information for the sender of the transmittal.

Declaration

public TransmittalContact From { get; set; }

Property Value

Type	Description
TransmittalContact

Logo

A copy of the raw byte array representing the logo image. This image is placed in the top right corner of the cover page. If necessary the image is scaled to fit inside a 193x100 rectangle. Loadable images include .jpg, .gif, .tif, and .png files.

Declaration

public byte[] Logo { get; set; }

Property Value

Type	Description
System.Byte[]

Examples

            Transmittal transmittal = new Transmittal();
            transmittal.Logo = System.IO.File.ReadAllBytes("logo193x100.jpg");

ProjectName

The name of the project this transmittal pertains to

Declaration

public string ProjectName { get; set; }

Property Value

Type	Description
System.String

ProjectNumber

The number of the project this transmittal pertains to

Declaration

public string ProjectNumber { get; set; }

Property Value

Type	Description
System.String

Remarks

Remarks included on the transmittal cover page

Declaration

public string Remarks { get; set; }

Property Value

Type	Description
System.String

Sent

The date this transmittal will be sent

Declaration

public DateTime? Sent { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

State

The state this transmittal is being sent from

Declaration

public string State { get; set; }

Property Value

Type	Description
System.String

To

Contact information for the main recipient of the transmittal.

Declaration

public TransmittalContact To { get; set; }

Property Value

Type	Description
TransmittalContact

TransmittalNumber

The number of this transmittal

Declaration

public string TransmittalNumber { get; set; }

Property Value

Type	Description
System.String

ZipCode

The zip code this transmittal is being sent from

Declaration

public string ZipCode { get; set; }

Property Value

Type	Description
System.String

Methods

Add(TransmittalCC)

Add a cc for a transmittal package

Declaration

public void Add(TransmittalCC cc)

Parameters

Type	Name	Description
TransmittalCC	cc

Add(TransmittalItem)

Add an item to a transmittal package

Declaration

public void Add(TransmittalItem transmittal)

Parameters

Type	Name	Description
TransmittalItem	transmittal

Finalize()

Declaration

protected void Finalize()

GeneratePDF()

Create the PDF for this transmittal and return it as a byte array, to be written diretly to a .pdf file

Declaration

public byte[] GeneratePDF()

Returns

Type	Description
System.Byte[]

GeneratePDFs()

Create a series of PDFs, one per drawing, returned as a map from the intended PDF filename to a byte array for the PDF.

For the links to work, these must be written to files with the exact name used as the key of this map. Any other name will break the links between drawings.

Declaration

public Dictionary<string, byte[]> GeneratePDFs()

Returns

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Byte[]>