Verktygsfält

Verktygfält (även kallade Toolbar Components) används för att skapa knappar och andra kontroller som visas i det stora verktygsfältet i huvudgränssnittet. Utvecklare kan lägga till knappar, grupper och flikar precis där man önskar, inklusive på de flikar som redan finns installerade med Dynamix, exempelvis Start- eller Verktygsfliken.

För att skapa en egen komponent ärver vi ett Dynamix-objekt från ToolbarComponent (i namnrymden Dynamix.ToolbarComponents). Enklast gör vi detta genom att välja Add - New Item och välja Dynamix Toolbar Component bland Dynamix-mallarna.

Den metod som måste implementeras är CreateToolbarComponents. Mallen har förberett skalet enligt

  1. C#
  1. public override void CreateToolbarItems()
  2. {
  3. //TODO: Create tabs/groups/buttons etc and add them to the main toolbar or to existing tabs/groups
  4. //E.g. Toolbar.CurrentToolbar.Tabs.Add( MyNewTab );
  5. //E.g. PageToolbarComponent.MiscGroup.Items.Add( MyNewButton );
  7. throw new NotImplementedException();
  8. }

Flikar, grupper, knappar och kontroller

De grundläggande komponenterna i verktygsfält är flikar (ToolbarTab), grupper (ToolbarGroup) och knappar (ToolbarButton). Mer information om dessa finns under respektive kontrolls sida. En översikt över andra kontroller finns på sidan om basklassen ToolbarItem

Beroenden till andra verktygsfältskomponenter

Om vår komponent behöver referera till andra komponenter, t ex för att lägga in knappar eller grupper på redan existerande flikar måste vi tala om det genom att returnera referenser till dem i metoden GetDependencies. Med hjälp av resultaten från denna metod avgör Dynamix i vilken ordning CreateToolbarComponents ska köras - komponenter som beror av andra körs alltid efter den komponent de beror av.

Om vi t ex vill en ny grupp på fliken "Verktyg" markerar vi att vi behöver ToolsToolbarComponent enligt:

  1. C#
  1. using Dynamix.ToolbarComponents;
  3. [Installable]
  4. public class MyToolbarComponent : ToolbarComponent
  5. {
  6. ...
  7. public override IEnumerable<ToolbarComponent> GetDependencies()
  8. {
  9. yield return ToolsToolbarComponent.Instance;
  10. }
  11. }

I CreateToolbarComponents kan vi sedan referera till kontroller skapade av verktygsfliken:

  1. C#
  1. using Dynamix.ToolbarComponents;
  3. [Installable]
  4. public class MyToolbarComponent : ToolbarComponent
  5. {
  6. public override void CreateToolbarItems( )
  7. {
  8. var myGroup = new ToolbarGroup { Title = "My group" };
  9. // Add items to myGroup
  10. ToolsToolbarComponent.ToolsTab.Groups.Add( myGroup );
  11. }
  13. public override IEnumerable<ToolbarComponent> GetDependencies()
  14. {
  15. yield return ToolsToolbarComponent.Instance;
  16. }
  17. }

Installation från kod

Verktygsfält kan installeras från kod med:

  1. C#
  1. Dynamix.Object.DB_Install<MyToolbarComponent>();

Installation från redaktörsgränssnittet

För att verktygsfältet ska kunna installeras från redaktörssgränssnittet behöver det märkas med attributet Installable (attributet är satt som standard, se exemplen ovan).

1. Öppna verktyget Komponenter på fliken Administration

2. Markera Verktygsfält till vänster

3. Klicka på Installera

En lista med de verktygsfält som ännu inte är installerade visas:

4. Markera de komponenter du vill installera och klicka Ok