Find Query Tables and List Objects related to External Data Connections

Sometimes, you need to find out Query Tables and List Objects related to some External Data Connection. Query Tables are related to External Data Connection object with Connection Id, while List Objects are related to a Query Table.

Find Query Tables and List Objects related to External Data Connections

The following sample codes with sample excel file explain how to find Query Tables and List Objects related to External Data Connection.

// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-.NET
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);

// Load workbook object
Workbook workbook = new Workbook(dataDir + "sample.xlsm");

// Check all the connections inside the workbook
for (int i = 0; i < workbook.DataConnections.Count; i++)
{
    Aspose.Cells.ExternalConnections.ExternalConnection externalConnection = workbook.DataConnections[i];
    Console.WriteLine("connection: " + externalConnection.Name);
    PrintTables(workbook, externalConnection);
    Console.WriteLine();
}

Console.WriteLine("Press any key to continue...");
Console.ReadKey();

// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-.NET
public static void PrintTables(Workbook workbook, Aspose.Cells.ExternalConnections.ExternalConnection ec)
{
    // Iterate all the worksheets
    for (int j = 0; j < workbook.Worksheets.Count; j++)
    {
        Worksheet worksheet = workbook.Worksheets[j];

        // Check all the query tables in a worksheet
        for (int k = 0; k < worksheet.QueryTables.Count; k++)
        {
            Aspose.Cells.QueryTable qt = worksheet.QueryTables[k];

            // Check if query table is related to this external connection
            if (ec.Id == qt.ConnectionId
                && qt.ConnectionId >= 0)
            {
                // Print the query table name and print its refersto range
                Console.WriteLine("querytable " + qt.Name);
                string n = qt.Name.Replace('+', '_').Replace('=', '_');
                Name name = workbook.Worksheets.Names["'" + worksheet.Name + "'!" + n];
                if (name != null)
                {
                    Range range = name.GetRange();
                    if (range != null)
                    {
                        Console.WriteLine("refersto: " + range.RefersTo);
                    }
                }
            }
        }

        // Iterate all the list objects in this worksheet
        for (int k = 0; k < worksheet.ListObjects.Count; k++)
        {
            ListObject table = worksheet.ListObjects[k];

            // Check the data source type if it is query table
            if (table.DataSourceType == Aspose.Cells.Tables.TableDataSourceType.QueryTable)
            {
                // Access the query table related to list object
                QueryTable qt = table.QueryTable;

                // Check if query table is related to this external connection
                if (ec.Id == qt.ConnectionId
                && qt.ConnectionId >= 0)
                {
                    // Print the query table name and print its refersto range
                    Console.WriteLine("querytable " + qt.Name);
                    Console.WriteLine("Table " + table.DisplayName);
                    Console.WriteLine("refersto: " + worksheet.Name + "!" + CellsHelper.CellIndexToName(table.StartRow, table.StartColumn) + ":" + CellsHelper.CellIndexToName(table.EndRow, table.EndColumn));
                }
            }
        }
    }
}

The following is the console output of running the above sample codes with this sample excel file.

 connection: AAPL Connection

querytable hp?s=AAPL+Historical+Prices

refersto: =Sheet1!$Q$1:$W$69

connection: BOSL066360W7_SQLEXPRESS Test

querytable BOSL066360W7_SQLEXPRESS Test

Table Table_BOSL066360W7_SQLEXPRESS_Test

refersto: Sheet1!A1:B3

connection: BOSL066360W7_SQLEXPRESS Test1

querytable BOSL066360W7_SQLEXPRESS Test_1

Table Table_BOSL066360W7_SQLEXPRESS_Test_1

refersto: Sheet1!D1:E2

connection: UWTI Connection

querytable hp?s=UWTI+Historical+Prices

refersto: =Sheet1!$H$1:$N$69