[AUTO] Queries and Connections Examples Update

index.json

@@ -8939,6 +8939,166 @@
       "file": "iterate-through-dataconnections-to-identify-sql-type-connections-and-cast-each-to-dbconnection.cs",
       "title": "Iterate through DataConnections to identify SQL type connections and cast each to DBConnection."
     },
+    {
+      "category": "queries-and-connections",
+      "file": "add-a-custom-ribbon-tab-named-data-tools-using-ribbon-xml-definition.cs",
+      "title": "Add a custom ribbon tab named \"Data Tools\" using Ribbon XML definition."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "add-a-tooltip-to-the-custom-ribbon-button-describing-its-function-for-end-users.cs",
+      "title": "Add a tooltip to the custom ribbon button describing its function for end users."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "add-error-handling-to-capture-exceptions-when-an-external-connection-path-is-invalid.cs",
+      "title": "Add error handling to capture exceptions when an external connection path is invalid."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "assign-a-keyboard-shortcut-to-the-custom-ribbon-button-for-quick-access.cs",
+      "title": "Assign a keyboard shortcut to the custom ribbon button for quick access."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "change-description-property-of-a-dbconnection-to-reflect-its-new-purpose-after-migration.cs",
+      "title": "Change Description property of a DBConnection to reflect its new purpose after migration."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "change-the-absolute-path-of-an-external-link-data-source-file-programmatically-for-a-workbook.cs",
+      "title": "Change the absolute path of an external link data source file programmatically for a workbook."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "change-the-path-property-of-an-external-link-in-an-xls-workbook-to-a-network-shared-folder.cs",
+      "title": "Change the Path property of an external link in an XLS workbook to a network shared folder."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "compare-odata-connection-metadata-before-and-after-modification-to-ensure-version-consistency.cs",
+      "title": "Compare OData connection metadata before and after modification to ensure version consistency."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "create-a-backup-of-the-workbook-before-modifying-external-link-paths.cs",
+      "title": "Create a backup of the workbook before modifying external link paths."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "create-a-unit-test-that-validates-external-link-path-changes-and-custom-ribbon-integration.cs",
+      "title": "Create a unit test that validates external link path changes and custom ribbon integration."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "define-a-custom-ribbon-group-within-the-data-tools-tab-for-connection-management-commands.cs",
+      "title": "Define a custom ribbon group within the \"Data Tools\" tab for connection management commands."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "detect-and-list-external-connections-of-type-webquery-across-a-batch-of-workbooks.cs",
+      "title": "Detect and list external connections of type WebQuery across a batch of workbooks."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "detect-hidden-external-links-within-the-workbook-using-the-appropriate-api-and-list-their-source-paths.cs",
+      "title": "Detect hidden external links within the workbook using the appropriate API and list their source paths."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "disable-backgroundrefresh-on-a-sql-dbconnection-to-enforce-sequential-query-execution.cs",
+      "title": "Disable BackgroundRefresh on a SQL DBConnection to enforce sequential query execution."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "disable-preserveformatting-on-a-querytable-to-allow-default-formatting-during-subsequent-refreshes.cs",
+      "title": "Disable PreserveFormatting on a QueryTable to allow default formatting during subsequent refreshes."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "disable-the-default-data-tab-in-the-ribbon-by-removing-its-xml-definition.cs",
+      "title": "Disable the default \"Data\" tab in the ribbon by removing its XML definition."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "document-the-steps-to-customize-the-ribbon-xml-and-change-external-link-paths-in-a-developer-guide.cs",
+      "title": "Document the steps to customize the ribbon XML and change external link paths in a developer guide."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "enable-backgroundrefresh-on-a-webquery-connection-to-avoid-blocking-ui-during-retrieval.cs",
+      "title": "Enable BackgroundRefresh on a WebQuery connection to avoid blocking UI during retrieval."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "enable-preserveformatting-on-a-querytable-to-maintain-cell-styles-after-data-refresh.cs",
+      "title": "Enable PreserveFormatting on a QueryTable to maintain cell styles after data refresh."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "ensure-the-custom-ribbon-ui-loads-correctly-after-changing-external-link-paths.cs",
+      "title": "Ensure the custom ribbon UI loads correctly after changing external link paths."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "ensure-the-solution-complies-with-security-best-practices-when-handling-external-file-paths.cs",
+      "title": "Ensure the solution complies with security best practices when handling external file paths."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "export-a-list-of-all-external-connection-names-from-a-workbook-to-a-plain-text-file.cs",
+      "title": "Export a list of all external connection names from a workbook to a plain text file."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "export-the-custom-ribbon-xml-to-a-separate-xml-file-for-version-control.cs",
+      "title": "Export the custom ribbon XML to a separate .xml file for version control."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "extract-odata-connection-details-from-the-datamashup-object-and-log-the-service-endpoint-url.cs",
+      "title": "Extract OData connection details from the DataMashup object and log the service endpoint URL."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "generate-a-csv-file-containing-workbook-name-connection-type-and-connection-name-for-all-files-in-a-folder.cs",
+      "title": "Generate a CSV file containing workbook name, connection type, and connection name for all files in a folder."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "generate-a-plaintext-report-summarizing-hidden-external-link-paths-for-further-analysis.cs",
+      "title": "Generate a plain\u2011text report summarizing hidden external link paths for further analysis."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "handle-errors-when-the-external-link-file-is-missing-or-inaccessible-during-path-update.cs",
+      "title": "Handle errors when the external link file is missing or inaccessible during path update."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "hide-the-refresh-all-command-on-specific-worksheets-via-customized-ribbon-xml.cs",
+      "title": "Hide the \"Refresh All\" command on specific worksheets via customized Ribbon XML."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "implement-error-handling-for-failures-during-external-link-path-updates-invoked-from-the-ribbon.cs",
+      "title": "Implement error handling for failures during external link path updates invoked from the ribbon."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "import-custom-ribbon-xml-from-an-external-xml-file-into-an-existing-workbook-programmatically.cs",
+      "title": "Import custom ribbon XML from an external .xml file into an existing workbook programmatically."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "iterate-through-all-querytables-in-all-worksheets-and-set-preserveformatting-to-true.cs",
+      "title": "Iterate through all QueryTables in all worksheets and set PreserveFormatting to true."
+    },
+    {
+      "category": "queries-and-connections",
+      "file": "iterate-through-dataconnections-to-identify-sql-type-connections-and-cast-each-to-dbconnection.cs",
+      "title": "Iterate through DataConnections to identify SQL type connections and cast each to DBConnection."
+    },
     {
       "category": "queries-and-connections",
       "file": "load-a-workbook-from-a-file-path-and-obtain-its-dataconnections-collection.cs",

queries-and-connections/add-a-custom-ribbon-tab-named-data-tools-using-ribbon-xml-definition.cs

@@ -0,0 +1,37 @@
+using System;
+using Aspose.Cells;
+
+namespace AsposeCellsRibbonDemo
+{
+    class Program
+    {
+        static void Main()
+        {
+            // Create a new workbook (in-memory)
+            Workbook workbook = new Workbook();
+
+            // Define the Ribbon XML that adds a custom tab named "Data Tools"
+            string ribbonXml =
+                "<customUI xmlns=\"http://schemas.microsoft.com/office/2006/01/customui\">" +
+                "  <ribbon>" +
+                "    <tabs>" +
+                "      <tab id=\"dataToolsTab\" label=\"Data Tools\">" +
+                "        <group id=\"dataToolsGroup\" label=\"Data Operations\">" +
+                "          <button id=\"refreshButton\" label=\"Refresh\" size=\"large\" />" +
+                "        </group>" +
+                "      </tab>" +
+                "    </tabs>" +
+                "  </ribbon>" +
+                "</customUI>";
+
+            // Assign the Ribbon XML to the workbook
+            workbook.RibbonXml = ribbonXml;
+
+            // Save the workbook as a macro-enabled file (XLSM) to preserve the Ribbon UI
+            workbook.Save("DataToolsDemo.xlsm", SaveFormat.Xlsm);
+
+            // Optional: confirm that the Ribbon XML was set
+            Console.WriteLine("Custom Ribbon tab 'Data Tools' has been added and workbook saved.");
+        }
+    }
+}

queries-and-connections/add-a-tooltip-to-the-custom-ribbon-button-describing-its-function-for-end-users.cs

@@ -0,0 +1,51 @@
+using System;
+using System.IO;
+using Aspose.Cells;
+
+namespace AsposeCellsDemo
+{
+    public class AddRibbonTooltipDemo
+    {
+        public static void Main()
+        {
+            try
+            {
+                Run();
+                Console.WriteLine("Workbook saved successfully.");
+            }
+            catch (Exception ex)
+            {
+                Console.Error.WriteLine($"Error: {ex.Message}");
+            }
+        }
+
+        public static void Run()
+        {
+            // Create a new workbook
+            Workbook workbook = new Workbook();
+
+            // Define ribbon XML with a tooltip (ScreenTip) for the custom button
+            string ribbonXml =
+                "<customUI xmlns=\"http://schemas.microsoft.com/office/2006/01/customui\">" +
+                "  <ribbon>" +
+                "    <tabs>" +
+                "      <tab id=\"customTab\" label=\"My Tab\">" +
+                "        <group id=\"customGroup\" label=\"My Group\">" +
+                "          <button id=\"customButton\" label=\"My Button\" size=\"large\" screentip=\"Executes the custom operation\" />" +
+                "        </group>" +
+                "      </tab>" +
+                "    </tabs>" +
+                "  </ribbon>" +
+                "</customUI>";
+
+            // Assign the custom ribbon XML to the workbook
+            workbook.RibbonXml = ribbonXml;
+
+            // Define output file path
+            string outputPath = "CustomRibbonWithTooltip.xlsm";
+
+            // Save the workbook (macro-enabled to retain ribbon UI)
+            workbook.Save(outputPath);
+        }
+    }
+}

queries-and-connections/add-error-handling-to-capture-exceptions-when-an-external-connection-path-is-invalid.cs

@@ -0,0 +1,84 @@
+using System;
+using System.IO;
+using Aspose.Cells;
+using Aspose.Cells.ExternalConnections;
+
+namespace AsposeCellsExamples
+{
+    public class ExternalConnectionInvalidPathHandling
+    {
+        public static void Main(string[] args)
+        {
+            Run();
+        }
+
+        public static void Run()
+        {
+            // Create a new workbook (lifecycle rule: create)
+            Workbook workbook = new Workbook();
+
+            // Attempt to work with external connections
+            try
+            {
+                // Access the external connections collection
+                ExternalConnectionCollection connections = workbook.DataConnections;
+
+                // If there is at least one connection, try to set an invalid ODC file path
+                if (connections.Count > 0)
+                {
+                    ExternalConnection conn = connections[0];
+
+                    // Intentionally set an invalid path to trigger an exception
+                    conn.OdcFile = @"Z:\NonExistentFolder\InvalidConnection.odc";
+                }
+                else
+                {
+                    Console.WriteLine("No external connections found in the workbook.");
+                }
+            }
+            catch (Exception ex)
+            {
+                // Capture and display any exception related to an invalid external connection path
+                Console.WriteLine($"Error while setting OdcFile: {ex.Message}");
+            }
+
+            // Attempt to add an external link with an invalid file path
+            try
+            {
+                // Get the external links collection
+                ExternalLinkCollection externalLinks = workbook.Worksheets.ExternalLinks;
+
+                // Define an invalid file name (non‑existent file)
+                string invalidFileName = @"C:\InvalidFolder\MissingWorkbook.xlsx";
+                string[] sheetNames = new string[] { "Sheet1" };
+
+                // Verify the file exists before attempting to add the link
+                if (File.Exists(invalidFileName))
+                {
+                    int index = externalLinks.Add(invalidFileName, sheetNames);
+                    Console.WriteLine($"External link added at index {index} (unexpected).");
+                }
+                else
+                {
+                    Console.WriteLine($"File not found: {invalidFileName}. Skipping external link addition.");
+                }
+            }
+            catch (Exception ex)
+            {
+                // Capture and display any exception related to adding an invalid external link
+                Console.WriteLine($"Error while adding external link: {ex.Message}");
+            }
+
+            // Save the workbook (lifecycle rule: save)
+            try
+            {
+                workbook.Save("ExternalConnectionInvalidPathDemo.xlsx");
+                Console.WriteLine("Workbook saved successfully.");
+            }
+            catch (Exception ex)
+            {
+                Console.WriteLine($"Error while saving workbook: {ex.Message}");
+            }
+        }
+    }
+}