AddSheetSelset Method (ActiveX/ATO)

Adds the drawing files in a sheet set selection to a transmittal set.

Supported platforms: Windows only

Namespace: TRANSMITTALLib

Assembly: AcETransmit19.tlb

Signature

VB.NET:

object.addSheetSelset pISheetSelset, includeSSFiles

C#:

object.addSheetSelset(pISheetSelset, includeSSFiles);

object

Type: TransmittalOperation object

The object this method applies to.

pISheetSelset

Access: Input-only

Type: AcSmSheetSelSet

The AcSmSheetSelSet object is defined in the AcSmComponents library.

includeSSFiles

Access: Input-only

Type: Long

• 0 (False): Do not include the sheet set (DST) and support files referenced by the DST file
• 1 (True): Include the sheet set (DST) and support files referenced by the DST file

Return Value (RetVal)

No return value.

Remarks

No additional remarks.

Release Information

Releases: AutoCAD 2005 and later

• AcETransmit19.tlb - AutoCAD 2015 and later
• AcETransmit18.tlb - AutoCAD 2010 through AutoCAD 2014
  • The ITransmittalOperation2 interface was merged with the ITransmittalOperation interface in the AutoCAD 2010 version of the library.
• AcETransmit16.tlb - AutoCAD 2005 through AutoCAD 2009
  • The addSheetSelset method was introduced with the ITransmittalOperation2 interface in the AutoCAD 2005 version of the library.

Examples

VB.NET:

' Custom command to create a transmittal package from a sheet selection set in a sheet set
<CommandMethod("eTransmitDSTFile_SheetSelSet")> _
Public Shared Sub eTransmitDSTFile_SheetSelSet()

    ' Create a transmittal operation
    Dim tro As TransmittalOperation = New TransmittalOperation()

    ' Setup the transmittal behavior
    Dim ti As TransmittalInfo = _
        TransInfo(tro.getTransmittalInfoInterface(), "C:\Users\Public\TransmittalAPITest\")

    ' Add a sheet selection set from a sheet set 
    ' and the drawings contained in it
    ' Get a reference to the Sheet Set Manager object
    Dim sheetSetManager As IAcSmSheetSetMgr = New AcSmSheetSetMgr

    ' Open a Sheet Set file
    Dim sheetSetDatabase As AcSmDatabase = _
        sheetSetManager.OpenDatabase("C:\AutoCAD\Sample\Sheet Sets\Architectural\IRD Addition.dst", False)

    ' Get all the SheetSelSets in the sheet set
    Dim sheetSelSetEnum As IAcSmEnumSheetSelSet = _
        sheetSetDatabase.GetSheetSet().GetSheetSelSets().GetEnumerator()

    ' Get the first SheetSelSet
    Dim sheetSelSet As AcSmSheetSelSet = sheetSelSetEnum.Next()
    Dim sheetSelSetFound As AcSmSheetSelSet = Nothing

    ' Check to the see if it is the requested SheetSelSet, 
    ' if not get the next and check
    While Not sheetSelSet Is Nothing
        If UCase(sheetSelSet.GetName()). _
                        Equals("ELEVATIONS") = True Then
            sheetSelSetFound = sheetSelSet
        End If

        sheetSelSet = sheetSelSetEnum.Next()
    End While

    ' Get the sheet set from the database and process it
    ' 0 - Do not include DST file or support files referenced 
    '     by the DST file (templates, blocks, ...)
    ' 1 - Include DST file, all files referenced by the 
    '     DST file, its sheets and references
    If Not sheetSelSetFound Is Nothing Then
        tro.addSheetSelset(sheetSelSetFound, 0)
    End If

    ' Close the sheet set
    sheetSetManager.Close(sheetSetDatabase)

    ' Create the transmittal package
    ' Files are copied and resaved to the path specified by the destinationRoot property
    ' and the other settings of the TransmittalInfo object.
    tro.createTransmittalPackage()
End Sub

C#:

// Custom command to create a transmittal package from a sheet selection set in a sheet set
[CommandMethod("eTransmitDSTFile_SheetSelSet")]
public static void eTransmitDSTFile_SheetSelSet()
{
    // Create a transmittal operation
    TransmittalOperation tro = new TransmittalOperation();

    // Setup the transmittal behavior
    TransmittalInfo ti =
        TransInfo(tro.getTransmittalInfoInterface(), "C:\\Users\\Public\\TransmittalAPITest\\");

    // Add a sheet set and the drawings referenced in it
    // Get a reference to the Sheet Set Manager object
    IAcSmSheetSetMgr sheetSetManager = new AcSmSheetSetMgr();

    // Open a sheet set (DST) file
    AcSmDatabase sheetSetDatabase =
        sheetSetManager.OpenDatabase("C:\\AutoCAD\\Sample\\Sheet Sets\\Architectural\\IRD Addition.dst", false);

    // Get all the SheetSelSets in the sheet set
    IAcSmEnumSheetSelSet sheetSelSetEnum =
        sheetSetDatabase.GetSheetSet().GetSheetSelSets().GetEnumerator();

    // Get the first SheetSelSet
    AcSmSheetSelSet sheetSelSet = sheetSelSetEnum.Next();
    AcSmSheetSelSet sheetSelSetFound = null;

    // Check to the see if it is the requested SheetSelSet, 
    // if not get the next and check
    while (sheetSelSet != null)
    {
        if (sheetSelSet.GetName().ToUpper().Equals("ELEVATIONS") == true)
        {
            sheetSelSetFound = sheetSelSet;
        }

        sheetSelSet = sheetSelSetEnum.Next();
    }

    // Get the sheet set from the database and process it
    // 0 - Do not include DST file or support files referenced 
    //     by the DST file (templates, blocks, ...)
    // 1 - Include DST file, all files referenced by the 
    //     DST file, its sheets and references
    if (sheetSelSet != null)
    {
        tro.addSheetSelset(sheetSelSet, 1);
    }

    // Close the sheet set
    sheetSetManager.Close(sheetSetDatabase);

    // Create the transmittal package
    // Files are copied and resaved to the path specified by the destinationRoot property
    // and the other settings of the TransmittalInfo object.
    tro.createTransmittalPackage();
}