AIReportPromptCollection.GetDefaultReportPrompts() Method

Obtains built-in DevExpress prompt suggestions contained in AIReportPromptCollection.

Namespace: DevExpress.AIIntegration.Reporting

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

Declaration

C#

public static AIReportPromptCollection GetDefaultReportPrompts()

VB.NET

Public Shared Function GetDefaultReportPrompts As AIReportPromptCollection

Returns

Type	Description
AIReportPromptCollection	The prompt collection.

Remarks

Built-in DevExpress prompt suggestions are included with Prompt-to-Report. You can also create your own predefined prompts. Predefined prompts are stored in AIReportPromptCollection and automatically appear in the Report Wizard after you register WinForms.Reporting.ReportPromptToReportBehavior or Wpf.Reporting.ReportPromptToReportBehavior.

Modify Existing Prompts

To change built-in DevExpress prompts, call the AIReportPromptCollection.GetDefaultReportPrompts() method and access the desired prompt. Modify prompt Text and Title.

WinForms

C#

using DevExpress.AIIntegration.WinForms.Reporting;
// ...
public partial class Form1 : Form {
    public Form1() {
        InitializeComponent();
        behaviorManager1.Attach<ReportPromptToReportBehavior>(reportDesigner1, behavior => {
          var collection = AIReportPromptCollection.GetDefaultReportPrompts();
          collection[0].Title = "My Changed Prompt";
          behavior.Properties.PredefinedPrompts = collection;
        });
    }
}

VB.NET

Imports DevExpress.AIIntegration.WinForms.Reporting
' ...
Partial Public Class Form1
  Inherits Form

  Public Sub New()
    InitializeComponent()
    behaviorManager1.Attach(Of ReportPromptToReportBehavior)(reportDesigner1, Sub(behavior)
      Dim collection = AIReportPromptCollection.GetDefaultReportPrompts()
      collection(0).Title = "My Changed Prompt"
      behavior.Properties.PredefinedPrompts = collection
    End Sub)
  End Sub
End Class

WPF

Code-Behind:

C#

using DevExpress.AIIntegration.Wpf.Reporting;
using DevExpress.Mvvm.UI.Interactivity;

public partial class MainWindow : Window {
    public MainWindow() {
        InitializeComponent();
        ReportPromptToReportBehavior reportBehavior = new ReportPromptToReportBehavior();
        var collection = AIReportPromptCollection.GetDefaultReportPrompts();
        collection[0].Title = "My Changed Prompt";
        reportBehavior.PredefinedPrompts = collection;
        Interaction.GetBehaviors(designer).Add(reportBehavior);
    }
}

VB.NET

Imports DevExpress.AIIntegration.Wpf.Reporting
Imports DevExpress.Mvvm.UI.Interactivity

Partial Public Class MainWindow
  Inherits Window

  Public Sub New()
    InitializeComponent()
    Dim reportBehavior As New ReportPromptToReportBehavior()
    Dim collection = AIReportPromptCollection.GetDefaultReportPrompts()
    collection(0).Title = "My Changed Prompt"
    reportBehavior.PredefinedPrompts = collection
    Interaction.GetBehaviors(designer).Add(reportBehavior)
  End Sub
End Class

Add a New Prompt

The following code snippet obtains built-in DevExpress prompts from AIReportPromptCollection, creates a custom prompt (an AIReportPrompt object), and adds this prompt to the collection. The collection is assigned to the ReportPromptToReportBehaviorProperties.PredefinedPrompts or ReportPromptToReportBehavior.PredefinedPrompts property.

WinForms

C#

using DevExpress.AIIntegration.WinForms.Reporting;
// ...
public partial class Form1 : Form {
    public Form1() {
        behaviorManager1.Attach<ReportPromptToReportBehavior>(reportDesigner1, behavior => {
            // Obtain built-in DevExpress prompts from the collection.
            var collection = AIReportPromptCollection.GetDefaultReportPrompts();
            // Create a custom prompt.
            AIReportPrompt customPrompt = new AIReportPrompt();
            customPrompt.Title = "Custom Prompt";
            customPrompt.Text = "Custom Prompt Text";
            // Add this prompt to the collection.
            collection.Add(customPrompt);
            // Display Prompts in the Report Wizard.
            behavior.Properties.PredefinedPrompts = collection;
        });
    }
}

VB.NET

Imports DevExpress.AIIntegration.WinForms.Reporting
' ...
Partial Public Class Form1
    Inherits Form

    Public Sub New()
        behaviorManager1.Attach(Of ReportPromptToReportBehavior)(reportDesigner1, Sub(behavior)
            ' Obtain built-in DevExpress prompts from the collection.
            Dim collection = AIReportPromptCollection.GetDefaultReportPrompts()
            ' Create a custom prompt.
            Dim customPrompt As New AIReportPrompt()
            customPrompt.Title = "Custom Prompt"
            customPrompt.Text = "Custom Prompt Text"
            ' Add this prompt to the collection.
            collection.Add(customPrompt)
            ' Display Prompts in the Report Wizard.
            behavior.Properties.PredefinedPrompts = collection
        End Sub)
    End Sub
End Class

The following image illustrates the result:

WPF

Markup:

XAML

xmlns:dxrud="http://schemas.devexpress.com/winfx/2008/xaml/reports/userdesigner" 
xmlns:dxai="http://schemas.devexpress.com/winfx/2008/xaml/ai" 
xmlns:dxmvvm="http://schemas.devexpress.com/winfx/2008/xaml/mvvm"
xmlns:reporting="clr-namespace:DevExpress.AIIntegration.Reporting;assembly=DevExpress.AIIntegration.Reporting.Common.v26.1"  
... 
<dxrud:ReportDesigner x:Name="designer">
    <dxmvvm:Interaction.Behaviors>
        <dxai:ReportPromptToReportBehavior FixLayoutErrors="true">
        <dxai:ReportPromptToReportBehavior.PredefinedPrompts>
            <reporting:AIReportPrompt Title="Custom Prompt" Text="Custom Prompt Text" />
        </dxai:ReportPromptToReportBehavior.PredefinedPrompts>
        </dxai:ReportPromptToReportBehavior>
    </dxmvvm:Interaction.Behaviors>
</dxrud:ReportDesigner>

Code-Behind:

C#

using DevExpress.AIIntegration.Wpf.Reporting;
using DevExpress.Mvvm.UI.Interactivity;
using DevExpress.AIIntegration.Reporting;

public partial class MainWindow : Window {
    public MainWindow() {
        InitializeComponent();
        ReportPromptToReportBehavior reportBehavior = new ReportPromptToReportBehavior();
        reportBehavior.FixLayoutErrors = true;
        // Obtain built-in DevExpress prompts from the collection.
        var collection = AIReportPromptCollection.GetDefaultReportPrompts();
        // Create a custom prompt.
        AIReportPrompt customPrompt = new AIReportPrompt();
        customPrompt.Title = "Custom Prompt";
        customPrompt.Text = "Custom Prompt Text";
        // Add this prompt to the collection.
        collection.Add(customPrompt);
        // Display Prompts in the Report Wizard.
        reportBehavior.PredefinedPrompts = collection;
        Interaction.GetBehaviors(designer).Add(reportBehavior);
    }
}

VB.NET

Imports DevExpress.AIIntegration.Wpf.Reporting
Imports DevExpress.Mvvm.UI.Interactivity
Imports DevExpress.AIIntegration.Reporting

Partial Public Class MainWindow
  Inherits Window

  Public Sub New()
    InitializeComponent()
    Dim reportBehavior As New ReportPromptToReportBehavior()
    reportBehavior.FixLayoutErrors = True
    ' Obtain built-in DevExpress prompts from the collection.
    Dim collection = AIReportPromptCollection.GetDefaultReportPrompts()
    ' Create a custom prompt.
    Dim customPrompt As New AIReportPrompt()
    customPrompt.Title = "Custom Prompt"
    customPrompt.Text = "Custom Prompt Text"
    ' Add this prompt to the collection.
    collection.Add(customPrompt)
    ' Display Prompts in the Report Wizard.
    reportBehavior.PredefinedPrompts = collection
    Interaction.GetBehaviors(designer).Add(reportBehavior)
  End Sub
End Class

After you add a custom prompt to the collection, it appears in the Report Wizard:

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetDefaultReportPrompts() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-reporting-add-ai-options-to-report-wizard/CS/Customization/WizardCustomizationService.cs#L31

    tool.Model.SetAIParameters(new AIParameters());
    tool.Model.SetPredefinedAIReportPrompts(AIReportPromptCollection.GetDefaultReportPrompts());
}

VB.NET

winforms-reporting-add-ai-options-to-report-wizard/VB/Customization/WizardCustomizationService.vb#L33

    tool.Model.SetAIParameters(New AIParameters())
    tool.Model.SetPredefinedAIReportPrompts(AIReportPromptCollection.GetDefaultReportPrompts())
End Sub