Class

RadSpeechToTextButtonElement

Initializes a new instance of the RadSpeechToTextButtonElement class.

Declaration

public RadSpeechToTextButtonElement()

Identifies the State dependency property, representing the current state of the speech recognizer.

Declaration

public static RadProperty StateProperty

Field Value

Gets or sets a value indicating whether to use pulse animation when the state is Listening.

Declaration

public bool AllowAnimation { get; set; }

Property Value

Gets or sets a value indicating whether the speech recognizer operates in continuous recognition mode. When set to true, the recognizer will continuously listen and recognize speech until stopped. When set to false, recognizer will stop automatically after a single utterance or pause.

Declaration

public bool IsContinuousRecognition { get; set; }

Property Value

Gets or sets the IETF BCP 47 language tag for the speech recognizer. For example "en-US", "de-DE".

Declaration

public string LanguageTag { get; set; }

Property Value

Gets or sets the custom factory that creates a IRadSpeechRecognizer instance.

Declaration

[Browsable(false)]
public Func<IRadSpeechRecognizer> SpeechRecognizerCreator { get; set; }

Property Value

Gets the current state of the speech recognizer.

Declaration

public SpeechRecognizerState State { get; }

Property Value

Gets or sets the recognizer states in which the tooltip callout is enabled.

Declaration

public IList<SpeechRecognizerState> ToolTipStates { get; set; }

Property Value

Disposes of managed resources including cached images and SVG images when the element is being disposed.

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

Gets the content object used in the callout tooltip based on the current speech recognizer state.

Declaration

protected virtual string GetCalloutContent()

Returns

Initializes visual appearance fields such as border and fill settings, and applies theme value overrides for different visual states.

Declaration

protected override void InitializeFields()

Overrides LightVisualElement.InitializeFields()

Handles the click event by invoking the base handler and asynchronously performing additional actions.

Declaration

protected override void OnClick(EventArgs e)

Parameters

Overrides RadElement.OnClick(EventArgs)

Initializes the speech recognizer if it has not already been initialized when the continuous recognition setting changes.

Declaration

protected virtual void OnIsContinuousRecognitionChanged()

Handles changes to the language tag by initializing the speech recognizer if necessary.

Declaration

protected virtual void OnLanguageTagChanged()

Called when the element has been successfully loaded. That includes loading of all its children as well.

Declaration

protected override void OnLoaded()

Overrides LightVisualElement.OnLoaded()

Declaration

protected override void OnMouseEnter(EventArgs e)

Parameters

Overrides RadElement.OnMouseEnter(EventArgs)

Declaration

protected override void OnMouseLeave(EventArgs e)

Parameters

Overrides RadItem.OnMouseLeave(EventArgs)

Called when a property value has changed, handling item-specific property change logic including text, visual state, and animation properties.

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides LightVisualElement.OnPropertyChanged(RadPropertyChangedEventArgs)

Handles changes to the speech recognizer creator by disposing the current recognizer and creating a new one if the element is loaded.

Declaration

protected virtual void OnSpeechRecognizerCreatorChanged()

Raises the StateChanged event and manages the listening animation lifecycle.

Declaration

protected virtual void OnStateChanged()

Stops the speech to text button from listening.

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.

Declaration

public Task StopListening()

Returns

Occurs before the callout tooltip is opened, allowing customization or cancellation.

Declaration

public event EventHandler<SpeechToTextTooltipOpeningEventArgs> CalloutOpening

Event Value

Occurs when an error is encountered by the speech recognizer.

Declaration

public event EventHandler<SpeechRecognizerErrorOccurredEventArgs> ErrorOccurred

Event Value

Occurs when speech is successfully recognized.

Declaration

public event EventHandler<SpeechRecognizerSpeechRecognizedEventArgs> SpeechRecognized

Event Value

Occurs when the state of the speech recognizer changes.

Declaration

public event EventHandler StateChanged

Event Value