Add SpeechToTextButton to docs #837
Conversation
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for the WinForms RadSpeechToTextButton control and wires it into the docs navigation.
Changes:
- Registers
controls/speechtotextbuttonindocs-builder.ymlnavigation metadata. - Adds new SpeechToTextButton docs pages: Overview, Getting Started, States, Events, and Custom Recognizer.
- Introduces section metadata via
controls/speechtotextbutton/_meta.yml.
Reviewed changes
Copilot reviewed 7 out of 11 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| docs-builder.yml | Adds nav entry for the new SpeechToTextButton docs section. |
| controls/speechtotextbutton/_meta.yml | Defines section title/tag metadata. |
| controls/speechtotextbutton/overview.md | Introduces the control and links to key topics. |
| controls/speechtotextbutton/getting-started.md | Provides setup steps, examples, and feature guidance. |
| controls/speechtotextbutton/states.md | Documents recognizer states and shows how to read/track them. |
| controls/speechtotextbutton/events.md | Lists events and includes an error-handling example. |
| controls/speechtotextbutton/custom-recognizer.md | Explains integrating a custom recognizer with sample code. |
Comments suppressed due to low confidence (1)
controls/speechtotextbutton/getting-started.md:1
- The in-page anchor
#language supportcontains a space and likely won’t match the generated heading id for## Language Support(typically#language-support). Update the fragment to the correct anchor so the link works.
---
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | State | Description | | ||
| | ------------ | ----------- | | ||
| | `NotInitialized` | The recognizer has not been initialized yet and is in its default state.| | ||
| | `Initializing` | The recognizer is currently initializing its components and preparing for use. | | ||
| | `Ready`| The recognizer is fully initialized and ready to begin listening for speech input. | | ||
| | `StartingListening` | The recognizer is transitioning into listening mode and preparing to capture audio input. | | ||
| | `Listening` | The recognizer is actively listening and processing speech input from the microphone.| | ||
| | `StoppingListening` | The recognizer is transitioning out of listening mode and stopping the audio capture process. | | ||
| | `Faulted` | The recognizer has encountered an error and is in a faulted state. Common causes include no internet connection, speech recognizer failures, or denied microphone permissions. The control can be reset to recover from this state. | | ||
| | `Resetting` | The recognizer is resetting to the `NotInitialized` state.| | ||
| | `Disposing` | The recognizer is in the process of releasing its resources and shutting down. | | ||
| | `Disposed` | The recognizer has been fully disposed. | |
There was a problem hiding this comment.
The markdown table is malformed (each row starts with || instead of |), which will typically render as plain text instead of a table. Update the table to standard markdown table syntax using single | delimiters and a correct header separator row.
|
|
||
| # Getting Started with SpeechToTextButton | ||
|
|
||
| This article demonstrates how to add the **RadSpeechToTextButton** control to your desktop application and configure it for speech recognition functionality. At the end of this tutorial, you will have a fully functional speech-to-text button that captures voice input and handle the recognized text. |
There was a problem hiding this comment.
Grammar: captures voice input and handle the recognized text should use a verb form consistent with captures (e.g., handles).
| This article demonstrates how to add the **RadSpeechToTextButton** control to your desktop application and configure it for speech recognition functionality. At the end of this tutorial, you will have a fully functional speech-to-text button that captures voice input and handle the recognized text. | |
| This article demonstrates how to add the **RadSpeechToTextButton** control to your desktop application and configure it for speech recognition functionality. At the end of this tutorial, you will have a fully functional speech-to-text button that captures voice input and handles the recognized text. |
|
|
||
| The `SpeechRecognizerSpeechRecognizedEventArgs` class provides the following detailed information about the recognized speech: | ||
|
|
||
| - **FullText**: Gets complete accumulated recofnized text from the current listening session. |
There was a problem hiding this comment.
Correct typo: recofnized should be recognized.
| - **FullText**: Gets complete accumulated recofnized text from the current listening session. | |
| - **FullText**: Gets complete accumulated recognized text from the current listening session. |
| * The `sender` argument which is of type `object` but can be cast to `RadSpeechToTextButton`. | ||
| * An `System.EventArgs` | ||
|
|
||
| ## Examle: Handling Speech Recognition Errors |
There was a problem hiding this comment.
Correct typo: Examle should be Example.
| ## Examle: Handling Speech Recognition Errors | |
| ## Example: Handling Speech Recognition Errors |
|
|
||
| * `StateChanged`—Raised when the state of the speech recognizer changes. The `StateChanged` event handler receives two parameters: | ||
| * The `sender` argument which is of type `object` but can be cast to `RadSpeechToTextButton`. | ||
| * An `System.EventArgs` |
There was a problem hiding this comment.
Grammar/incompleteness: An System.EventArgs should be A System.EventArgs and this bullet should mirror the others by clarifying it’s the event args parameter (e.g., A System.EventArgs argument).
| * An `System.EventArgs` | |
| * A `System.EventArgs` argument. |
| { | ||
| this.State = SpeechRecognizerState.Listening; | ||
| int i = 0; | ||
| string[] words = MockText.Split(' ', (char)StringSplitOptions.RemoveEmptyEntries); |
There was a problem hiding this comment.
This string.Split call is not valid C#: it casts StringSplitOptions to char and doesn’t match a real overload. Use the StringSplitOptions.RemoveEmptyEntries overload (e.g., MockText.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries) or an equivalent supported overload) so the sample compiles.
| string[] words = MockText.Split(' ', (char)StringSplitOptions.RemoveEmptyEntries); | |
| string[] words = MockText.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries); |
| RemoveHandler StateChanged, Nothing | ||
| RemoveHandler ErrorOccurred, Nothing | ||
| RemoveHandler SpeechRecognized, Nothing |
There was a problem hiding this comment.
These RemoveHandler ... , Nothing lines are not valid VB.NET and won’t compile because RemoveHandler requires a specific delegate instance to remove. For a docs sample, either remove these lines or demonstrate a correct pattern (store handler delegates and remove them explicitly); otherwise the snippet is broken.
| RemoveHandler StateChanged, Nothing | |
| RemoveHandler ErrorOccurred, Nothing | |
| RemoveHandler SpeechRecognized, Nothing |
| @@ -0,0 +1,64 @@ | |||
| --- | |||
| title: Overview | |||
| meta_title: WinForms SpeechToTextButton Documentation - Overview | |||
There was a problem hiding this comment.
Front-matter key is inconsistent with the other new pages (which use page_title). If the site generator primarily indexes page_title, this may cause inconsistent titles/SEO metadata for this page. Consider standardizing on the same key used by the other SpeechToTextButton articles unless meta_title is explicitly required here.
| meta_title: WinForms SpeechToTextButton Documentation - Overview | |
| page_title: WinForms SpeechToTextButton Documentation - Overview |
1 participant
No description provided.