- Added procedure "Remove" to TUIRibbon, so that we can remove and free TUICommands again (e.g. for dynamic galleries)

- Added BeginUpdate/EndUpdate mechanism to TRibbonCollectionAction, so that we can run multiple operations without fully refreshing the gallery each time
- Extended "Remove" method of TRibbonCollectionAction, so that "old" TUICommands are now cleaned up properly and won't remain in memory

Author: SaschaSchaefer

Lib/UIRibbon.pas

@@ -85,7 +85,7 @@   TRibbonMarkupElementList = class(TList<TRibbonMarkupElement>)
 
   /// <summary>
   /// Used for property "UseDarkMode". Values of this enum determine whether or not the ribbon should support Windows' "Dark Mode". The different values are:
-  ///   TDarkMode.Always: Always enable the dark mode for the ribbon (if supported by the operating system, requires Window 10 1809 or higher)
+  ///   TDarkMode.Always: Always enable the dark mode for the ribbon (if supported by the operating system)
   ///   TDarkMode.Auto: Use the same setting as Windows to determine wheter or not the ribbon should be displayed in dark mode, or not. If the user selected dark mode for Windows, the ribbon will use it as well.
   ///   TDarkMode.Never: Don't use the dark mode at all.
   /// </summary>
@@ -311,6 +311,12 @@   TUIRibbon = class(TWinControl, IUIApplication)
     { Loads the ribbon. }
     procedure Load(); overload;
 
+    /// <summary>
+    /// Removes a TUICommand from the internal collection and frees it. Make sure that the command is not used anymore before removing it.
+    /// This can be used, e.g. for dynamic galleries, where existing commands need to be removed again.
+    /// </summary>
+    procedure Remove(const pCommand: TUICommand);
+
     { Invalidates on or more aspects from a UI command. This will cause a
       repaint of the specified command. The command will be queried for new
       values based on the invalidation aspects.
@@ -736,7 +742,6 @@ destructor TUIRibbon.Destroy;
   if roAutoPreserveState in Options then
     SaveRibbonSettings(); // Save quick toolbar, etc.
 
-  //IMPORTANT: IUIFramework.Destroy has to be called before the commands are freed. They seem to be still needed/referenced in certain cases.
   if Assigned(FFramework) and FAvailable then
     FFramework.Destroy;
 
@@ -1222,6 +1227,11 @@ procedure TUIRibbon.RegisterForImageChanges;
   end;
 end;
 
+procedure TUIRibbon.Remove(const pCommand: TUICommand);
+begin
+  FCommands.Remove(pCommand.CommandId);
+end;
+
 procedure TUIRibbon.LoadFramework;
 var
   Intf: IUnknown;

Lib/UIRibbonActions.pas

@@ -9,7 +9,7 @@ interface
   ActnMan,
   UIRibbonCommands,
   System.Generics.Collections,
-  Winapi.ActiveX,
+  Winapi.ActiveX, 
   UIRibbonApi;
 
 type
@@ -140,6 +140,7 @@   TRibbonCollectionAction = class(TRibbonAction<TUICommandCollection>)
       fSelectedItem: Integer;
       fSelectionInitialized: Boolean;
       fOriginalOnSelect: TUICommandCollectionSelectEvent;
+      fUpdateCount: Integer;
       /// This flag indicates that a refresh should be performed as soon as the collection is not being displayed anymore.
       fRefreshWhenNotDisplayed: Boolean;
       function GetItem(pIndex: Integer): TCustomAction;
@@ -182,6 +183,10 @@   TRibbonCollectionAction = class(TRibbonAction<TUICommandCollection>)
       /// and dynamically creates commands that will be added to the collection.
       /// </summary>
       procedure RefreshCommandCollection();
+      /// <summary> Use this to mark larger modifications to the list of actions. No refresh of the internal list of commands will be performed until EndUpdate is called. </summary>
+      procedure BeginUpdate;
+      /// <summary> Marks the end of an ongoing modification to the list of actions. Ending the update will trigger a refresh of the internal list of commands. </summary>
+      procedure EndUpdate;
       function Update(): Boolean; override;
       /// Returns the amount of actions that have been added.
       function ItemCount: Integer;
@@ -615,6 +620,9 @@ procedure TRibbonCollectionAction.RefreshCommandCollection();
   // Command link is not (yet) created -> exit.
   if not Assigned(UICommand) then exit;
 
+  if fUpdateCount > 0 then
+    Exit;
+
   // Check if a refresh was postponed while the collection was displayed and if we can now perform the refresh.
   if IsCurrentlyDisplayed then
   begin
@@ -659,7 +667,16 @@ procedure TRibbonCollectionAction.RefreshCommandCollection();
 end;
 
 procedure TRibbonCollectionAction.Remove(pAction: TCustomAction);
+var
+  lCommand: TUICommand;
 begin
+  if Assigned(UICommand) then
+  begin
+    lCommand := (UICommand.Owner as TUIRibbon).GetCommand(pAction);
+    if Assigned(lCommand) then
+      (UICommand.Owner as TUIRibbon).Remove(lCommand);
+  end;
+
   fActionList.Remove(pAction);
   RefreshCommandCollection;
 end;
@@ -742,15 +759,35 @@ procedure TRibbonCollectionAction.AddRange(pSource: TList<TCustomAction>);
   RefreshCommandCollection;
 end;
 
+procedure TRibbonCollectionAction.BeginUpdate;
+begin
+  Inc(fUpdateCount);
+end;
+
+procedure TRibbonCollectionAction.EndUpdate;
+begin
+  Dec(fUpdateCount);
+  if (fUpdateCount = 0) then
+    RefreshCommandCollection;
+end;
+
 procedure TRibbonCollectionAction.Clear;
+var
+  I: Integer;
 begin
-  fActionList.Clear;
-  RefreshCommandCollection;
+  BeginUpdate;
+  try
+    for I := fActionList.Count - 1 downto 0 do
+      Remove(fActionList[I]);
+  finally
+    EndUpdate; //This triggers RefreshCommandCollection()
+  end;
 end;
 
 constructor TRibbonCollectionAction.Create(AOwner: TComponent);
 begin
   inherited;
+  fUpdateCount := 0;
   fActionList := TList<TCustomAction>.Create;
   fSelectionInitialized := False;
   fRefreshWhenNotDisplayed := False;