Merge pull request #192 from Nfactor26/allow-deleting-controls

Allow controls to be deleted

Author: Nfactor26

src/Pixel.Automation.AppExplorer.ViewModels/Application/ApplicationExplorerViewModel.cs

@@ -206,7 +206,13 @@ public async Task AddApplication(KnownApplication knownApplication)
 
         public async Task EditApplicationAsync(ApplicationDescriptionViewModel applicationDescriptionViewModel)
         {
-            await this.eventAggregator.PublishOnUIThreadAsync(new PropertyGridObjectEventArgs(applicationDescriptionViewModel.ApplicationDetails, () => { _ = SaveApplicationAsync(applicationDescriptionViewModel); }, () => { return true; }));
+            await this.eventAggregator.PublishOnUIThreadAsync(new PropertyGridObjectEventArgs(applicationDescriptionViewModel.ApplicationDetails, 
+                async () => {
+                    await SaveApplicationAsync(applicationDescriptionViewModel);
+                }, 
+                () => { 
+                    return true; 
+                }));
         }
 
         public async Task SaveApplicationAsync(ApplicationDescriptionViewModel applicationDescriptionViewModel)

src/Pixel.Automation.AppExplorer.ViewModels/Control/ControlExplorerViewModel.cs

@@ -162,6 +162,7 @@ public void ToggleRename(ControlDescriptionViewModel targetControl)
         /// <param name="controlToRename"></param>
         public async Task RenameControl(ActionExecutionContext context, ControlDescriptionViewModel controlToRename)
         {
+            string currentName = controlToRename.ControlName;
             try
             {
                 var keyArgs = context.EventArgs as KeyEventArgs;
@@ -180,7 +181,9 @@ public async Task RenameControl(ActionExecutionContext context, ControlDescripti
             catch (Exception ex)
             {
                 logger.Error(ex, ex.Message);
+                controlToRename.ControlName = currentName;
                 CanEdit = false;
+                MessageBox.Show(ex.Message, $"Error while renaming control : {controlToRename.ControlName}");
             }
         }
 
@@ -242,7 +245,11 @@ private IEnumerable<ControlDescriptionViewModel> LoadControlDetails(ApplicationD
                     var controls = this.applicationDataManager.GetControlsForScreen(applicationDescriptionViewModel.Model, screenName).ToList();
                     foreach (var control in controls)
                     {
-                        var controlDescriptionViewModel = new ControlDescriptionViewModel(control);                       
+                        if(control.IsDeleted)
+                        {
+                            continue;
+                        }
+                        var controlDescriptionViewModel = new ControlDescriptionViewModel(control);
                         applicationDescriptionViewModel.AddControl(controlDescriptionViewModel, screenName);
                         controlsList.Add(controlDescriptionViewModel);
                     }
@@ -276,21 +283,29 @@ public async Task MoveToScreen(ControlDescriptionViewModel controlDescription)
         /// <returns></returns>
         public async Task ConfigureControlAsync(ControlDescriptionViewModel controlToEdit)
         {
-            Guard.Argument(controlToEdit).NotNull();
-
-            //Make a copy of ControlDescription that is opened for edit
-            var copyOfControlToEdit = controlToEdit.ControlDescription.Clone() as ControlDescription;
-            copyOfControlToEdit.ControlId = controlToEdit.ControlId;
-            var controlEditor = controlEditorFactory.CreateControlEditor(controlToEdit.ControlDetails);
-            controlEditor.Initialize(copyOfControlToEdit);
-            var result = await windowManager.ShowDialogAsync(controlEditor);
-            //if save was clicked, assign back changes in ControlDetails to controlToEdit.
-            //Editor only allows editing ControlDetails. Description won't be modified.
-            if (result.HasValue && result.Value)
+            try
             {
-                controlToEdit.ControlDetails = copyOfControlToEdit.ControlDetails;
-                await SaveControlDetails(controlToEdit, false);
-                await this.eventAggregator.PublishOnBackgroundThreadAsync(new ControlUpdatedEventArgs(controlToEdit.ControlId));
+                Guard.Argument(controlToEdit).NotNull();
+
+                //Make a copy of ControlDescription that is opened for edit
+                var copyOfControlToEdit = controlToEdit.ControlDescription.Clone() as ControlDescription;
+                copyOfControlToEdit.ControlId = controlToEdit.ControlId;
+                var controlEditor = controlEditorFactory.CreateControlEditor(controlToEdit.ControlDetails);
+                controlEditor.Initialize(copyOfControlToEdit);
+                var result = await windowManager.ShowDialogAsync(controlEditor);
+                //if save was clicked, assign back changes in ControlDetails to controlToEdit.
+                //Editor only allows editing ControlDetails. Description won't be modified.
+                if (result.HasValue && result.Value)
+                {
+                    controlToEdit.ControlDetails = copyOfControlToEdit.ControlDetails;
+                    await SaveControlDetails(controlToEdit, false);
+                    await this.eventAggregator.PublishOnBackgroundThreadAsync(new ControlUpdatedEventArgs(controlToEdit.ControlId));
+                }
+            }
+            catch (Exception ex)
+            {
+                logger.Error(ex, ex.Message);               
+                MessageBox.Show(ex.Message, $"Error while configuring control : {controlToEdit.ControlName}");
             }
         }
 
@@ -301,9 +316,43 @@ public async Task ConfigureControlAsync(ControlDescriptionViewModel controlToEdi
         /// <returns></returns>
         public async Task EditControlAsync(ControlDescriptionViewModel controlToEdit)
         {
-            await this.eventAggregator.PublishOnUIThreadAsync(new PropertyGridObjectEventArgs(controlToEdit, () => { _ = SaveControlDetails(controlToEdit, false); }, () => { return true; }));
+            await this.eventAggregator.PublishOnUIThreadAsync(new PropertyGridObjectEventArgs(controlToEdit, 
+                async () => {
+                    try
+                    {
+                        await SaveControlDetails(controlToEdit, false);
+                    }
+                    catch(Exception ex)
+                    {
+                        logger.Error(ex, "There was an error while trying to edit control : {0}", controlToEdit.ControlName);
+                        MessageBox.Show(ex.Message, $"Error while editing control : {controlToEdit.ControlName}");
+                    }
+                }, 
+                () => { 
+                    return true; 
+                }));
         }
 
+        /// <summary>
+        /// Delete the control
+        /// </summary>
+        /// <param name="controlToDelete"></param>
+        public async Task DeleteControlAsync(ControlDescriptionViewModel controlToDelete)
+        {
+            try
+            {
+                Guard.Argument(controlToDelete, nameof(controlToDelete)).NotNull();
+                await this.applicationDataManager.DeleteControlAsync(controlToDelete.ControlDescription);
+                this.Controls.Remove(controlToDelete);
+            }
+            catch (Exception ex)
+            {
+                logger.Error(ex, "There was an error while trying to delete control : {0}", controlToDelete.ControlName);
+                MessageBox.Show(ex.Message, $"Error while deleting control : {controlToDelete.ControlName}");
+            }
+        }
+
+
         /// <summary>
         /// Show file browse dialog and let user pick a new image for the control.
         /// Existing image will be deleted and replaced with the new image picked by user.
@@ -312,25 +361,33 @@ public async Task EditControlAsync(ControlDescriptionViewModel controlToEdit)
         /// <returns></returns>
         public async Task ChangeImageFromExistingAsync(ControlDescriptionViewModel selectedControl)
         {
-            OpenFileDialog openFileDialog = new OpenFileDialog();
-            openFileDialog.Filter = "PNG File (*.Png)|*.Png";
-            openFileDialog.InitialDirectory = Environment.CurrentDirectory;
-            if (openFileDialog.ShowDialog() == true)
+            try
             {
-                string fileName = openFileDialog.FileName;
-                File.Delete(selectedControl.ControlImage);
-                using (FileStream fs = new FileStream(fileName, FileMode.Open, FileAccess.Read))
+                OpenFileDialog openFileDialog = new OpenFileDialog();
+                openFileDialog.Filter = "PNG File (*.Png)|*.Png";
+                openFileDialog.InitialDirectory = Environment.CurrentDirectory;
+                if (openFileDialog.ShowDialog() == true)
                 {
-                    //we can't reuse the same control image name due to caching issues with bitmap which will keep using old file
-                    //unless file name changes
-                    selectedControl.ControlImage = await this.applicationDataManager.AddOrUpdateControlImageAsync(selectedControl.ControlDescription, fs);
-                    await SaveControlDetails(selectedControl, false);
-                    // This will force reload image on control explorer
-                    selectedControl.ImageSource = null;
-                    // This will force reload image on process designer
-                    await this.eventAggregator.PublishOnBackgroundThreadAsync(new ControlUpdatedEventArgs(selectedControl.ControlId));
+                    string fileName = openFileDialog.FileName;                  
+                    using (FileStream fs = new FileStream(fileName, FileMode.Open, FileAccess.Read))
+                    {
+                        //we can't reuse the same control image name due to caching issues with bitmap which will keep using old file
+                        //unless file name changes
+                        selectedControl.ControlImage = await this.applicationDataManager.AddOrUpdateControlImageAsync(selectedControl.ControlDescription, fs);
+                        await SaveControlDetails(selectedControl, false);
+                        // This will force reload image on control explorer
+                        selectedControl.ImageSource = null;
+                        // This will force reload image on process designer
+                        await this.eventAggregator.PublishOnBackgroundThreadAsync(new ControlUpdatedEventArgs(selectedControl.ControlId));
+                    }
+                    File.Delete(selectedControl.ControlImage);
                 }
             }
+            catch (Exception ex)
+            {
+                logger.Error(ex, "There was an error while trying to change image for control : {0}", selectedControl.ControlName);
+                MessageBox.Show(ex.Message, $"Error while changing image for control : {selectedControl.ControlName}");
+            }
         }
 
         /// <summary>
@@ -353,7 +410,8 @@ public async Task CloneControl(ControlDescriptionViewModel controlToClone)
             }
             catch (Exception ex)
             {
-                logger.Error(ex, "There was an error while trying to clone the control.");
+                logger.Error(ex, "There was an error while trying to clone control : {0}", selectedControl.ControlName);
+                MessageBox.Show(ex.Message, $"Error while cloning control : {selectedControl.ControlName}");
             }
         }
 
@@ -363,18 +421,26 @@ public async Task CloneControl(ControlDescriptionViewModel controlToClone)
         /// <param name="controlToRename"></param>
         public async Task CreateRevision(ControlDescriptionViewModel control)
         {
-            Guard.Argument(control).NotNull();
-
-            var clonedControl = control.ControlDescription.Clone() as ControlDescription;
-            clonedControl.ControlId = control.ControlId;
-            clonedControl.Version = new Version(control.Version.Major + 1, 0);
-            var controlDescriptionViewModel = new ControlDescriptionViewModel(clonedControl);
-            await SaveBitMapSource(controlDescriptionViewModel.ControlDescription, controlDescriptionViewModel.ImageSource);
-            await SaveControlDetails(controlDescriptionViewModel, true);
-            //we remove the visible version and add the new revised version in explorer.
-            this.Controls.Remove(control);
-            this.Controls.Add(controlDescriptionViewModel);
-            logger.Information("Created a new revision for control : {0}", control.ControlDescription);
+            try
+            {
+                Guard.Argument(control).NotNull();
+
+                var clonedControl = control.ControlDescription.Clone() as ControlDescription;
+                clonedControl.ControlId = control.ControlId;
+                clonedControl.Version = new Version(control.Version.Major + 1, 0);
+                var controlDescriptionViewModel = new ControlDescriptionViewModel(clonedControl);
+                await SaveBitMapSource(controlDescriptionViewModel.ControlDescription, controlDescriptionViewModel.ImageSource);
+                await SaveControlDetails(controlDescriptionViewModel, true);
+                //we remove the visible version and add the new revised version in explorer.
+                this.Controls.Remove(control);
+                this.Controls.Add(controlDescriptionViewModel);
+                logger.Information("Created a new revision for control : {0}", control.ControlDescription);
+            }
+            catch (Exception ex)
+            {
+                logger.Error(ex, "There was an error while creating revision of control : {0}", selectedControl.ControlName);
+                MessageBox.Show(ex.Message, $"Error while creating revision for control : {selectedControl.ControlName}");
+            }
         }
 
         private readonly object locker = new object();

src/Pixel.Automation.AppExplorer.Views/Control/ControlExplorerView.xaml

@@ -76,6 +76,7 @@
                                     <MenuItem x:Name="CreateRevision" Header="Create Revision" cal:Action.TargetWithoutContext="{Binding Path=DataContext, RelativeSource={RelativeSource AncestorType={x:Type Grid}, AncestorLevel=2}}" cal:Message.Attach="[Event Click] = [Action CreateRevision($dataContext)]"></MenuItem>
                                     <MenuItem x:Name="ChangeImage" Header="Change Image" cal:Action.TargetWithoutContext="{Binding Path=DataContext, RelativeSource={RelativeSource AncestorType={x:Type Grid}, AncestorLevel=2}}" cal:Message.Attach="[Event Click] = [Action ChangeImageFromExistingAsync($dataContext)]"></MenuItem>
                                     <MenuItem x:Name="MoveToScreen" Header="Move To Screen" cal:Action.TargetWithoutContext="{Binding Path=DataContext, RelativeSource={RelativeSource AncestorType={x:Type Grid}, AncestorLevel=2}}" cal:Message.Attach="[Event Click] = [Action MoveToScreen($dataContext)]"></MenuItem>
+                                    <MenuItem x:Name="Delete" Header="Delete" cal:Action.TargetWithoutContext="{Binding Path=DataContext, RelativeSource={RelativeSource AncestorType={x:Type Grid}, AncestorLevel=2}}" cal:Message.Attach="[Event Click] = [Action DeleteControlAsync($dataContext)]" ></MenuItem>
                                 </StackPanel>
                             </ControlTemplate>
                         </ContextMenu.Template>

src/Pixel.Automation.Core/Controls/ControlDescription.cs

@@ -54,6 +54,12 @@ public class ControlDescription : ICloneable
         [DataMember(Order = 100)]
         public IControlIdentity ControlDetails { get; set; }
 
+        /// <summary>
+        /// Indicates if the Control was deleted.
+        /// </summary>
+        [DataMember(Order = 1000)]
+        public bool IsDeleted { get; set; }
+
         /// <summary>
         /// Default constructor
         /// </summary>

src/Pixel.Automation.Designer.ViewModels/AutomationBuilder/EditorViewModel.cs

@@ -411,9 +411,17 @@ public async Task HandleAsync(TestEntityRemovedEventArgs removedEntity, Cancella
         /// <returns></returns>
         public async Task HandleAsync(ControlAddedEventArgs control, CancellationToken cancellationToken)
         {
-            var controlDescription = control.Control;            
-            var referenceManager = this.projectManager.GetReferenceManager();
-            await referenceManager.AddControlReferenceAsync(new ControlReference(controlDescription.ApplicationId, controlDescription.ControlId, controlDescription.Version));      
+            var controlDescription = control.Control;
+            try
+            {             
+                var referenceManager = this.projectManager.GetReferenceManager();
+                await referenceManager.AddControlReferenceAsync(new ControlReference(controlDescription.ApplicationId, controlDescription.ControlId, controlDescription.Version));
+            }
+            catch (Exception ex)
+            {
+                logger.Error(ex, "There was an error while trying to add control reference for control : {0}", controlDescription.ControlName);
+                MessageBox.Show(ex.Message, $"Error while adding control : {controlDescription.ControlName}");
+            }  
         }
 
 

src/Pixel.Automation.Designer.ViewModels/PropertyGrid/PropertyGridViewModel.cs

@@ -33,11 +33,11 @@ public PropertyGridViewModel()
             this.SaveCommand = new RelayCommand(p => Save(), p => CanSave());
         }
 
-        public void SetState(object selectedObject, bool isReadOnly, Action saveCommand, Func<bool> canSave)
+        public void SetState(object selectedObject, bool isReadOnly, Func<Task> saveCommand, Func<bool> canSave)
         {
             this.selectedObject = selectedObject;
             this.isReadOnly = isReadOnly;
-            this.onSave = saveCommand;
+            this.onSave = () => saveCommand();
             this.canSave = canSave;
             NotifyOfPropertyChange(() => SelectedObject);
             NotifyOfPropertyChange(() => IsReadOnly);

src/Pixel.Automation.Editor.Notifications/EventArgs/PropertyGridObjectEventArgs.cs

@@ -6,7 +6,7 @@ public class PropertyGridObjectEventArgs : EventArgs
 
     public bool IsReadOnly { get; private set; }
 
-    public Action SaveCommand { get; private set; }
+    public Func<Task> SaveCommand { get; private set; }
 
     public Func<bool> CanSaveCommand { get; private set; }
 
@@ -21,7 +21,7 @@ public PropertyGridObjectEventArgs(Object objectToDisplay, bool isReadOnly) : ba
         this.IsReadOnly = isReadOnly;
     }
 
-    public PropertyGridObjectEventArgs(Object objectToDisplay, Action saveCommand, Func<bool> canSaveCommand) : this(objectToDisplay, false)
+    public PropertyGridObjectEventArgs(Object objectToDisplay, Func<Task> saveCommand, Func<bool> canSaveCommand) : this(objectToDisplay, false)
     {
         this.SaveCommand = saveCommand;
         this.CanSaveCommand = canSaveCommand;

src/Pixel.Automation.Reference.Manager/ReferenceManager.cs

@@ -127,11 +127,11 @@ public async Task AddControlReferenceAsync(ControlReference controlReference)
         Guard.Argument(controlReference, nameof(controlReference)).NotNull();
         if (!this.controlReferences.HasReference(controlReference))
         {
-            this.controlReferences.AddControlReference(controlReference);
             if (IsOnlineMode)
             {
                 await this.referencesRepositoryClient.AddOrUpdateControlReferences(this.projectId, this.projectVersion, controlReference);
             }
+            this.controlReferences.AddControlReference(controlReference);
             SaveLocal();
         }
     }