====== Menübefehle ======
Für den Aufbau der [[GUI_Menus|Menüs]] stellt das Primus Framework Befehle zur Verfügung. Die folgende Auflistung ist Alphabetisch sortiert.

===== Allgemeine Attribute =====
Für die Menübefehle können / müssen folgende [[Glossar#Attribut]]e angegeben werden.
^Attribut^ Pflicht^ Wert^ Funktion^
|addin|  **X**((Für Befehle aus Addins ein Pflichtfeld))  | ''Addin''| Name des [[Addins|Addin]] das den Befehl zur Verfügung stellt|
|enabled| | ''TRUE''/''FALSE''| Gibt an ob der Befehl aktiv ist|
|icon| | ''Dateipfad''| Gibt den Pfad zum [[Glossar#Icon]] ohne die Dateiendung ''.ico'' an|
|parameter|   **X**((abhängig vom Befehl))  | | Übergibt Parameter an den Befehl die seine Funktion beeinflussen|
|text| | ''Text''| Der der für diesen Befehl im Menü angezeigt wird, die Verwendung von [[Elementtext]]en wird empfohlen|
| tooltip| |:::| Ein beschreibender Text, der angezeigt wird wenn die Maus auf dem Menüeintrag platziert wird, die Verwendung von Elementtexten wird empfohlen|
|visible| |''TRUE''/''FALSE''| Gibt an ob der Befehl im Menü sichtbar ist|

===== Allgemeine Menüfunktionen =====
Für den Aufbau und die Strukturierung von Menüs stehen folgende Befehle zur Verfügung.
^Befehl^ Funktion^
|[[SEPARATOR]]| Erzeugt eine Trennlinie innerhalb des Kontextmenüs|
|[[SUBMENU]]| Bindet ein separat definiertes Untermenü ein|
|[[INCLUDE]]| Bindet die separat definierten Einträge direkt in das Kontextmenü ein|

===== Befehle des Primus Framework =====
^Funktion	^Beschreibung^
|[[:prmallwithbrokenlinks]]|Listet alle Dateien mit unterbrochenen Verknüpfungen auf|
|[[:prmallwithreiterantname]]|Listet alle Dateien mit wiederholenden Namen auf|
|[[:prmattachmentcopy]]|Anhang kopieren|
|[[:prmattachmentcut]]|Anhang ausschneiden|
|[[:prmattachmentdelete]]|Anhang löschen|
|[[:prmattachmentnew]]|Erzeugt einen neuen Anhang, dazu wird das angegebene DataSheet angezeigt.|
|[[:prmattachmentnewcopy]]|Kopiert einen Anhang, dazu wird das angegebene DataSheet angezeigt.|
|[[:prmattachmentopen]]|Öffnet den gewählten Anhang|
|[[:prmattachmentpaste]]|Fügt einen Anhang ein|
|[[:prmattachmentrename]]|Anhang umbenennen|
| [[prmElementsChangeValueByDlg]]| Datenfeld über einen Dialog ändern|
| [[prmClearRecyclebin]]|Papierkorb leeren|
|[[prmCopyDocData]]|Kopiert alle Primus Eigenschaften in die Zwischenablage|
|[[:prmcopyfieldvalues]]|Kopiert die Primus Datenfelder der gewählten Datei in die Zwischenablage|
|[[:prmcreateallnotexistingxmls]]|Fehlende XMLs anlegen oder Ungenutzte / verwaiste XML-Dateien entfernen|
| [[prmDeleteAllPrimusXMLs]]| Löscht alle von Primus erzeugten XML Dateien|
| [[prmDeleteUnusedXMLs]]| Löscht alle Primus XML zu denen es kein Dokument mehr gibt|
|[[:prmelementsactivatevirtlink]]| {{tag>klaerungsbedarf}}|
|[[:prmelementsattachexternfile]]|Datei ersetzen durch Externe|
|[[:prmelementsattachmentstoclipboard]]|Kopiert alle oder bestimmte Anhänge der gewählten Datei.|
|[[:prmelementschangefiletype]]|FileType ändern|
|[[:prmelementscheckinlocal]]|Lokal ausgecheckte Dateien einchecken|
|[[:prmelementscheckoutlocal]]|Check Elemente lokal aus, kann im Kontext des lokalen Zielordners oder des Quellordners auf dem Server aufgerufen werden.|
|[[:prmelementscopy]]|Element kopieren (Zwischenablage)|
|[[:prmelementscopylocaltoserver]]|Einchecken von lokalen Dokumenten|
|[[:prmelementscopypath]]|Dateipfad kopieren|
|[[:prmelementscut]]|Element ausschneiden (Zwischenablage)|
|[[:prmelementsdelete]]|Element löschen|
| [[:prmelementsdeletedoclink]]| Löschen fehlerhafter Dokumentverknüpfungen {{tag>Klärungsbedarf}}|
|[[:prmelementsdeletevirtlink]]|Verknüpfung Löschen|
| [[prmElementsEditReadonlyDataSheet]]| Datenblatt zum Ändern von Eigenschaften aufrufen|
|[[:prmelementsexportfile]]|Element exportieren|
|[[:prmelementsfilestoclipboard]]|Kopiert Elemente in die Zwischenablage|
|[[prmElementsGenerateNewDocumentName]]| Generiert einen neuen Dateinamen und legt ihn in die Zwischenablage|
|[[:prmelementsjobserverstart]]|Startet den Jobserver Prozess|
|[[:prmelementsjobserverstop]]|Stoppt den Jobserver Prozess|
|[[:prmelementsnew]]|Neues Element anlegen|
|[[:prmelementsnewcopy]]|Erstellt eine neue (?) Kopie eines Elements|
| [[prmElementsNewVersion]]|Neue Version erstellen|
|[[:prmelementsopen]]|Element öffnen|
|[[:prmelementspaste]]|Element einfügen (Zwischenablage)|
|[[:prmelementspastevirtlink]]|ElementLink in einen Virtuellen Ordner einfügen (Zwischenablage).|
|[[:prmelementsprintattachments]]|Druckt Anhänge|
| [[prmElementsRemoveNewestVersion]]|Löscht das gewählte Dokument und setzt die Vorversion zurück auf freigegeben|
| [[prmElementsRename]]|Element umbenennen|
| [[prmElementsRenameMsgByParam]]| Ändert die Endung einer Messagedatei und markiert sie so als erledigt|
| [[prmElementsReplaceByNewestVersion]]|Durch neueste Version ersetzen|
|[[:prmelementsrestartjob]]|Neustart des Jobservers / Job|
|[[:prmelementsrestore]]|Element€ aus dem Papierkorb wiederherstellen.|
|[[:prmelementsshowjoblogs]]|Zeigt die Jobserver Logs an.|
|[[:prmelementsstatus]]|Status ändern|
|[[:prmelementssynchroniselocal]]|Synchronisieren|
| [[prmExecuteNamedCalls]]| Ruft einen [[NamedCalls|Named Call]] auf|
| [[prmFindCorruptXMLDataFiles]]| Findet beschädigte [[Daten-XML]]|
|[[:prmfindextended]]|Erweiterte Suche|
|[[:prmfindfilebypath]]|Dateipfad suchen|
|[[:prmfindinallfields]]|Suchen|
|[[:prmfindnextinallfields]]|Weiter suchen F3|
|[[:prmfoldersettings]]|Ordner Einstellungen|
|[[:prmlocalworkmode]]|Schaltet zwischen Online, Offline und Serverarbeitsweise um.|
|[[:prmopenexplorer]]|Öffnet den Explorer für das gewählte Element|
|[[:prmpartsliststructpositions]]|Stückliste Autopositionen|
|[[:prmpartsliststructpositionscheck]]|Stückliste auf doppelte Positionen prüfen|
| [[prmPasteDocData]]|Schreibt die zuvor mit [[prmCopyDocData]] kopierten Daten in die ausgewählten Datenfelder.|
|[[:prmpastefieldvalues]]|(Feld-)Daten einfügen (Zwischenablage)|
|[[:prmprojectassignallchildvaluesfromparent]]|Aktualisiere Unterordnern|
|[[:prmprojectcheckinlocal]]|Einchecken und bereinigen|
|[[:prmprojectcheckoutlocal]]|Lokal auschecken|
|[[:prmprojectscreatebytemplate]]|Struktur anlegen mit Vorlage|
|[[:prmprojectsdelete]]|Löscht in Element aus dem Projektbaum|
|[[:prmprojectsedit]]|Projekt bearbeiten|
| [[prmProjectsFindByData]]| Suchen nach Verzeichnissen anhand ihrer Eigenschaften|
| [[:prmprojectsfindbyname]]| Suchen nach Projekt-/Ordnernamen|
|[[:prmprojectslistallsubprojects]]|Alle Unterprojekte auflisten|
|[[:prmprojectsnew]]|Neuer Projektknoten|
| [[:prmprojectremoveallunusedparentrefs]]| Entfernt alle unbenutzten Parent Referenzen|
|[[:prmprojectsresetnode]]| Liest die Ordner Struktur unterhalb des gewählten Ordners neu ein|
| [[prmProjectsUploadXmlsToDB]]|Suchindex aktualisieren|
|[[:prmprojectsynchroniselocal]]|Projekt synchronisieren|
|[[prmProjectSyncroniseAllDataFields]]|Synchronisiert alle Datenfelder der XMLs untereinander|
|[[prmProjectUpdateAllRefs]]| Aktualisiert alle CAD-Referenzen|
|[[:prmprojectvirtfolderactivate]]|Referenzelement aktivieren|
|[[:prmprojectvirtfolderdelete]]|Virtuelles Element löschen|
|[[:prmprojectvirtfolderrename]]|Virtuelles Element umbenennen|
|[[:prmrefelementssetactive]]|Element aktivieren, Gehe zu Ordner|
| [[prmRefElementsSetRef1]]|Gewähltes Element als Ref1 setzen|
|[[:prmreloadcfg]]|PrimusSE.CFG.XML neu einlesen, lädt die aktuelle Primus Konfiguration, Strings werden nicht neu eingelesen|
| [[prmRemoveWriteAccessCall]]| {{tag>Klärungsbedarf}}|
| [[prmSetReservation]]|Reservierung setzen / aufheben|
|[[:prmshowdocumentswithsamename]]|Elemente Dokumenten mit gleichen Namen auflisten|
|[[:prmshowpartslist]]|Stückliste Model|
|[[:prmshowpartsliststruct]]|Stückliste Summe|
| [[prmShowWhereUses]]|Verwendungsnachweis|
|[[:prmshowwhereuses_allcomponentsbyext]]|Listet alle zugehörigen Komponenten eines bestimmten Dateityps auf.|
|[[:prmshowwhereuses_alldrawings]]|Alle Zeichnungen der Komponenten|
|[[:prmshowwhereuses_allwithoutdrawings]]|Alle Komponenten ohne Zeichnung|
|[[:prmshowwhereuses_componentsdrawings]]|Alle Komponenten und Zeichnungen|
| [[prmStartProcess]]|Aufruf eines externen Programms über einen Menüpunkt|
| [[prmTestFAMServiceConnection]]| {{tag>Klärungsbedarf}}|
| [[prmTestWriteAccessCall]]| :::|
| [[prmUpdateParentRef1Data]]|Bei Änderungen eines Eingabefelds wird das Feld des zugehörigen Parentelements mit aktualisiert. Automatisches Aktualisieren bei Änderungen in einem Eingabefeld|
| [[prmUpdateXMLFieldsAndParentRefs]]|Alle XML Dateien für den gewählten Projektknoten aktualisieren.|
| [[prmUseDBDataActive]]| Wechselt zwischen DB- und XML-Modus (ab Primus2025)|

===== Addins =====
Zu den vom Primus Framework bereitgestellten Befehlen und Funktionen, kommen noch Befehle dazu die durch [[Addins]] bereitgestellt werden. Um einen solchen Befehl aufzurufen muss der [[Glossar#Tag-Name]] der Name des Befehls sein, das [[Glossar#Attribut]] //addin// ist erforderlich und muss den Namen mit dem das Addins von Primus geladen wird haben.

==== Beispiel ====
<code xml><seCopySEMaterialsToCFG addin="SEInterface" visible="TRUE" enabled="TRUE" parameter=".\Resources\SE_MATERIAL.LIST.xml|Material" text="$Primus.MNU_COPY_SE_MATERIAL_TOCFG" icon="Resources\AppInterfaces\SolidEdge\Icons\segetproperties" /></code>
{{tag>Menu GUI Befehlsliste Liste}}