TargetSubPath Property (ActiveX/ATO)

Specifies the subdirectory in which the file will be placed during the creation of the transmittal package.

Supported platforms: Windows only

Namespace: TRANSMITTALLib

Assembly: AcETransmit19.tlb

Signature

VBA/VB.NET/C#:

object.targetSubPath

object

Type: TransmittalFile

The object this property applies to.

Property Value

Read-only: No

Type: String

The relative path to the file in the transmittal package.

Remarks

An empty string is used to specify the root folder. The root folder is defined by the destinationRoot property.

Release Information

Releases: AutoCAD 2005 and later

• AcETransmit19.tlb - AutoCAD 2015 and later
• AcETransmit18.tlb - AutoCAD 2010 through AutoCAD 2014
  • The ITransmittalFile2 interface was merged with the ITransmittalFile interface in the AutoCAD 2010 version of the library.
• AcETransmit16.tlb - AutoCAD 2005 through AutoCAD 2009
  • The targetSubPath property was introduced with the ITransmittalFile2 interface in the AutoCAD 2005 version of the library.

Examples

VB.NET:

' Custom command that information about a file
<CommandMethod("FileInfo")> _
Public Shared Sub FileInfo()
    ' 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\")

    ' Define file to add to the transmittal
    Dim tf As TransmittalFile = Nothing
    Dim dwgFile As String = "C:\Program Files\Autodesk\AutoCAD 2016\Sample\Sheet Sets\Architectural\A-01.dwg"

    ' Add file to transmittal and parse its information
    If tro.addDrawingFile(dwgFile, tf) = AddFileReturnVal.eFileAdded Then
        ' Get the current editor
        Dim acEditor As Editor = Application.DocumentManager.MdiActiveDocument.Editor

        ' Output information about the root file of the transmittal set
        ' Source and full target path to the file
        acEditor.WriteMessage(Environment.NewLine & "Source Path: " & tf.sourcePath)
        acEditor.WriteMessage(Environment.NewLine & "Full Path: " & tf.fullPathForTarget)
        acEditor.WriteMessage(Environment.NewLine & "Target SubPath: " & tf.targetSubPath)

        ' See if the root file is a drawing
        If System.IO.Path.GetExtension(tf.sourcePath).ToUpper() = ".DWG" Then
            ' Number of dependents and dependees
            acEditor.WriteMessage(Environment.NewLine & "# of Dependents: " & tf.numberOfDependents.ToString())
            acEditor.WriteMessage(Environment.NewLine & "# of Dependees: " & tf.numberOfDependees.ToString())
        End If

        ' Output file system information about the root file
        acEditor.WriteMessage(Environment.NewLine & "File Exists: " & tf.fileExists.ToString())
        acEditor.WriteMessage(Environment.NewLine & "File Size: " & tf.fileSize.ToString())
        acEditor.WriteMessage(Environment.NewLine & "File Type: " & tf.FileType.ToString())
        acEditor.WriteMessage(Environment.NewLine & "Include in transmittal: " & tf.includeInTransmittal.ToString())
        acEditor.WriteMessage(Environment.NewLine & "Date/Time: " & tf.lastModifiedTime.ToLongDateString() & "  " &
                                                                    tf.lastModifiedTime.ToLongTimeString())
        acEditor.WriteMessage(Environment.NewLine & "Type: " & tf.type.ToString())
        acEditor.WriteMessage(Environment.NewLine & "Version: " & tf.version.ToString())
    End If
End Sub

C#:

// Custom command that information about a file
[CommandMethod("FileInfo")]
public static void FileInfo()
{
    // Create a transmittal operation
    TransmittalOperation tro = new TransmittalOperation();

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

    // Define file to add to the transmittal
    TransmittalFile tf = null;
    string dwgFile = @"C:\Program Files\Autodesk\AutoCAD 2016\Sample\Sheet Sets\Architectural\A-01.dwg";

    // Add file to transmittal and parse its information
    if (tro.addDrawingFile(dwgFile, out tf) == AddFileReturnVal.eFileAdded)
    {
        // Get the current editor
        Editor acEditor = Application.DocumentManager.MdiActiveDocument.Editor;

        // Output information about the root file of the transmittal set
        // Source and full target path to the file
        acEditor.WriteMessage(Environment.NewLine + "Source Path: " + tf.sourcePath);
        acEditor.WriteMessage(Environment.NewLine + "Full Path: " + tf.fullPathForTarget);
        acEditor.WriteMessage(Environment.NewLine + "Target SubPath: " + tf.targetSubPath);

        // See if the root file is a drawing
        if (Path.GetExtension(tf.sourcePath).ToUpper() == ".DWG")
        {
            // Number of dependents and dependees
            acEditor.WriteMessage(Environment.NewLine + "# of Dependents: " + tf.numberOfDependents.ToString());
            acEditor.WriteMessage(Environment.NewLine + "# of Dependees: " + tf.numberOfDependees.ToString());
        }

        // Output file system information about the root file
        acEditor.WriteMessage(Environment.NewLine + "File Exists: " + tf.fileExists.ToString());
        acEditor.WriteMessage(Environment.NewLine + "File Size: " + tf.fileSize.ToString());
        acEditor.WriteMessage(Environment.NewLine + "File Type: " + tf.FileType.ToString());
        acEditor.WriteMessage(Environment.NewLine + "Include in transmittal: " + tf.includeInTransmittal.ToString());
        acEditor.WriteMessage(Environment.NewLine + "Date/Time: " + tf.lastModifiedTime.ToLongDateString() + "  " +
                                                                    tf.lastModifiedTime.ToLongTimeString());
        acEditor.WriteMessage(Environment.NewLine + "Type: " + tf.type.ToString());
        acEditor.WriteMessage(Environment.NewLine + "Version: " + tf.version.ToString());
    }
}