Skip to main content

PluginImageAttribute

  • Namespace: PPDS.Plugins
  • Assembly: PPDS.Plugins
  • Kind: Class
  • Base: Attribute

Summary​

Defines a pre-image or post-image for a plugin step. Images provide access to entity data before or after the operation.

Members​

Constructors​

PluginImageAttribute()​

PluginImageAttribute()

Initializes a new instance of the PluginImageAttribute class.

PluginImageAttribute(PluginImageType imageType, string name)​

PluginImageAttribute(PluginImageType imageType, string name)

Initializes a new instance of the PluginImageAttribute class with required parameters.

  • Param imageType: The type of image

  • Param name: The name to access the image in code

PluginImageAttribute(PluginImageType imageType, string name, string attributes)​

PluginImageAttribute(PluginImageType imageType, string name, string attributes)

Initializes a new instance of the PluginImageAttribute class with all common parameters.

  • Param imageType: The type of image

  • Param name: The name to access the image in code

  • Param attributes: Comma-separated attributes to include

Properties​

Attributes​

string Attributes { get; set; }

Gets or sets the comma-separated list of attributes to include in the image. If empty, all attributes are included (not recommended for performance).

Description​

string Description { get; set; }

Gets or sets a description of this image's purpose. Stored as metadata in Dataverse.

EntityAlias​

string EntityAlias { get; set; }

Gets or sets the entity alias for the image. Defaults to the Name if not specified.

ImageType​

PluginImageType ImageType { get; set; }

Gets or sets the type of image (PreImage, PostImage, or Both). Required.

MessagePropertyName​

string MessagePropertyName { get; set; }

Gets or sets the message property name that carries the entity. If null, auto-inferred from the message name (e.g., "Target" for Create/Update). Override for non-standard messages.

Name​

string Name { get; set; }

Gets or sets the name used to access the image in the plugin context. This is the key used in PreEntityImages or PostEntityImages collections. Required.

StepId​

string StepId { get; set; }

Gets or sets the StepId to associate this image with a specific step. Only needed when the plugin has multiple steps registered. Must match the StepId property of a PluginStepAttribute on the same class.