Update LockDocumentRelayCommand to use LockDocumentManager to support document locking.

ricaun · ricaun · commit fb455d2df1a7 · 2025-07-04T11:37:43.000-03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Fixes
 - Fix `CheckURLValid` to support `http` and `https`.
 - Fix `SetImage` to update `Image` property.
+- Update `LockDocumentRelayCommand` to use `LockDocumentManager` to support document locking.
 
 ## [0.1.0] / 2025-07-02
 ### Features
diff --git a/ricaun.AutoCAD.UI.Example/App.cs b/ricaun.AutoCAD.UI.Example/App.cs
@@ -14,20 +14,21 @@ public class App : ExtensionApplication
         public override void OnStartup(RibbonControl ribbonControl)
         {
             var ribbonPanel = ribbonControl.CreateOrSelectPanel(PanelName, TabName);
-            ribbonPanel.CreateButton("Theme")
-                .SetCommand(Commands.ThemeChange)
-                .SetLargeImage("https://github.com/ricaun-io/Autodesk.Icon.Example/releases/download/2.0.0/Box-Red-Light.tiff");
 
-            ribbonPanel.CreateButton("Theme")
-                .SetCommand(Commands.ThemeChange)
-                .SetLargeImage("https://github.com/ricaun-io/Autodesk.Icon.Example/releases/download/2.0.0/Box-Green-Light.ico");
+            ribbonPanel.RowStackedItems(
+                ribbonPanel.CreateButton("Theme")
+                    .SetCommand(Commands.ThemeChange)
+                    .SetLargeImage("https://github.com/ricaun-io/Autodesk.Icon.Example/releases/download/2.0.0/Box-Red-Light.tiff"),
+                ribbonPanel.CreateButton("Theme")
+                    .SetCommand(Commands.ThemeChange)
+                    .SetLargeImage("https://github.com/ricaun-io/Autodesk.Icon.Example/releases/download/2.0.0/Box-Green-Light.ico"),
+                ribbonPanel.CreateButton("Theme")
+                    .SetCommand(Commands.ThemeChange)
+                    .SetLargeImage("https://github.com/ricaun-io/Autodesk.Icon.Example/releases/download/2.0.0/Box-Blue-32-Light.png")
+            );
 
-            ribbonPanel.CreateButton("Theme")
-                .SetCommand(Commands.ThemeChange)
-                .SetLargeImage("https://github.com/ricaun-io/Autodesk.Icon.Example/releases/download/2.0.0/Box-Blue-32-Light.png");
-
-            ribbonPanel.CreateButton("Theme")
-                .SetCommand(Commands.ThemeChange)
+            ribbonPanel.CreateButton("Circle")
+                .SetCommand(Commands.CircleCreate)
                 .SetLargeImage("Resources/Box-Cyan-Light.tiff");
 
             ribbonControl.ActiveTab = ribbonPanel.Tab;
diff --git a/ricaun.AutoCAD.UI.Example/Commands.cs b/ricaun.AutoCAD.UI.Example/Commands.cs
@@ -1,5 +1,8 @@
 ﻿using Autodesk.AutoCAD.ApplicationServices;
+using Autodesk.AutoCAD.DatabaseServices;
+using Autodesk.AutoCAD.Geometry;
 using Autodesk.AutoCAD.Runtime;
+using System;
 
 namespace ricaun.AutoCAD.UI.Example
 {
@@ -10,5 +13,32 @@ public static void ThemeChange()
         {
             Application.SetSystemVariable("COLORTHEME", 1 ^ (short)Application.GetSystemVariable("COLORTHEME"));
         }
+
+        [CommandMethod("CircleCreate")]
+        public static void CircleCreate()
+        {
+            Document document = Application.DocumentManager.MdiActiveDocument;
+
+            if (document is null) return;
+
+            var database = document.Database;
+
+            using (var transaction = database.TransactionManager.StartTransaction())
+            {
+                var blockTable = transaction.GetObject(database.BlockTableId, OpenMode.ForRead) as BlockTable;
+                var blockTableRecord = transaction.GetObject(blockTable[BlockTableRecord.ModelSpace], OpenMode.ForWrite) as BlockTableRecord;
+
+                var circle = new Circle()
+                {
+                    Radius = new Random().NextDouble() * 100.0,
+                    Center = new Point3d(0, 0, 0),
+                };
+
+                blockTableRecord.AppendEntity(circle);
+
+                transaction.AddNewlyCreatedDBObject(circle, true);
+                transaction.Commit();
+            }
+        }
     }
 }
diff --git a/ricaun.AutoCAD.UI/Input/LockDocumentRelayCommand.cs b/ricaun.AutoCAD.UI/Input/LockDocumentRelayCommand.cs
@@ -3,12 +3,12 @@
 
 namespace ricaun.AutoCAD.UI.Input
 {
-    internal class RelayCommand : ICommand
+    internal class LockDocumentRelayCommand : ICommand
     {
         private readonly Action _execute;
         private readonly Func<bool> _canExecute;
 
-        public RelayCommand(Action execute, Func<bool> canExecute = null)
+        public LockDocumentRelayCommand(Action execute, Func<bool> canExecute = null)
         {
             _execute = execute ?? throw new ArgumentNullException(nameof(execute));
             _canExecute = canExecute;
@@ -21,7 +21,10 @@ public bool CanExecute(object parameter)
 
         public void Execute(object parameter)
         {
-            _execute();
+            using (new Runtime.LockDocumentManager())
+            {
+                _execute();
+            }
         }
 
         public event EventHandler CanExecuteChanged
@@ -31,12 +34,12 @@ public event EventHandler CanExecuteChanged
         }
     }
 
-    internal class RelayCommand<T> : ICommand
+    internal class LockDocumentRelayCommand<T> : ICommand
     {
         private readonly Action<T> _execute;
         private readonly Func<T, bool> _canExecute;
 
-        public RelayCommand(Action<T> execute, Func<T, bool> canExecute = null)
+        public LockDocumentRelayCommand(Action<T> execute, Func<T, bool> canExecute = null)
         {
             _execute = execute ?? throw new ArgumentNullException(nameof(execute));
             _canExecute = canExecute;
@@ -49,9 +52,6 @@ public bool CanExecute(object parameter)
                 return false;
             }
 
-            //if (!string.IsNullOrEmpty(Autodesk.AutoCAD.ApplicationServices.Application.DocumentManager.MdiActiveDocument.CommandInProgress))
-            //    return false;
-
             return _canExecute == null || _canExecute((T)parameter);
         }
 
@@ -62,7 +62,10 @@ public void Execute(object parameter)
                 throw new InvalidOperationException("Parameter cannot be null for value types.");
             }
 
-            _execute((T)parameter);
+            using (new Runtime.LockDocumentManager())
+            {
+                _execute((T)parameter);
+            }
         }
 
         public event EventHandler CanExecuteChanged
diff --git a/ricaun.AutoCAD.UI/RibbonExtension.cs b/ricaun.AutoCAD.UI/RibbonExtension.cs
@@ -147,7 +147,7 @@ public static RibbonButton CreateButton(this RibbonPanelSource ribbonPanel, stri
         public static TRibbonItem SetCommand<TRibbonItem>(this TRibbonItem ribbonItem, Action command) where TRibbonItem : RibbonCommandItem
         {
             if (command is not null)
-                ribbonItem.CommandHandler = new RelayCommand(command);
+                ribbonItem.CommandHandler = new LockDocumentRelayCommand(command);
 
             return ribbonItem;
         }
@@ -162,7 +162,7 @@ public static TRibbonItem SetCommand<TRibbonItem>(this TRibbonItem ribbonItem, A
         public static TRibbonItem SetCommand<TRibbonItem>(this TRibbonItem ribbonItem, Action<TRibbonItem> command) where TRibbonItem : RibbonCommandItem
         {
             if (command is not null)
-                ribbonItem.CommandHandler = new RelayCommand<TRibbonItem>(command);
+                ribbonItem.CommandHandler = new LockDocumentRelayCommand<TRibbonItem>(command);
 
             return ribbonItem;
         }

Original file line number	Diff line number	Diff line change
`@@ -3,12 +3,12 @@`
`3`	`3`
`4`	`4`	`namespace ricaun.AutoCAD.UI.Input`
`5`	`5`	`{`
`6`		`- internal class RelayCommand : ICommand`
	`6`	`+ internal class LockDocumentRelayCommand : ICommand`
`7`	`7`	`{`
`8`	`8`	`private readonly Action _execute;`
`9`	`9`	`private readonly Func<bool> _canExecute;`
`10`	`10`
`11`		`- public RelayCommand(Action execute, Func<bool> canExecute = null)`
	`11`	`+ public LockDocumentRelayCommand(Action execute, Func<bool> canExecute = null)`
`12`	`12`	`{`
`13`	`13`	`_execute = execute ?? throw new ArgumentNullException(nameof(execute));`
`14`	`14`	`_canExecute = canExecute;`
`@@ -21,7 +21,10 @@ public bool CanExecute(object parameter)`
`21`	`21`
`22`	`22`	`public void Execute(object parameter)`
`23`	`23`	`{`
`24`		`- _execute();`
	`24`	`+ using (new Runtime.LockDocumentManager())`
	`25`	`+ {`
	`26`	`+ _execute();`
	`27`	`+ }`
`25`	`28`	`}`
`26`	`29`
`27`	`30`	`public event EventHandler CanExecuteChanged`
`@@ -31,12 +34,12 @@ public event EventHandler CanExecuteChanged`
`31`	`34`	`}`
`32`	`35`	`}`
`33`	`36`
`34`		`- internal class RelayCommand<T> : ICommand`
	`37`	`+ internal class LockDocumentRelayCommand<T> : ICommand`
`35`	`38`	`{`
`36`	`39`	`private readonly Action<T> _execute;`
`37`	`40`	`private readonly Func<T, bool> _canExecute;`
`38`	`41`
`39`		`- public RelayCommand(Action<T> execute, Func<T, bool> canExecute = null)`
	`42`	`+ public LockDocumentRelayCommand(Action<T> execute, Func<T, bool> canExecute = null)`
`40`	`43`	`{`
`41`	`44`	`_execute = execute ?? throw new ArgumentNullException(nameof(execute));`
`42`	`45`	`_canExecute = canExecute;`
`@@ -49,9 +52,6 @@ public bool CanExecute(object parameter)`
`49`	`52`	`return false;`
`50`	`53`	`}`
`51`	`54`
`52`		`- //if (!string.IsNullOrEmpty(Autodesk.AutoCAD.ApplicationServices.Application.DocumentManager.MdiActiveDocument.CommandInProgress))`
`53`		`- // return false;`
`54`		`-`
`55`	`55`	`return _canExecute == null \|\| _canExecute((T)parameter);`
`56`	`56`	`}`
`57`	`57`
`@@ -62,7 +62,10 @@ public void Execute(object parameter)`
`62`	`62`	`throw new InvalidOperationException("Parameter cannot be null for value types.");`
`63`	`63`	`}`
`64`	`64`
`65`		`- _execute((T)parameter);`
	`65`	`+ using (new Runtime.LockDocumentManager())`
	`66`	`+ {`
	`67`	`+ _execute((T)parameter);`
	`68`	`+ }`
`66`	`69`	`}`
`67`	`70`
`68`	`71`	`public event EventHandler CanExecuteChanged`
Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ public static RibbonButton CreateButton(this RibbonPanelSource ribbonPanel, stri`
`147`	`147`	`public static TRibbonItem SetCommand<TRibbonItem>(this TRibbonItem ribbonItem, Action command) where TRibbonItem : RibbonCommandItem`
`148`	`148`	`{`
`149`	`149`	`if (command is not null)`
`150`		`- ribbonItem.CommandHandler = new RelayCommand(command);`
	`150`	`+ ribbonItem.CommandHandler = new LockDocumentRelayCommand(command);`
`151`	`151`
`152`	`152`	`return ribbonItem;`
`153`	`153`	`}`
`@@ -162,7 +162,7 @@ public static TRibbonItem SetCommand<TRibbonItem>(this TRibbonItem ribbonItem, A`
`162`	`162`	`public static TRibbonItem SetCommand<TRibbonItem>(this TRibbonItem ribbonItem, Action<TRibbonItem> command) where TRibbonItem : RibbonCommandItem`
`163`	`163`	`{`
`164`	`164`	`if (command is not null)`
`165`		`- ribbonItem.CommandHandler = new RelayCommand<TRibbonItem>(command);`
	`165`	`+ ribbonItem.CommandHandler = new LockDocumentRelayCommand<TRibbonItem>(command);`
`166`	`166`
`167`	`167`	`return ribbonItem;`
`168`	`168`	`}`