Skip to content

Attribute Reference

This section provides one manual reference page for every current public attribute exposed by XrmGhost.Attributes.

The current public contract in xrmghost-attributes is the source of truth for these pages.

These reference pages are manual documentation today. They summarize the public constructor and property surface with high confidence from source, and they should not be read as generated schema exports. A future generated reference can replace or supplement this section later without changing the underlying contract.

AttributePrimary use
HandlesMessageAttributeDeclare a handled Dataverse message name on a plugin class.
InputParameterAttributeSeed an input parameter with a JSON-shaped value.
OutputParameterAttributeDescribe an expected output parameter value.
PluginExecutionConfigAttributeRegister entity, message, stage, mode, and impersonation metadata.
PostImageAttributeProvide a post-operation entity image payload and optional column filter.
PreImageAttributeProvide a pre-operation entity image payload and optional column filter.
SecureConfigurationAttributeStore a default secure configuration string for consumers.
SharedVariableAttributeSeed a shared variable value as JSON-shaped metadata.
SolutionComponentAttributeGroup registration into one or more Dataverse solutions.
UnsecureConfigurationAttributeStore a default unsecure configuration string for consumers.
  • Use these pages for the current public names, constructor shape, and writable properties.
  • Use the narrative docs in Attributes Overview and Getting Started for package context.
  • Stay conservative when you document behavior beyond the public contract: many downstream effects come from tools that consume the attributes, not from the attributes themselves.