ReportModifyBehavior Class

Adds a chat with an AI Assistant to make adjustments to a report layout.

Namespace: DevExpress.AIIntegration.WinForms.Reporting

Assembly: DevExpress.AIIntegration.WinForms.Reporting.v26.1.dll

NuGet Package: DevExpress.AIIntegration.WinForms.Reporting

Declaration

C#

public class ReportModifyBehavior :
    ReportDesignerBehaviorBase

VB.NET

Public Class ReportModifyBehavior
    Inherits ReportDesignerBehaviorBase

Related API Members

The following members return ReportModifyBehavior objects:

• ReportModifyBehavior.Create(Type)

Remarks

Important

This functionality is available for .NET 8+.

Use the following code to register a ReportModifyBehavior and attach it to the reportDesigner1 UI component created at design time from the Toolbox:

C#

using DevExpress.AIIntegration.WinForms.Reporting;

public partial class Form1 : Form {
    public Form1() {
        InitializeComponent();
        behaviorManager1.Attach<ReportModifyBehavior>(reportDesigner1, behavior => {
           behavior.Properties.FixLayoutErrors = true;
           behavior.Properties.Temperature = 0.5f;
           behavior.Properties.RetryAttemptCount = 2;
        });
    }
}

VB.NET

Imports DevExpress.AIIntegration.WinForms.Reporting

Public Partial Class Form1
    Inherits Form

    Public Sub New()
        InitializeComponent()
        behaviorManager1.Attach(Of ReportModifyBehavior)(reportDesigner1, Sub(behavior)
            behavior.Properties.FixLayoutErrors = True
            behavior.Properties.Temperature = 0.5F
            behavior.Properties.RetryAttemptCount = 2
        End Sub)
    End Sub
End Class

The following code registers a ReportModifyBehavior and attaches it to the WinForms Report Designer control (XRDesignMdiController):

C#

using DevExpress.XtraReports.UI;
using DevExpress.AIIntegration.WinForms.Reporting;

public partial class Form1 : Form {
    public Form1() {
        InitializeComponent();
        // Create a new blank report instance or use your report.
        XtraReport report = new XtraReport();

        // Create a ReportDesignTool to configure and display the report in the Report Designer.
        ReportDesignTool designTool = new ReportDesignTool(report);

        // Attach AI-powered behavior to the Report Designer's MDI controller.
        behaviorManager1.Attach<ReportModifyBehavior>(designTool.DesignRibbonForm.DesignMdiController, behavior => {
            // Enable automatic layout error correction in the report.
            behavior.Properties.FixLayoutErrors = true;

            // Set the creativity level of AI suggestions (range: 0 = deterministic, 1 = creative).
            behavior.Properties.Temperature = 0.5f;

            // Define the number of retry attempts for AI operations in case of failure.
            behavior.Properties.RetryAttemptCount = 2;
        });

        // Display the Report Designer with a ribbon UI.
        designTool.ShowRibbonDesigner();
    }
}

VB.NET

Imports DevExpress.XtraReports.UI
Imports DevExpress.AIIntegration.WinForms.Reporting

Public Partial Class Form1
    Inherits Form

    Public Sub New()
        InitializeComponent()
        ' Create a new blank report instance or use your report.
        Dim report As New XtraReport()

        ' Create a ReportDesignTool to configure and display the report in the Report Designer.
        Dim designTool As New ReportDesignTool(report)

        ' Attach AI-powered behavior to the Report Designer's MDI controller.
        behaviorManager1.Attach(Of ReportModifyBehavior)(designTool.DesignRibbonForm.DesignMdiController, Sub(behavior)
            ' Enable automatic layout error correction in the report.
            behavior.Properties.FixLayoutErrors = True

            ' Set the creativity level of AI suggestions (range: 0 = deterministic, 1 = creative).
            behavior.Properties.Temperature = 0.5F

            ' Define the number of retry attempts for AI operations in case of failure.
            behavior.Properties.RetryAttemptCount = 2
        End Sub)

        ' Display the Report Designer with a ribbon UI.
        designTool.ShowRibbonDesigner()
    End Sub
End Class

Use ReportPromptToReportBehavior.Properties to access the behavior’s settings. The following settings are available:

ReportModifyBehaviorProperties.FixLayoutErrors

Specifies whether the designer attempts to fix the report layout when report controls overlap.

ReportModifyBehaviorProperties.RetryAttemptCount

Specifies the maximum number of attempts to fix report layout errors in the LLM response. The default value is 3.

ReportModifyBehaviorProperties.Temperature

Specifies the balance between creativity and consistency in AI responses.

Once the behavior is registered, the Report Designer interface displays the AI Assistant panel.

The chat in the AI assistant window allows you to add and modify report elements using natural language.

See the following help topic for additional information: Modify Report Behavior in the WinForms Report Designer (CTP).

Inheritance

Object

DevExpress.Utils.MVVM.BehaviorBase

DevExpress.Utils.Behaviors.Behavior

DevExpress.Utils.Behaviors.Behavior<DevExpress.AIIntegration.WinForms.Reporting.Internal.IReportDesignerBehaviorSource>

DevExpress.AIIntegration.WinForms.Reporting.Internal.ReportDesignerBehaviorBase

ReportModifyBehavior