GetAt Method (ActiveX/ATO)

Returns the file at the specified index in the files graph of a transmittal set.

Supported platforms: Windows only

Namespace: TRANSMITTALLib

Assembly: acETransmit20.tlb

Signature

VB.NET:

RetVal = object.getAt(nIndex)

C#:

RetVal = object.getAt(nIndex);

object

Type: TransmittalFilesGraph object

The object this method applies to.

nIndex

Access: Input-only

Type: Long

Index of the file in the files graph to retrieve.

Return Value (RetVal)

Type: TransmittalFile object

The file at the specified index in the files graph of the transmittal set.

Remarks

No additional remarks.

Release Information

Releases: AutoCAD 2005 and later

History

• The ITransmittalFilesGraph2 interface was merged with the ITransmittalFilesGraph interface in the AutoCAD 2010 version of the library.
• The getAt method was also introduced with the ITransmittalFilesGraph2 interface in the AutoCAD 2005 version of the library.
• The getAt method was originally introduced with the ITransmittalFilesGraph interface in the AutoCAD 2004 version of the library, but was marked for Autodesk internal use only.

Examples

VB.NET:

' Custom command to work with the transmittal file graph
<CommandMethod("FilesGraph")> _
Public Shared Sub FilesGraph()

    ' 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\")

    ' Get the root file of the transmittal file graph
    Dim tfRoot As TransmittalFile = tro.getTransmittalGraphInterface().getRoot()

    ' Add a drawing file to a transmittal set
    Dim tfFirst As TransmittalFile = Nothing
    tro.addDrawingFile("C:\AutoCAD\Sample\Sheet Sets\Architectural\A-01.dwg", tfFirst)

    ' Add a second drawing file to a transmittal set
    Dim tfSecond As TransmittalFile = Nothing
    tro.addDrawingFile("C:\AutoCAD\Sample\Sheet Sets\Architectural\A-02.dwg", tfSecond)

    ' Display the name and path of the first file of the transmittal file graph
    MsgBox("File name and path: " & tro.getTransmittalGraphInterface().getAt(0).sourcePath)

    ' Display the number of files in the transmittal file graph
    MsgBox("Number of Files in Graph: " & tro.getTransmittalGraphInterface().getNumberOfFiles(vbTrue, vbTrue).ToString())

    ' Display the number of dependees
    MsgBox("Number of Dependees: " & tfFirst.numberOfDependees.ToString())

    ' Create a reference from the first file to the newly added file
    tro.getTransmittalGraphInterface().addEdge(tfSecond, tfFirst)

    ' Display the number of dependees
    MsgBox("Number of Dependees: " & tfFirst.numberOfDependees.ToString())

    ' Remove a reference from the first file
    tro.getTransmittalGraphInterface().removeEdge(tfSecond, tfFirst)
    ' Display the number of dependees
    MsgBox("Number of Dependees: " & tfFirst.numberOfDependees.ToString())

    ' Resets the transmittal graph
    tro.getTransmittalGraphInterface().reset()

    ' Display the number of files in the transmittal file graph
    MsgBox("Number of Files in Graph: " & tro.getTransmittalGraphInterface().getNumberOfFiles(vbTrue, vbTrue).ToString())

    ' Release the tramnsmittal operation
    tro = Nothing
End Sub

C#:

// Custom command to work with the transmittal file graph
[CommandMethod("FilesGraph")]
public static void FilesGraph()
{
    // Create a transmittal operation
    TransmittalOperation tro = new TransmittalOperation();

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

    // Get the root file of the transmittal file graph
    TransmittalFile tfRoot = tro.getTransmittalGraphInterface().getRoot();

    // Add a drawing file to a transmittal set
    TransmittalFile tfFirst = null;
    tro.addDrawingFile(@"C:\AutoCAD\Sample\Sheet Sets\Architectural\A-01.dwg", out tfFirst);

    // Add a second drawing file to a transmittal set
    TransmittalFile tfSecond = null;
    tro.addDrawingFile(@"C:\AutoCAD\Sample\Sheet Sets\Architectural\A-02.dwg", out tfSecond);

    // Display the name and path of the first file of the transmittal file graph
    System.Windows.MessageBox.Show("File name and path: " + tro.getTransmittalGraphInterface().getAt(0).sourcePath);

    // Display the number of files in the transmittal file graph
    System.Windows.MessageBox.Show("Number of Files in Graph: " + tro.getTransmittalGraphInterface().getNumberOfFiles(1, 1).ToString());

    // Display the number of dependees
    System.Windows.MessageBox.Show("Number of Dependees: " + tfFirst.numberOfDependees.ToString());

    // Create a reference from the root file to the newly added file
    tro.getTransmittalGraphInterface().addEdge(tfSecond, tfFirst);

    // Display the number of dependees
    System.Windows.MessageBox.Show("Number of Dependees: " + tfFirst.numberOfDependees.ToString());

    // Remove a reference from the root file
    tro.getTransmittalGraphInterface().removeEdge(tfSecond, tfFirst);

    // Display the number of dependees
    System.Windows.MessageBox.Show("Number of Dependees: " + tfFirst.numberOfDependees.ToString());

    // Resets the transmittal graph
    tro.getTransmittalGraphInterface().reset();

    // Display the number of files in the transmittal file graph
    System.Windows.MessageBox.Show("Number of Files in Graph: " + tro.getTransmittalGraphInterface().getNumberOfFiles(1, 1).ToString());

    // Release the tramnsmittal operation
    tro = null;
}