public abstract class MacroPlugin
Thetype exposes the following members.
The name used in context menus of articy:draft, defaults to the DisplayName of not overridden
The display name of the plugin for use in dialogs
The object containing the information from the "PluginManifest.xml" file
The object that represents the currently running articy:draft session and allows access to global functionality
The technical name of the plugin, returns the name from the manifest file
Adds an entry to the main articy:draft log-file 'articy.log'
Adds an entry to the plugin-private log
Callback to check if adding a pin is allowed
Callback to check if removing a pin is allowed
Is called from the articy:// protocol handler if the called url is like articy://./plugin/<technical name of plugin>/<cmd>
Provide icons based on their technical names
|GetMenuEntries(ListObjectProxy)|| Obsolete. |
Requests command descriptors to create a context menu
Requests command descriptors to create a context menu. This is the newer version that also provides information about the source context of the request. Available since version 3.1.6
Method that is called once directly after the plugin was loaded into the articy:draft process. If your plugin uses own WPF resource dictionaries you need to register them within this method using RegisterResource(String)
Callback to check if creating the given object at the given location is allowed.
called to check if cutting the given objects is allowed
called to check if deleting the given objects is allowed
Checks if pasting is possible
Checks if relocating is possible
Callback to check if renaming the display name of the given object is allowed.
Called when a journey point was hit
looks up a localized string with the given Loca-Id and formats the resulting text with the given parameters using the normal string.Format patterns
looks up a localized string with the given Loca-Id
Called when an object was created and just before entering the "auto-rename" on new objects
called to inform the plugin that the given objects are put into the clipboard
called after the delete has be done
Called when the list of objects are about to be cut off the project. Called before the operation to use the given still valid objects
called after the delete has be done
Called when the list of objects are about to be deleted from the project. Called before the operation to use the given still valid objects
called after the paste is complete. This is the backward compatibility hook and is called from ObjectsPastedEx without the aFromCut parameter
called after the paste is complete. This call can distinguish the cases where the paste comes from a previous cut or copy operation
called when a pasting starts at the given target container
called after the relocate
called before the relocate
Called when the a multi-user partition was loaded as part of a claim or update command
Called after the a multi-user partition was published or unclaimed
Called before a multi-user partition is published or unclaimed
Called after a multi-user partition is published or unclaimed, can be used to prevent publishing if a non null error is returned. Will be called after the "PartitionPublished" callback
Called when the a multi-user partition was unloaded. Called when a partition is either claimed or updated
Called when the a multi-user partition is about to be unloaded. Called when a partition is either claimed or updated
called directly after a project was loaded.
Called after the project was saved
Called before the project is being saved
Called when the project was unloaded. Can be used to free resources. Any access to objects will fail.
Called when the project starts unloading (closing the project or articy:draft)
Register the resource dictionary given by the relative Uri-String to the main WPF application resources
Register the resource dictionary given by the Uri to the main WPF application resources
Sets up the log types that should be written into the log.
Shows a message box with the given parameters
Shows a query box to enter a single value. This is a convenience wrapper of the same method of the Session, but uses the plugins display name if no caption text was provided with the call.
called after an object gets a new template.
called before an object gets a new template.
Called when a template property has changed
Called when a template property is about to be changed (since articy:draft 3.1.29 / MDK 1.7.0)
Called before a multi-user partition(s) are published or unclaimed, can be used to prevent publishing if a non null error is returned. Will be called before the "PartitionPublishing" callback and before the user is asked to save the data. So it is possible to also use this callback to do pre-publishing changes without stopping the process. If the commit is triggered from a non-interactive context, the message box text is thrown as an exception.