MacroPlugin Class
This is the abstract base class for any Macro plugin for articy:draft X
Definition
Namespace: Articy.Api.Plugins
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
C#
public abstract class MacroPlugin- Inheritance
- Object MacroPlugin
- Derived
- AutoSaveInternalPlugin
Properties
| ConfigurationContainers | All registered configuration containers |
| ContextName | The name used in context menus of articy:draft, defaults to the DisplayName if not overridden |
| DisplayName | The display name of the plugin for use in dialogs |
| Manifest | The object containing the information from the "PluginManifest.xml" file |
| Session | The object that represents the currently running articy:draft session and allows access to global functionality |
| TechnicalName | The technical name of the plugin, returns the name from the manifest file |
| ToastNotifications |
Methods
| AddGlobalLogEntry | Adds an entry to the main articy:draft log-file 'articy.log' |
| AddLogEntry | Adds an entry to the plugin-private log |
| CanAddPin | Callback to check if adding a pin is allowed |
| CanRemovePin | Callback to check if removing a pin is allowed |
| ConfigurationContainerTConfigurationObject | Use this to access the container holding the persisted configuration object of the given type. |
| ConfigurationsTConfigurationsObject | Use this to access the persisted configurations object of the given type. |
| CustomizeToolbars | Called directly after a project was loaded to allow you to register different toolbar configurations based on the available views. |
| Deinitialize | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExecuteProtocol | Is called from the articy:// protocol handler if the called url is like articy://./plugin/<technical name of plugin>/<cmd> |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetIcon | Provide icons based on their technical names |
| GetMenuEntries(ContextArgsBase) | 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 4.2 |
| GetMenuEntries(ListObjectProxy, ContextMenuContext) |
Requests command descriptors to create a context menu. This version also provides information about the source context of the request.
Available since version 3.1.6
|
| GetReferenceMenuEntries | Is called if the context menu entries for a reference (e.g. a value in a slot or strip) are right-clicked. The command callback will get only the selection from this callback. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| HasRegisteredConfigurations | Returns true if any configuration objects where found while loading the plugin |
| Initialize | 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) |
| IsCreatingAllowed | Callback to check if creating the given object at the given location is allowed. |
| IsCuttingAllowed | called to check if cutting the given objects is allowed |
| IsDeletingAllowed | called to check if deleting the given objects is allowed |
| IsObjectCreationAllowed | A callback to allow you to filter out options for user object creation in a given context. This currently only works for object creation in the flow view. It requires you to have a specific license component. |
| IsPastingAllowed | Checks if pasting is possible |
| IsRelocatingAllowed | Checks if relocating is possible |
| IsRenamingAllowed | Callback to check if renaming the display name of the given object is allowed. |
| JourneyPointHit | Called when a journey point was hit |
| LoadUserConfigurations | Loads the user configurations from the storage |
| LocalizeString | 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 |
| LocalizeStringNoFormat | looks up a localized string with the given Loca-Id |
| ObjectCreated | Called when an object was created and just before entering the initial naming on the new objects |
| ObjectPropertyChanged |
called when an object property is changed
|
| ObjectPropertyChanges | Called when an object property is changing or changed, use the argument type to distinguish between different timings and property modifications |
| ObjectPropertyChanging |
Called when an object property is changing, this is before the value is written into the object
|
| ObjectsCopying | called to inform the plugin that the given objects are put into the clipboard |
| ObjectsCutted | called after the delete has be done |
| ObjectsCutting | 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 |
| ObjectsDeleted | called after the delete has be done |
| ObjectsDeleting | 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 |
| ObjectsPasted | called after the paste is complete. This is the backward compatibility hook and is called from ObjectsPastedEx without the aFromCut parameter |
| ObjectsPastedEx | called after the paste is complete. This call can distinguish the cases where the paste comes from a previous cut or copy operation |
| ObjectsPasting | called when a pasting starts at the given target container |
| ObjectsRelocated | called after the relocate |
| ObjectsRelocating | called before the relocate |
| OnAssetObjectsCreated | Called when new assets are created, usually when a new asset file is imported. |
| OnAssetThumbnailUpdated | Called when the Asset has its thumbnail updated |
| OnPhysicalAssetFileImported | Called when the given asset has its physical file imported or updated. |
| OnRulesetExportFinished | Called when a ruleset export has finished |
| PartitionLoaded | Called when a multi-user partition was loaded as part of a claim or update command |
| PartitionPublished | Called after a multi-user partition was published or unclaimed |
| PartitionPublishing | Called before a multi-user partition is published or unclaimed |
| PartitionsPublished | 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 |
| PartitionUnloaded | Called when a multi-user partition was unloaded. Called when a partition is either claimed or updated |
| PartitionUnloading | Called when a multi-user partition is about to be unloaded. Called when a partition is either claimed or updated |
| ProjectLoaded | called directly after a project was loaded. |
| ProjectSaved | Called after the project was saved |
| ProjectSaving | Called before the project is being saved |
| ProjectUnloaded | Called when the project was unloaded. Can be used to free resources. Any access to objects will fail. |
| ProjectUnloading | Called when the project starts unloading (closing the project or articy:draft) |
| RefreshConfigurationsUIFor(Type) | Refreshes the UI for a given ConfigType |
| RefreshConfigurationsUIForTConfigurationType | Refreshes the UI for a given ConfigType |
| RegisterResource(String) | Register the resource dictionary given by the relative Uri-String to the main WPF application resources |
| RegisterResource(Uri, String) | Register the resource dictionary given by the Uri to the main WPF application resources |
| SaveConfigurations | Saves all user configurations |
| SelectionChanged | |
| SetLogTypes | Sets up the log types that should be written into the log. |
| ShowMessageBox | Shows a message box with the given parameters |
| ShowQueryBox | 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. |
| TemplateChanged | called after an object gets a new template. |
| TemplateChanging | called before an object gets a new template. |
| TemplatePropertyChanged |
Called when a template property has changed
|
| TemplatePropertyChanging |
Called when a template property is about to be changed (since articy:draft 3.1.29 / MDK 1.7.0)
|
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| ValidatePublishing | 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. |
Extension Methods
| TraceError | (Defined by TraceHelper) |
| TraceInfo | (Defined by TraceHelper) |
| TraceWarning | (Defined by TraceHelper) |