Merge pull request #243 from w-ahmad/feat/clipbaord_binding

feat: Implemented ClipboardContentBinding

Author: w-ahmad

src/Columns/TableViewBoundColumn.cs

@@ -12,7 +12,6 @@ namespace WinUI.TableView;
 /// </summary>
 public abstract class TableViewBoundColumn : TableViewColumn
 {
-    private string? _propertyPath;
     private Binding _binding = new();
     private Func<object, object?>? _funcCompiledPropertyPath;
 
@@ -43,14 +42,7 @@ public abstract class TableViewBoundColumn : TableViewColumn
     /// <summary>
     /// Gets the property path for the binding.
     /// </summary>
-    internal string? PropertyPath
-    {
-        get
-        {
-            _propertyPath ??= Binding?.Path?.Path;
-            return _propertyPath;
-        }
-    }
+    internal string? PropertyPath => Binding?.Path?.Path;
 
     /// <summary>
     /// Gets or sets the binding for the column.
@@ -62,21 +54,31 @@ public virtual Binding Binding
         {
             if (_binding != value)
             {
-                _binding = value;
-
-                if (_binding is not null)
+                if (value is not null)
                 {
-                    _binding.Mode = BindingMode.TwoWay;
+                    value.Mode = BindingMode.TwoWay;
 
-                    if (_binding.UpdateSourceTrigger == UpdateSourceTrigger.Default)
+                    if (value.UpdateSourceTrigger == UpdateSourceTrigger.Default)
                     {
-                        _binding.UpdateSourceTrigger = UpdateSourceTrigger.Explicit;
+                        value.UpdateSourceTrigger = UpdateSourceTrigger.Explicit;
                     }
                 }
+
+                _binding = value!;
             }
         }
     }
 
+    /// <summary>
+    /// Gets or sets the data binding used to retrieve cell content when copying to the clipboard.
+    /// If no explicit clipboard binding is set, the column's <see cref="Binding"/> is returned as a fallback.
+    /// </summary>
+    public override Binding? ClipboardContentBinding
+    {
+        get => base.ClipboardContentBinding ?? Binding;
+        set => base.ClipboardContentBinding = value;
+    }
+
     /// <summary>
     /// Handles changes to the ElementStyle property.
     /// </summary>

src/Columns/TableViewColumn.cs

@@ -1,4 +1,7 @@
 using Microsoft.UI.Xaml;
+using Microsoft.UI.Xaml.Data;
+using System;
+using WinUI.TableView.Extensions;
 using SD = WinUI.TableView.SortDirection;
 
 namespace WinUI.TableView;
@@ -15,6 +18,7 @@ public abstract partial class TableViewColumn : DependencyObject
     private SD? _sortDirection;
     private bool _isFiltered;
     private bool _isFrozen;
+    private Func<object, object?>? _funcCompiledPropertyPath;
 
     /// <summary>
     /// Generates a display element for the cell.
@@ -97,6 +101,34 @@ internal void SetOwningTableView(TableView tableView)
         return default;
     }
 
+    /// <summary>
+    /// Gets the clipboard content of the cell for the specified data item.
+    /// </summary>
+    /// <param name="dataItem">The data item.</param>
+    /// <returns>The clipboard content of the cell.</returns>
+    public virtual object? GetClipboardContent(object? dataItem)
+    {
+        if (dataItem is null)
+            return null;
+
+        if (_funcCompiledPropertyPath is null && !string.IsNullOrWhiteSpace(ClipboardContentBindingPropertyPath))
+            _funcCompiledPropertyPath = dataItem.GetFuncCompiledPropertyPath(ClipboardContentBindingPropertyPath!);
+
+        if (_funcCompiledPropertyPath is not null)
+            dataItem = _funcCompiledPropertyPath(dataItem);
+
+        if (ClipboardContentBinding?.Converter is not null)
+        {
+            dataItem = ClipboardContentBinding.Converter.Convert(
+                dataItem,
+                typeof(object),
+                ClipboardContentBinding.ConverterParameter,
+                ClipboardContentBinding.ConverterLanguage);
+        }
+
+        return dataItem;
+    }
+
     /// <summary>
     /// Gets or sets the header content of the column.
     /// </summary>
@@ -169,7 +201,6 @@ public Style? HeaderStyle
         set => SetValue(HeaderStyleProperty, value);
     }
 
-
     /// <summary>
     /// Gets or sets the style that is used to render cells in the column.
     /// </summary>
@@ -316,6 +347,16 @@ internal set
         }
     }
 
+    /// <summary>
+    /// Gets or sets the data binding used to retrieve cell content when copying to the clipboard.
+    /// </summary>
+    public virtual Binding? ClipboardContentBinding { get; set; }
+
+    /// <summary>
+    /// Gets the property path for the <see cref="ClipboardContentBinding"/>.
+    /// </summary>
+    internal string? ClipboardContentBindingPropertyPath => ClipboardContentBinding?.Path?.Path;
+
     /// <summary>
     /// Gets the owning TableView for the column.
     /// </summary>

src/TableView.cs

@@ -381,7 +381,7 @@ internal void CopyToClipboardInternal(bool includeHeaders)
         }
 
         var package = new DataPackage();
-        package.SetText(GetSelectedContent(includeHeaders));
+        package.SetText(GetSelectedClipboardContent(includeHeaders));
         Clipboard.SetContent(package);
     }
 
@@ -392,6 +392,26 @@ internal void CopyToClipboardInternal(bool includeHeaders)
     /// <param name="separator">The character used to separate cell values (default is tab).</param>
     /// <returns>A string of selected cell content separated by the specified character.</returns>
     public string GetSelectedContent(bool includeHeaders, char separator = '\t')
+    {
+        var slots = GetSelectedCellSlots();
+
+        return GetCellsContent(slots, includeHeaders, separator);
+    }
+
+    /// <summary>
+    /// Returns the selected cells' or rows' clipboard content as a string, optionally including headers, with values separated by the given character.
+    /// </summary>
+    /// <param name="includeHeaders">Whether to include headers in the output.</param>
+    /// <param name="separator">The character used to separate cell values (default is tab).</param>
+    /// <returns>A string of selected cell clipboard content separated by the specified character.</returns>
+    public string GetSelectedClipboardContent(bool includeHeaders, char separator = '\t')
+    {
+        var slots = GetSelectedCellSlots();
+
+        return GetCellsContent(slots, includeHeaders, separator, true);
+    }
+
+    private IEnumerable<TableViewCellSlot> GetSelectedCellSlots()
     {
         var slots = Enumerable.Empty<TableViewCellSlot>();
 
@@ -409,7 +429,7 @@ public string GetSelectedContent(bool includeHeaders, char separator = '\t')
             slots = [CurrentCellSlot.Value];
         }
 
-        return GetCellsContent(slots, includeHeaders, separator);
+        return slots;
     }
 
     /// <summary>
@@ -450,6 +470,11 @@ public string GetRowsContent(int[] rows, bool includeHeaders, char separator = '
     /// <param name="separator">The character used to separate cell values.</param>
     /// <returns>A string of specified cell content separated by the specified character.</returns>
     public string GetCellsContent(IEnumerable<TableViewCellSlot> slots, bool includeHeaders, char separator = '\t')
+    {
+        return GetCellsContent(slots, includeHeaders, separator, false);
+    }
+
+    private string GetCellsContent(IEnumerable<TableViewCellSlot> slots, bool includeHeaders, char separator, bool isClipboardContent)
     {
         if (!slots.Any())
         {
@@ -458,9 +483,7 @@ public string GetCellsContent(IEnumerable<TableViewCellSlot> slots, bool include
 
         var minColumn = slots.Select(x => x.Column).Min();
         var maxColumn = slots.Select(x => x.Column).Max();
-
         var stringBuilder = new StringBuilder();
-        var properties = new Dictionary<string, (PropertyInfo, object?)[]>();
 
         if (includeHeaders)
         {
@@ -481,7 +504,8 @@ public string GetCellsContent(IEnumerable<TableViewCellSlot> slots, bool include
                     continue;
                 }
 
-                stringBuilder.Append($"{column.GetCellContent(item)}{separator}");
+                var content = isClipboardContent ? column.GetClipboardContent(item) : column.GetCellContent(item);
+                stringBuilder.Append($"{content}{separator}");
             }
 
             stringBuilder.Remove(stringBuilder.Length - 1, 1); // remove extra separator at the end of the line