Add clipboard functionality and notification for copying element state

Author: dualbios

src/FlaUInspect/ViewModels/MainViewModel.cs

@@ -28,6 +28,8 @@ public class MainViewModel : ObservableObject {
     private AutomationBase? _automation;
     private RelayCommand? _captureSelectedItemCommand;
     private RelayCommand? _closeInfoCommand;
+    private RelayCommand? _copyDetailsToClipboardCommand;
+    private RelayCommand? _currentElementSaveStateCommand;
     private ObservableCollection<ElementPatternItem>? _elementPatterns = [];
     private FocusTrackingMode? _focusTrackingMode;
     private HoverMode? _hoverMode;
@@ -39,7 +41,6 @@ public class MainViewModel : ObservableObject {
     private AutomationElement? _rootElement;
     private RelayCommand? _startNewInstanceCommand;
     private ITreeWalker? _treeWalker;
-    private RelayCommand? _currentElementSaveStateCommand;
 
     public MainViewModel(AutomationType automationType, string applicationVersion, InternalLogger logger) {
         _logger = logger;
@@ -182,14 +183,41 @@ public string? ApplicationVersion {
     public ICommand CloseInfoCommand => _closeInfoCommand ??= new RelayCommand(_ => {
         IsInfoVisible = false;
     });
-    
-    public event Action? CopiedNotificationRequested;
 
     public ICommand CurrentElementSaveStateCommand => _currentElementSaveStateCommand ??= new RelayCommand(_ => {
         if (SelectedItem?.AutomationElement == null) {
             return;
         }
 
+        try {
+            XDocument document = new ();
+            document.Add(new XElement("Root"));
+            ExportElement(document.Root!, SelectedItem);
+
+            Clipboard.SetText(document.ToString());
+            CopiedNotificationCurrentElementSaveStateRequested?.Invoke();
+        } catch (Exception e) {
+            _logger?.LogError(e.ToString());
+        }
+    });
+
+    public ICommand CollapseAllDetailsCommand => new RelayCommand(_ => {
+        foreach (ElementPatternItem pattern in ElementPatterns) {
+            pattern.IsExpanded = false;
+        }
+    });
+
+    public ICommand ExpandAllDetailsCommand => new RelayCommand(_ => {
+        foreach (ElementPatternItem pattern in ElementPatterns) {
+            pattern.IsExpanded = true;
+        }
+    });
+
+    public ICommand CopyDetailsToClipboardCommand => _copyDetailsToClipboardCommand ??= new RelayCommand(_ => {
+        if (SelectedItem?.AutomationElement == null) {
+            return;
+        }
+
         try {
             XDocument document = new ();
             document.Add(new XElement("Root"));
@@ -217,17 +245,49 @@ public string? ApplicationVersion {
         }
     });
 
-    public ICommand CollapseAllDetailsCommand => new RelayCommand(_ => {
-        foreach (ElementPatternItem pattern in ElementPatterns) {
-            pattern.IsExpanded = false;
+    public event Action? CopiedNotificationRequested;
+    public event Action? CopiedNotificationCurrentElementSaveStateRequested;
+
+    private void ExportElement(XElement parent, ElementViewModel element) {
+        XElement xElement = CreateXElement(element);
+        parent.Add(xElement);
+
+        try {
+            foreach (ElementViewModel children in element.Children!) {
+                try {
+                    xElement.Add(CreateXElement(children!));
+                } catch {
+                    // ignored
+                }
+            }
+
+            foreach (ElementViewModel children in element.Children.Where(x => x is { IsExpanded: true }).Where(x => x != null)!) {
+                try {
+                    ExportElement(xElement, children!);
+                } catch {
+                    // ignored
+                }
+            }
+        } catch {
+            // ignored
         }
-    });
+    }
 
-    public ICommand ExpandAllDetailsCommand => new RelayCommand(_ => {
-        foreach (ElementPatternItem pattern in ElementPatterns) {
-            pattern.IsExpanded = true;
+    private XElement CreateXElement(ElementViewModel element) {
+
+        List<XAttribute> attrs = [
+            new ("Name", element.Name),
+            new ("AutomationId", element.AutomationId),
+            new ("ControlType", element.ControlType)
+        ];
+
+        if (EnableXPath) {
+            attrs.Add(new XAttribute("XPath", element.XPath));
         }
-    });
+
+        XElement xElement = new ("Element", attrs);
+        return xElement;
+    }
 
     private void ReadPatternsForSelectedItem(AutomationElement? selectedItemAutomationElement) {
         if (SelectedItem?.AutomationElement == null || selectedItemAutomationElement == null) {

src/FlaUInspect/Views/MainWindow.xaml

@@ -114,17 +114,27 @@
                             HorizontalAlignment="Left"
                             VerticalAlignment="Top"
                             Orientation="Horizontal">
-                    <Button Command="{Binding CurrentElementSaveStateCommand}"
-                            Style="{StaticResource RibbonButtonStyle}"
-                            ToolTip="Get current element state">
-                        <StackPanel Orientation="Vertical">
-                            <Viewbox Width="20"
-                                     Height="20"
-                                     Stretch="Uniform">
-                                <ContentControl Content="{StaticResource TreeIcon}" />
-                            </Viewbox>
-                        </StackPanel>
-                    </Button>
+                    <Grid>
+                        <Button Command="{Binding CurrentElementSaveStateCommand}"
+                                Style="{StaticResource RibbonButtonStyle}"
+                                ToolTip="Get current element state">
+                            <StackPanel Orientation="Vertical">
+                                <Viewbox Width="20"
+                                         Height="20"
+                                         Stretch="Uniform">
+                                    <ContentControl Content="{StaticResource TreeIcon}" />
+                                </Viewbox>
+                            </StackPanel>
+                        </Button>
+                        <Grid Background="DarkBlue"
+                              x:Name="CopiedNotificationCurrentElementSaveStateGrid"
+                              Visibility="Collapsed">
+                            <TextBlock Text="Copied."
+                                       Foreground="White"
+                                       HorizontalAlignment="Center"
+                                       VerticalAlignment="Center" />
+                        </Grid>
+                    </Grid>
 
                     <Button Command="{Binding CaptureSelectedItemCommand}"
                             Style="{StaticResource RibbonButtonStyle}"
@@ -339,7 +349,7 @@
                                 </Style>
                             </StackPanel.Resources>
                             <Grid>
-                                <Button Command="{Binding CurrentElementSaveStateCommand}"
+                                <Button Command="{Binding CopyDetailsToClipboardCommand}"
                                         Style="{StaticResource RibbonButtonStyle}"
                                         ToolTip="Copy current element state to clipboard">
                                     <StackPanel Orientation="Vertical">

src/FlaUInspect/Views/MainWindow.xaml.cs

@@ -15,9 +15,18 @@ private void MainWindow_Loaded(object sender, EventArgs e) {
         if (DataContext is MainViewModel mainViewModel) {
             mainViewModel.Initialize();
             mainViewModel.CopiedNotificationRequested += ShowCopiedNotification;
+            mainViewModel.CopiedNotificationCurrentElementSaveStateRequested += ShowCopiedNotificationCurrentElementSaveStateRequested;
         }
     }
 
+    private async void ShowCopiedNotificationCurrentElementSaveStateRequested() {
+        CopiedNotificationCurrentElementSaveStateGrid.Visibility = Visibility.Visible;
+        var animation = new DoubleAnimation(1, 0, TimeSpan.FromSeconds(1));
+        CopiedNotificationCurrentElementSaveStateGrid.BeginAnimation(UIElement.OpacityProperty, animation);
+        await Task.Delay(1000);
+        CopiedNotificationCurrentElementSaveStateGrid.Visibility = Visibility.Collapsed;
+    }
+
     private void TreeView_OnSelectedItemChanged(object sender, RoutedPropertyChangedEventArgs<object> e) {
         if (DataContext is MainViewModel mainViewModel) {
             mainViewModel.SelectedItem = e.NewValue as ElementViewModel;