BPM:Configuration xml

Configuration.xml

In der Configuration.xml Datei wird definiert welche RibbonButtons das Plugin erzeugt, auf welcher RibbonPage und in welcher RibbonGroup. Zusätzlich wird definiert, was bei einem Druck auf den Button passiert und ob es eine Bedingung für das erscheinen des Buttons gibt.

Erklärung

• In Grün markiert sieht man dass die Datei aus Zwei Bereichen besteht. Einmal BarButtonItems und einmal BarButtonLinkContainerItems.
• In Blau markiert sieht man den jeweiligen Button hier können natürlich N Buttons definiert werden. Bitte achten Sie darauf dass der aufbau eines BarButtonLinkContainer's durch die zusätzliche Buttonlist abweicht.
• In Braun markiert sieht man die ID des Buttons, diese muss gesetzt werden, da diese den Button eindeutig kennzeichnet. Bitte achten Sie darauf dass die ID so eindeutig ist dass Sie nicht mit anderen Lösungen sich übershcneidet und vergeben Sie diese nicht doppelt.
• In Orange markiert die Buttonlist eines BarButtonLinkContainer's. Hier werden die ID's der Buttons hinterlegt welche unterhalb des BarButtonLinkContainer's erscheinen. Achtung: Buttons werden automatisch Visible wenn Sie „Kinder“ eines BarButtonLinkContainer's sind. Die Reihenfolge ist die Reihenfolge innerhalb der XML Datei.
• In Grau markiert die Sichtbarkeit eines Buttons. Wenn der Button teil eines BarButtonLinkContainers ist, stellen Sie diesen auf Never. Der BarButtonLinkContainer stellt diesen automatisch auf Always. Sie verhindern allerdings durch die Einstellung Never, dass dieser zusätzlich im Ribbon als eigenständiger Button angezeigt wird.
• In Lila markiert sehen Sie die zuweisung eines ItemClick Events an eine Funktion namens BarButtonItem2OnItemClick. Hierbei handelt es sich um Devexpress BarButtonItem Events welche definiert werden können.
• In Pink markiert sehen Sie eine hinterlegte BarButtonItem Condition, diese Condition gibt true bzw. false zurück. Bei False würde der Button nicht angelegt werden!

Wenn also Buttons nur unter bestimmten bedingungen angezeigt werden dürfen (bspw. File XY existiert oder nicht), dann müssen Sie dies über eine condition in den RibbonButtonMethods lösen.​

Template

<?xml version="1.0" encoding="utf-8"?>
<Ribbon>
  <BarButtonItems>
    <BarButtonItem id="BarButtonItemUniqueId" position="1" condition="ThisIsMyCondition">
      <Caption>Ribbon_Button_Text_BarButtonItemUniqueId</Caption>
      <Page>Ribbon_Page_Text</Page>
      <Group>Ribbon_Group_Text</Group>
      <Visibility>Never</Visibility>
      <!--Always, Never, Always, OnlyInCustomizing, OnlyInRuntime-->
      <Glyph>database_table.png</Glyph>
      <LargeGlyph>database_table.png</LargeGlyph>
      <Event name="ItemClick">barButtonItemWevServicePluginsClick</Event>
    </BarButtonItem>
  </BarButtonItems>
  <BarButtonLinkContainerItems>
    <BarButtonLinkContainer id="BarButtonLinkContainerUniqueId" position="1" condition="">
      <Caption>Ribbon_Button_Text_BarButtonLinkContainerUniqueId</Caption>
      <Page>Ribbon_Page_Text</Page>
      <Group>Ribbon_Group_Text</Group>
      <Visibility>Always</Visibility>
      <Glyph>image.png</Glyph>
      <LargeGlyph>image.png</LargeGlyph>
      <Event name=""></Event>
      <Buttonlist>
        <button id="BarButtonItemUniqueId" />
      </Buttonlist>
    </BarButtonLinkContainer>
  </BarButtonLinkContainerItems>
</Ribbon>