Merge pull request #24 from fahadadeel/main

Update README.md

Author: fahadadeel

FileFormat.Cells/Cell.cs

@@ -34,6 +34,101 @@ public Cell(DocumentFormat.OpenXml.Spreadsheet.Cell cell, SheetData sheetData, W
             _workbookPart = workbookPart ?? throw new ArgumentNullException(nameof(workbookPart));
         }
 
+        /// <summary>
+        /// Adds a hyperlink to the specified cell with an optional tooltip.
+        /// </summary>
+        /// <param name="hyperlinkUrl">The URL of the hyperlink to be added.</param>
+        /// <param name="tooltip">The optional tooltip to display when hovering over the hyperlink.</param>
+        /// <exception cref="ArgumentException">
+        /// Thrown when <paramref name="hyperlinkUrl"/> is null or empty.
+        /// </exception>
+        /// <exception cref="InvalidOperationException">
+        /// Thrown when the parent WorksheetPart or the OpenXML Worksheet cannot be found.
+        /// </exception>
+        /// <remarks>
+        /// This method creates a hyperlink relationship in the parent worksheet and adds a Hyperlink element
+        /// to the cell's reference in the worksheet. The method does not modify the cell's text; use <see cref="PutValue"/>
+        /// to set display text if needed.
+        /// </remarks>
+        /// <example>
+        /// The following example demonstrates how to use the <c>SetHyperlink</c> method:
+        /// <code>
+        /// using (Workbook wb = new Workbook("path/to/your/file.xlsx"))
+        /// {
+        ///     Worksheet sheet = wb.Worksheets[0];
+        ///     Cell cell = sheet.Cells["A1"];
+        ///     cell.PutValue("Click Me");
+        ///     cell.SetHyperlink("https://example.com", "Visit Example");
+        ///     wb.Save("path/to/your/file.xlsx");
+        /// }
+        /// </code>
+        /// </example>
+        public void SetHyperlink(string hyperlinkUrl, string tooltip = null)
+        {
+            if (string.IsNullOrEmpty(hyperlinkUrl))
+                throw new ArgumentException("Hyperlink URL cannot be null or empty.", nameof(hyperlinkUrl));
+
+            // Get the WorksheetPart for this cell
+            WorksheetPart worksheetPart = GetWorksheetPart();
+            if (worksheetPart == null)
+                throw new InvalidOperationException("WorksheetPart is not available for this cell.");
+
+            // Get the underlying OpenXML Worksheet
+            var openXmlWorksheet = worksheetPart.Worksheet;
+            if (openXmlWorksheet == null)
+                throw new InvalidOperationException("The OpenXML Worksheet is not available.");
+
+            // Ensure the Hyperlinks collection exists
+            Hyperlinks hyperlinks = openXmlWorksheet.GetFirstChild<Hyperlinks>();
+            if (hyperlinks == null)
+            {
+                hyperlinks = new Hyperlinks();
+                openXmlWorksheet.InsertAfter(hyperlinks, openXmlWorksheet.GetFirstChild<SheetData>());
+            }
+
+            // Create a unique relationship ID
+            string relationshipId = "rId" + Guid.NewGuid().ToString();
+
+            // Add the hyperlink relationship to the worksheet part
+            worksheetPart.AddHyperlinkRelationship(new Uri(hyperlinkUrl, UriKind.Absolute), true, relationshipId);
+
+            // Create and add the Hyperlink element
+            Hyperlink hyperlink = new Hyperlink
+            {
+                Reference = CellReference, // The reference of this cell in A1 notation
+                Tooltip = tooltip,
+                Id = relationshipId
+            };
+            hyperlinks.Append(hyperlink);
+
+            // Save changes to the worksheet
+            openXmlWorksheet.Save();
+        }
+
+        /// <summary>
+        /// Retrieves the WorksheetPart containing this cell.
+        /// </summary>
+        /// <returns>The <see cref="WorksheetPart"/> that contains the current cell.</returns>
+        /// <exception cref="InvalidOperationException">
+        /// Thrown if the WorksheetPart cannot be located.
+        /// </exception>
+        /// <remarks>
+        /// This method searches all WorksheetParts in the parent WorkbookPart and identifies
+        /// the one containing the current SheetData.
+        /// </remarks>
+        private WorksheetPart GetWorksheetPart()
+        {
+            foreach (var worksheetPart in _workbookPart.GetPartsOfType<WorksheetPart>())
+            {
+                if (worksheetPart.Worksheet.Descendants<SheetData>().Contains(_sheetData))
+                {
+                    return worksheetPart;
+                }
+            }
+
+            throw new InvalidOperationException("Unable to find the WorksheetPart containing this cell.");
+        }
+
         /// <summary>
         /// Sets the value of the cell as a string.
         /// </summary>

README.md

@@ -61,4 +61,4 @@ workbook.Save("/spreadsheet.xlsx");
 </pre>
 
 ## Coming updates
-<p> <a href="https://fileformat-cells.github.io/FileFormat.Cells-for-.NET/">FileFormat.Cells</a> for .NET is planning to add more functionalities to its features bucket. However, after the successful launch of <a href="https://fileformat-cells.github.io/FileFormat.Cells-for-.NET/">FileFormat.Cells</a> and <a href="https://fileformat-words.github.io/FileFormat.Words-for-.NET/">FileFormat.Words</a> the development of FileFormat.Slides is a work in progress. So, stay in touch for regular updates. </p>
+<p> <a href="https://fileformat-cells.github.io/FileFormat.Cells-for-.NET/">FileFormat.Cells</a> is planning to add more functionalities to its features bucket. However, after the successful launch of <a href="https://fileformat-cells.github.io/FileFormat.Cells-for-.NET/">FileFormat.Cells</a> and <a href="https://fileformat-words.github.io/FileFormat.Words-for-.NET/">FileFormat.Words</a> the development of FileFormat.Slides is a work in progress. So, stay in touch for regular updates. </p>