Class RadAIPrompt

A component that bridges the gap between the Maui app and the next-generation AI language model applications. Use the AIPrompt to provide your users with with chat capabilities or pre-determined ways to interact with a trained language model of your choice.

Inheritance
System.Object
RadContentView
RadCompositeContentView
RadBorderContentView
RadAIPrompt
Inherited Members
Namespace: Telerik.Maui.Controls
Assembly: Telerik.Maui.Controls.dll

Syntax

public class RadAIPrompt : RadBorderContentView, IRadContentView, IContentView, IView, IElement, ITransform, IPadding, ICrossPlatformLayout

Constructors

RadAIPrompt()

Initializes a new instance of the class.

Declaration
public RadAIPrompt()

Fields

ActualCommandTappedCommandProperty

Identifies the ActualCommandTappedCommand property.

Declaration
public static readonly BindableProperty ActualCommandTappedCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ActualTabViewStyleProperty

Identifies the ActualTabViewStyle property.

Declaration
public static readonly BindableProperty ActualTabViewStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

AutoGenerateViewsProperty

Identifies the AutoGenerateViews property.

Declaration
public static readonly BindableProperty AutoGenerateViewsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

CommandGroupStyleProperty

Identifies the CommandGroupStyle property.

Declaration
public static readonly BindableProperty CommandGroupStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

CommandsProperty

Identifies the Commands property.

Declaration
public static readonly BindableProperty CommandsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

CommandStyleProperty

Identifies the CommandStyle property.

Declaration
public static readonly BindableProperty CommandStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

CommandTappedCommandProperty

Identifies the CommandTappedCommand property.

Declaration
public static readonly BindableProperty CommandTappedCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ControlTemplateProperty

Identifies the ControlTemplate property.

Declaration
public static readonly BindableProperty ControlTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

InputButtonStyleProperty

Identifies the InputButtonStyle property.

Declaration
public static readonly BindableProperty InputButtonStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

InputButtonTextProperty

Identifies the InputButtonText property.

Declaration
public static readonly BindableProperty InputButtonTextProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

InputEditorStyleProperty

Identifies the InputEditorStyle property.

Declaration
public static readonly BindableProperty InputEditorStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

InputTextProperty

Identifies the InputText property.

Declaration
public static readonly BindableProperty InputTextProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

OutputItemCopyCommandProperty

Identifies the OutputItemCopyCommand property.

Declaration
public static readonly BindableProperty OutputItemCopyCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

OutputItemRatingChangedCommandProperty

Identifies the OutputItemRatingChangedCommand property.

Declaration
public static readonly BindableProperty OutputItemRatingChangedCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

OutputItemRetryCommandProperty

Identifies the OutputItemRetryCommand property.

Declaration
public static readonly BindableProperty OutputItemRetryCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

OutputItemsProperty

Identifies the Suggestions property.

Declaration
public static readonly BindableProperty OutputItemsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

OutputItemStyleProperty

Identifies the OutputItemStyle property.

Declaration
public static readonly BindableProperty OutputItemStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

PromptRequestCommandProperty

Identifies the PromptRequestCommand property.

Declaration
public static readonly BindableProperty PromptRequestCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SelectedIndexProperty

Identifies the SelectedIndex property.

Declaration
public static readonly BindableProperty SelectedIndexProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SuggestionsExpanderStyleProperty

Identifies the SuggestionsExpanderStyle property.

Declaration
public static readonly BindableProperty SuggestionsExpanderStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SuggestionsHeaderTextProperty

Identifies the SuggestionsHeaderText property.

Declaration
public static readonly BindableProperty SuggestionsHeaderTextProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SuggestionsProperty

Identifies the Suggestions property.

Declaration
public static readonly BindableProperty SuggestionsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SuggestionStyleProperty

Identifies the SuggestionStyle property.

Declaration
public static readonly BindableProperty SuggestionStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

TabViewStyleProperty

Identifies the TabViewStyle property.

Declaration
public static readonly BindableProperty TabViewStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ViewsProperty

Identifies the Views property.

Declaration
public static readonly BindableProperty ViewsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

Properties

ActualCommandTappedCommand

Gets the actual command that is executed when an AIPrompt command is tapped. This command executes the CommandTappedCommand or the Command or raises the PromptRequest event.

Declaration
public ICommand ActualCommandTappedCommand { get; }
Property Value
System.Windows.Input.ICommand

ActualTabViewStyle

Gets or sets the actual style that will be applied to the tabview. This is a merger of the custom TabViewStyle and the default style.

Declaration
public Style ActualTabViewStyle { get; }
Property Value
Microsoft.Maui.Controls.Style

AutoGenerateViews

Gets or sets a value indicating whether to auto-generate views by default.

Declaration
public bool AutoGenerateViews { get; set; }
Property Value
System.Boolean

CommandGroupStyle

Gets or sets the style that is to be applied to the AIPromptCommandGroupView representing an AIPrompt command group.

Declaration
public Style CommandGroupStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

Commands

Gets or sets the AIPrompt commands.

Declaration
public IList<AIPromptCommandBase> Commands { get; set; }
Property Value
System.Collections.Generic.IList<AIPromptCommandBase>

CommandStyle

Gets or sets the style that is to be applied to the AIPrompt command.

Declaration
public Style CommandStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

CommandTappedCommand

Gets or sets the command that is executed when an AIPrompt command is pressed.

Declaration
public ICommand CommandTappedCommand { get; set; }
Property Value
System.Windows.Input.ICommand

ControlTemplate

Gets or sets the template that defines the visual appearance of the view.

Declaration
public ControlTemplate ControlTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.ControlTemplate

InputButtonStyle

Gets or sets the style that is to be applied to the input button.

Declaration
public Style InputButtonStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

InputButtonText

Gets or sets the text of the input button.

Declaration
public string InputButtonText { get; set; }
Property Value
System.String

InputEditorStyle

Gets or sets the style that is to be applied to the input editor.

Declaration
public Style InputEditorStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

InputText

Gets or sets the input text.

Declaration
public string InputText { get; set; }
Property Value
System.String

OutputItemCopyCommand

Gets or sets the command that is executed when the Copy button is pressed.

Declaration
public ICommand OutputItemCopyCommand { get; set; }
Property Value
System.Windows.Input.ICommand

OutputItemRatingChangedCommand

Gets or sets the command that is executed when the Rating of an output item changes.

Declaration
public ICommand OutputItemRatingChangedCommand { get; set; }
Property Value
System.Windows.Input.ICommand

OutputItemRetryCommand

Gets or sets the command that is executed when the Retry button is pressed.

Declaration
public ICommand OutputItemRetryCommand { get; set; }
Property Value
System.Windows.Input.ICommand

OutputItems

Gets or sets the output items (the responses from the ai).

Declaration
public IList<AIPromptOutputItem> OutputItems { get; set; }
Property Value
System.Collections.Generic.IList<AIPromptOutputItem>

OutputItemStyle

Gets or sets the style that is to be applied to the output items.

Declaration
public Style OutputItemStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

PromptRequestCommand

Gets or sets the command that is executed when the end-user makes a request by pressing the input button or a command.

Declaration
public ICommand PromptRequestCommand { get; set; }
Property Value
System.Windows.Input.ICommand

SelectedIndex

Gets or sets the index of the selected view.

Declaration
public int SelectedIndex { get; set; }
Property Value
System.Int32

Suggestions

Gets or sets the suggestions. The items of this collection can be simple string objects. In case more control over the UI is needed, the items in this collection can be objects from a custom class and the SuggestionStyle property can be used to set the ControlTemplate.

Declaration
public IEnumerable Suggestions { get; set; }
Property Value
System.Collections.IEnumerable

SuggestionsExpanderStyle

Gets or sets the style that is to be applied to the RadExpander that contains the suggestions.

Declaration
public Style SuggestionsExpanderStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

SuggestionsHeaderText

Gets or sets the text of the suggestions header.

Declaration
public string SuggestionsHeaderText { get; set; }
Property Value
System.String

SuggestionStyle

Gets or sets the style that is to be applied to the suggestions.

Declaration
public Style SuggestionStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

TabViewStyle

Gets or sets the style that is to be applied to the RadTabView that represents the AIPrompt views.

Declaration
public Style TabViewStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

Views

Gets or sets the AIPrompt views. The collection can contain the following types of views:

By default, these views are automatically generated when AutoGenerateViews is true. To manually define custom views, set AutoGenerateViews to false and populate this collection with your desired view instances.

Declaration
public IList<AIPromptView> Views { get; set; }
Property Value
System.Collections.Generic.IList<AIPromptView>

Methods

ArrangeOverride(Rect)

Declaration
protected override Size ArrangeOverride(Rect bounds)
Parameters
Microsoft.Maui.Graphics.Rect bounds

Returns
Microsoft.Maui.Graphics.Size

MeasureOverride(Double, Double)

Declaration
protected override Size MeasureOverride(double widthConstraint, double heightConstraint)
Parameters
System.Double widthConstraint

System.Double heightConstraint

Returns
Microsoft.Maui.Graphics.Size

Events

PromptRequest

Occurs when the end-user makes a request by pressing the input button or a command.

Declaration
public event EventHandler PromptRequest
Event Type
System.EventHandler

Extension Methods