New to Telerik UI for .NET MAUI? Start a free 30-day trial

DataGridAIPromptInput

Class

Represents an AI input view for DataGrid with customizable styles and commands for prompt requests and cancellations.

Definition

Namespace:Telerik.Maui.Controls.DataGrid

Assembly:Telerik.Maui.Controls.dll

Syntax:

public class DataGridAIPromptInput : RadContentView, IRadContentView, IContentView, IView, IElement, ITransform, IPadding, ICrossPlatformLayout

Inheritance: objectRadContentViewDataGridAIPromptInput

Implements: IContentViewICrossPlatformLayoutIElementIPaddingIRadContentViewITransformIView...

Inherited Members RadContentView.ActualStyleClassPropertyRadContentView.OnChildAdded(Element)RadContentView.OnChildRemoved(Element, int)RadContentView.OnBindingContextChanged()RadContentView.OnHandlerChanged()

Constructors

DataGridAIPromptInput()

Initializes a new instance of the DataGridAIPromptInput class.

public DataGridAIPromptInput()

Fields

ActualClearButtonStyleProperty

BindableProperty

Identifies the ActualClearButtonStyle property.

public static readonly BindableProperty ActualClearButtonStyleProperty

ActualIconStyleProperty

BindableProperty

Identifies the ActualIconStyle property.

public static readonly BindableProperty ActualIconStyleProperty

ActualSendButtonStyleProperty

BindableProperty

Identifies the ActualSendButtonStyle property.

public static readonly BindableProperty ActualSendButtonStyleProperty

ActualSpeechToTextButtonStyleProperty

BindableProperty

Identifies the ActualSpeechToTextButtonStyle property.

public static readonly BindableProperty ActualSpeechToTextButtonStyleProperty

ActualTextInputStyleProperty

BindableProperty

Identifies the ActualTextInputStyle property.

public static readonly BindableProperty ActualTextInputStyleProperty

BackgroundColorProperty

BindableProperty

Identifies the BackgroundColor property.

public static readonly BindableProperty BackgroundColorProperty

BackgroundProperty

BindableProperty

Identifies the Background property.

public static readonly BindableProperty BackgroundProperty

BorderBrushProperty

BindableProperty

Identifies the BorderBrush property.

public static readonly BindableProperty BorderBrushProperty

BorderThicknessProperty

BindableProperty

Identifies the BorderThickness property.

public static readonly BindableProperty BorderThicknessProperty

CancelPromptRequestCommandProperty

BindableProperty

Identifies the CancelPromptRequestCommand property.

public static readonly BindableProperty CancelPromptRequestCommandProperty

ClearButtonStyleProperty

BindableProperty

Identifies the ClearButtonStyle property.

public static readonly BindableProperty ClearButtonStyleProperty

ClearButtonVisibilityProperty

BindableProperty

Identifies the ClearButtonVisibility property.

public static readonly BindableProperty ClearButtonVisibilityProperty

ControlTemplateProperty

BindableProperty

Identifies the ControlTemplate property.

public static readonly BindableProperty ControlTemplateProperty

CornerRadiusProperty

BindableProperty

Identifies the CornerRadius property.

public static readonly BindableProperty CornerRadiusProperty

IconStyleProperty

BindableProperty

Identifies the IconStyle property.

public static readonly BindableProperty IconStyleProperty

InputTextProperty

BindableProperty

Identifies the InputText property.

public static readonly BindableProperty InputTextProperty

IsSpeechToTextButtonVisibleProperty

BindableProperty

Identifies the IsSpeechToTextButtonVisible property.

public static readonly BindableProperty IsSpeechToTextButtonVisibleProperty

PaddingProperty

BindableProperty

Identifies the Padding property.

public static readonly BindableProperty PaddingProperty

PromptRequestCommandProperty

BindableProperty

Identifies the PromptRequestCommand property.

public static readonly BindableProperty PromptRequestCommandProperty

SendButtonStyleProperty

BindableProperty

Identifies the SendButtonStyle property.

public static readonly BindableProperty SendButtonStyleProperty

SpeechToTextButtonStyleProperty

BindableProperty

Identifies the SpeechToTextButtonStyle property.

public static readonly BindableProperty SpeechToTextButtonStyleProperty

StyleProperty

BindableProperty

Identifies the Style property.

public static readonly BindableProperty StyleProperty

TextInputStyleProperty

BindableProperty

Identifies the TextInputStyle property.

public static readonly BindableProperty TextInputStyleProperty

Properties

ActualClearButtonStyle

Style

Gets the actual style that is applied to the clear button. This property contains the merged result of the ClearButtonStyle and the default style.

public Style ActualClearButtonStyle { get; }

Property Value:

A Style that represents the merged clear button style.

ActualIconStyle

Style

Gets the actual style that is applied to the icon. This property contains the merged result of the IconStyle and the default style.

public Style ActualIconStyle { get; }

Property Value:

A Style that represents the merged icon style.

ActualSendButtonStyle

Style

Gets the actual style that is applied to the send button. This property contains the merged result of the SendButtonStyle and the default style.

public Style ActualSendButtonStyle { get; }

Property Value:

A Style that represents the merged send button style.

ActualSpeechToTextButtonStyle

Style

Gets the actual style that is applied to the speech-to-text button. This property contains the merged result of the SpeechToTextButtonStyle and the default style.

public Style ActualSpeechToTextButtonStyle { get; }

Property Value:

A Style that represents the merged speech-to-text button style.

ActualTextInputStyle

Style

Gets the actual style that is applied to the inner text input control. This property contains the merged result of the TextInputStyle and the default style.

public Style ActualTextInputStyle { get; }

Property Value:

A Style that represents the merged text input style.

Background

Brush

Gets or sets the background brush of the control.

[TypeConverter(typeof(BrushTypeConverter))]
public Brush Background { get; set; }

BackgroundColor

Color

Gets or sets the background color of the control.

public Color BackgroundColor { get; set; }

BorderBrush

Brush

Gets or sets the border brush of the control.

[TypeConverter(typeof(BrushTypeConverter))]
public Brush BorderBrush { get; set; }

BorderThickness

Thickness

Gets or sets the border thickness of the control.

public Thickness BorderThickness { get; set; }

CancelPromptRequestCommand

ICommand

Gets or sets the command that is executed when the user requests to cancel the current processing operation.

public ICommand CancelPromptRequestCommand { get; set; }

ClearButtonStyle

Style

Gets or sets the style of the RadTemplatedButton that represents the clear button.

public Style ClearButtonStyle { get; set; }

Property Value:

A Style that defines the visual appearance of the clear button. When set, this style is merged with the default style.

ClearButtonVisibility

Gets or sets the visibility of the clear button.

public ClearButtonVisibility ClearButtonVisibility { get; set; }

ControlTemplate

Gets or sets the control template that defines the visual structure of the DataGridAIPromptInput.

public ControlTemplate ControlTemplate { get; set; }

Property Value:

A ControlTemplate that defines the visual tree for the input view.

CornerRadius

Gets or sets the corner radius of the control.

[TypeConverter(typeof(CornerRadiusTypeConverter))]
public CornerRadius CornerRadius { get; set; }

IconStyle

Style

Gets or sets the style of the that represents the icon.

public Style IconStyle { get; set; }

Property Value:

A Style that defines the visual appearance of the icon. When set, this style is merged with the default style.

InputText

string

Gets or sets the text entered in the input field.

public string InputText { get; set; }

Property Value:

A string containing the input text.

IsSpeechToTextButtonVisible

bool?

Gets or sets the visibility of the speech-to-text button.

public bool? IsSpeechToTextButtonVisible { get; set; }

Property Value:

null (default): Auto - visible when input is empty or when listening. true: Always visible. false: Never visible.

Padding

Thickness

Gets or sets the padding of the control.

public Thickness Padding { get; set; }

PromptRequestCommand

ICommand

Gets or sets the command that is executed when a prompt is requested from the user.

public ICommand PromptRequestCommand { get; set; }

SendButtonStyle

Style

Gets or sets the style of the DataGridAISendButton.

public Style SendButtonStyle { get; set; }

Property Value:

A Style that defines the visual appearance of the send button. When set, this style is merged with the default style.

SpeechToTextButtonStyle

Style

Gets or sets the style of the RadSpeechToTextButton.

public Style SpeechToTextButtonStyle { get; set; }

Property Value:

A Style that defines the visual appearance of the speech-to-text button. When set, this style is merged with the default style.

Gets or sets the style applied to the DataGridAIPromptInput. This style can define visual properties such as background, border, and layout characteristics. The final applied style is a merge of the explicit style, implicit theme style, and default style.

public Style Style { get; set; }

Property Value:

A Style that defines the visual appearance of the input view.

TextInputStyle

Style

Gets or sets the style of the RadTextInput used for text input.

public Style TextInputStyle { get; set; }

Property Value:

A Style that defines the visual appearance of the text input. When set, this style is merged with the default style.

Methods

Focus()

bool

Attempts to set focus to this element.

public bool Focus()

Returns:

bool

OnApplyTemplate()

Called when the control template is applied.

protected override void OnApplyTemplate()

StopSpeechToTextRecognitionAsync()

Task

Stops the speech to text recognition.

If the speech recognizer is currently in the StartingListening or Listening state, this method will stop the recognition process. If the recognizer is not listening, this method has no effect.

public Task StopSpeechToTextRecognitionAsync()

Returns:

Task

Unfocus()

Unsets keyboard focus on this element.

public void Unfocus()

Events

CancelPromptRequest

EventHandler

Occurs when the user requests to cancel the current processing operation by clicking the stop button.

public event EventHandler CancelPromptRequest

PromptRequest

EventHandler<DataGridPromptRequestEventArgs>

Occurs when a prompt is requested from the user on send or completed action.

public event EventHandler<DataGridPromptRequestEventArgs> PromptRequest