Issue #103:

We auto generate IDs for new commands now. The ID that is auto-generated should be the same one that would be used if the compiler would auto generate it.
Also added menu item "Auto generate IDs for all commands".

The benefit of explicitly setting IDs is, that items in the quickstart menu can be persisted by their ID now, without having to worry that the ID might change (e.g. because the list was re-sorted)

Author: SaschaSchaefer

Designer/Bin/RibbonDesigner.exe

@@ -171,6 +171,7 @@   TFrameCommands = class(TFrame)
     procedure ClearDocument;
     procedure RefreshSelection;
     procedure ShowDocument(const Document: TRibbonDocument);
+    function FindSmallestUnusedID(const pMinId: Integer = 2): Integer;
   end;
 
 const
@@ -185,8 +186,10 @@ implementation
 
 uses
   UITypes,
-  FMain, 
-  System.Generics.Collections, FCommandsSearch;
+  FMain,
+  System.Generics.Collections,
+  FCommandsSearch,
+  System.Math;
 
 { TFrameCommands }
 
@@ -200,6 +203,7 @@ procedure TFrameCommands.ActionAddCommandExecute(Sender: TObject);
   ListViewCommands.Selected.Focused := True;
   ListViewCommands.Selected.MakeVisible(False);
   EditName.SetFocus;
+  BtnGenerateIDClick(Sender);
   Modified;
 end;
 
@@ -304,16 +308,54 @@ constructor TFrameCommands.Create(AOwner: TComponent);
   FFrameLargeHCImages.Parent := PanelLargeHCImages;
 end;
 
+function TFrameCommands.FindSmallestUnusedID(const pMinId: Integer = 2): Integer;
+var
+  lCommand: TRibbonCommand;
+  lIDs: TDictionary<Integer, TRibbonCommand>;
+  I: Integer;
+const
+  cMaxValidID = 59999;
+
+begin
+  lIDs := TDictionary<Integer, TRibbonCommand>.Create();
+
+  try
+    // Gather all IDs that are already taken in a dictionary
+    for lCommand in FDocument.Application.Commands do
+      if lCommand.Id > 0 then
+        lIDs.Add(lCommand.Id, lCommand);
+
+    // Iterate all allowed IDs, starting with the smallest. Return the first one that hasn't been used yet
+    for I := pMinId to cMaxValidID do
+      if not lIDs.ContainsKey(I) then
+        Exit(I);
+
+    raise ERangeError.Create('No valid, unused ID could be found within the range between ' + pMinId.ToString + ' and ' + cMaxValidID.ToString);
+  finally
+    lIDs.Free;
+  end;
+end;
+
 procedure TFrameCommands.BtnGenerateIDClick(Sender: TObject);
 var
   command: TRibbonCommand;
   highID : integer;
+  lMinID: Integer;
 begin
   highID := 1;
   for command in FDocument.Application.Commands do
     if command.Id > highID then
       highID := command.Id;
-  EditId.Text := IntToStr(highID + 1);
+
+  lMinID := 0;
+
+  if Assigned(ListViewCommands.Selected) then
+    lMinID := ListViewCommands.Selected.Index;
+
+  lMinID := lMinID + 2;
+
+  // By using at least the index of the item, we mimic the behavior of the ribbon compiler's ID auto generation as closely as possible.
+  EditId.Text := FindSmallestUnusedID(lMinID).ToString;
 end;
 
 procedure TFrameCommands.Deactivate;

Designer/FCommands.pas

@@ -146,6 +146,12 @@ object FormMain: TFormMain
       ShortCut = 16462
       OnExecute = ActionNewExecute
     end
+    object ActionGenerateCommandIDs: TAction
+      Category = 'Project'
+      Caption = 'Auto generate IDs for all commands'
+      Hint = 'Generates and sets IDs for all commands in this markup.'
+      OnExecute = ActionGenerateCommandIDsExecute
+    end
     object ActionSaveAs: TAction
       Category = 'File'
       Caption = 'Save As'
@@ -700,6 +706,9 @@ object FormMain: TFormMain
       object AutogenerateIDsforallresources1: TMenuItem
         Action = ActionGenerateResourceIDs
       end
+      object AutogenerateIDsforallcommands1: TMenuItem
+        Action = ActionGenerateCommandIDs
+      end
       object Setresourcename1: TMenuItem
         Action = ActionSetResourceName
       end

Designer/FMain.dfm

@@ -88,6 +88,8 @@   TFormMain = class(TForm)
     ActionSetResourceName: TAction;
     Setresourcename1: TMenuItem;
     ActionGenerateResourceIDs: TAction;
+    AutogenerateIDsforallcommands1: TMenuItem;
+    ActionGenerateCommandIDs: TAction;
     AutogenerateIDsforallresources1: TMenuItem;
     procedure FormActivate(Sender: TObject);
     procedure ActionPreviewExecute(Sender: TObject);
@@ -109,6 +111,7 @@   TFormMain = class(TForm)
     procedure ActionMSDNExecute(Sender: TObject);
     procedure ActionSetResourceNameExecute(Sender: TObject);
     procedure ActionGenerateResourceIDsExecute(Sender: TObject);
+    procedure ActionGenerateCommandIDsExecute(Sender: TObject);
   private
     { Private declarations }
     FInitialized: Boolean;
@@ -166,7 +169,7 @@   TFormMain = class(TForm)
 implementation
 
 uses
-  UITypes, System.Win.Registry, UIRibbonUtils;
+  UITypes, System.Win.Registry, UIRibbonUtils, System.Math;
 
 {$R *.dfm}
 
@@ -184,6 +187,22 @@ procedure TFormMain.ActionExitExecute(Sender: TObject);
   Close;
 end;
 
+procedure TFormMain.ActionGenerateCommandIDsExecute(Sender: TObject);
+var
+  lCommand: TRibbonCommand;
+  I: Integer;
+begin
+  for I := 0 to FFrameCommands.ListViewCommands.Items.Count - 1 do
+  begin
+    lCommand := FFrameCommands.ListViewCommands.Items[i].Data;
+    if lCommand.ID = 0 then
+      // Try to mimic the auto ID generation of the ribbon compiler.
+      lCommand.ID := FFrameCommands.FindSmallestUnusedID(I + 2)
+  end;
+
+  FFrameCommands.RefreshSelection;
+end;
+
 procedure TFormMain.ActionGenerateResourceIDsExecute(Sender: TObject);
 
 var