Spreadsheet: Document the Dialogs property of the ActiveSheetEditor#3140
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new RadSpreadsheet documentation article describing how to access and customize the worksheet editor dialog content via the editor’s dialogs collection.
Changes:
- Introduces a new “Worksheet Editor Dialogs” documentation page.
- Lists the available dialog properties exposed by
WorksheetEditorDialogs. - Provides examples for accessing and overriding a dialog content implementation.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --- | ||
| title: Worksheet Editor Dialogs | ||
| page_title: Worksheet Editor Dialogs | ||
| description: Check our "Worksheet Editor Dialogs" documentation article for the RadSpreadsheet WPF control. |
There was a problem hiding this comment.
Front-matter description hard-codes "WPF" instead of using the {{ site.framework_name }} token used in other RadSpreadsheet articles. This makes the page inconsistent across framework builds; align it with the standard description pattern.
| description: Check our "Worksheet Editor Dialogs" documentation article for the RadSpreadsheet WPF control. | |
| description: Check our "Worksheet Editor Dialogs" documentation article for the RadSpreadsheet {{ site.framework_name }} control. |
| * `CustomFilterDialog`—Gets or sets the custom filter dialog. To set a custom custom filter dialog, extend the `CustomFilterDialogContent` class. | ||
| * `CustomSortListsDialog`—Gets or sets the custom sort lists dialog. To set a custom custom sort lists dialog, extend the `CustomSortListsDialogContent` class. |
There was a problem hiding this comment.
Remove the duplicated word "custom" ("custom custom") in this sentence; it reads like a copy/paste typo.
| * `CustomFilterDialog`—Gets or sets the custom filter dialog. To set a custom custom filter dialog, extend the `CustomFilterDialogContent` class. | |
| * `CustomSortListsDialog`—Gets or sets the custom sort lists dialog. To set a custom custom sort lists dialog, extend the `CustomSortListsDialogContent` class. | |
| * `CustomFilterDialog`—Gets or sets the custom filter dialog. To set a custom filter dialog, extend the `CustomFilterDialogContent` class. | |
| * `CustomSortListsDialog`—Gets or sets the custom sort lists dialog. To set a custom sort lists dialog, extend the `CustomSortListsDialogContent` class. |
| * `CustomSortListsDialog`—Gets or sets the custom sort lists dialog. To set a custom custom sort lists dialog, extend the `CustomSortListsDialogContent` class. | ||
| * `DataValidationDialog`—Gets or sets the data validation dialog. To set a custom data validation dialog, extend the `DataValidationDialogContent` class. | ||
| * `AlertDialog`—Gets or sets the alert dialog. To set a custom alert dialog, extend the `AlertDialogContent` class. | ||
| * `ConfirmDialog`—Gets or sets the confirm dialog. To set a custom confirm dialog, extend the `ConfirmDialogContent` class. |
There was a problem hiding this comment.
Trailing spaces at the end of this list item will render as a hard line break in Markdown. Remove the extra whitespace to avoid unintended formatting changes.
| * `ConfirmDialog`—Gets or sets the confirm dialog. To set a custom confirm dialog, extend the `ConfirmDialogContent` class. | |
| * `ConfirmDialog`—Gets or sets the confirm dialog. To set a custom confirm dialog, extend the `ConfirmDialogContent` class. |
|
|
||
| ## Customizing the Dialogs | ||
|
|
||
| You can customize the dialogs by creating a new class that inherits from the dialog that you want to customize and override the necessary methods to implement your custom logic. |
There was a problem hiding this comment.
The section says to "inherit from the dialog" to customize it, but the preceding list instructs extending *DialogContent classes and the example inherits from FindAndReplaceDialogContent. Reword this to explicitly say to inherit from the corresponding *DialogContent type to avoid confusion.
| You can customize the dialogs by creating a new class that inherits from the dialog that you want to customize and override the necessary methods to implement your custom logic. | |
| You can customize the dialogs by creating a new class that inherits from the corresponding `*DialogContent` type for the dialog that you want to customize and overriding the necessary methods to implement your custom logic. |
| * `SeriesDialog`—Gets or sets the series dialog. To set a custom series dialog, extend the `SeriesDialogContent` class. | ||
| * `HyperlinkDialog`—Gets or sets the hyperlink dialog. To set a custom hyperlink dialog, extend the `HyperlinkDialogContent` class. | ||
| * `FindAndReplaceDialog`—Gets or sets the find and replace dialog. To set a custom find and replace dialog, extend the `FindAndReplaceDialogContent` class. | ||
| * `CreateUpdateSpreadsheetNameDialog`—Gets or sets the create update spreadsheet name dialog. To set a custom create update spreadsheet name dialog, extend the `CreateUpdateSpreadsheetNameDialogContent` class. |
There was a problem hiding this comment.
"create update" in these sentences is grammatically awkward; consider changing to "create/update" (or "create or update") for readability while keeping the property name as-is.
| * `CreateUpdateSpreadsheetNameDialog`—Gets or sets the create update spreadsheet name dialog. To set a custom create update spreadsheet name dialog, extend the `CreateUpdateSpreadsheetNameDialogContent` class. | |
| * `CreateUpdateSpreadsheetNameDialog`—Gets or sets the create/update spreadsheet name dialog. To set a custom create/update spreadsheet name dialog, extend the `CreateUpdateSpreadsheetNameDialogContent` class. |
| title: Worksheet Editor Dialogs | ||
| page_title: Worksheet Editor Dialogs | ||
| description: Check our "Worksheet Editor Dialogs" documentation article for the RadSpreadsheet WPF control. | ||
| slug: radspreadsheet-worksheet-editor-dialogs |
There was a problem hiding this comment.
The slug radspreadsheet-worksheet-editor-dialogs is inconsistent with other ui-* feature articles whose slugs include the radspreadsheet-ui- prefix (e.g., radspreadsheet-ui-worksheet-editor-context-menu). Consider renaming the slug (and updating references) to match the established convention.
| slug: radspreadsheet-worksheet-editor-dialogs | |
| slug: radspreadsheet-ui-worksheet-editor-dialogs |
|
|
||
| # Worksheet Editor Dialogs | ||
|
|
||
| The `RadWorksheetEditor` class provides the `Dialog` property, which is of the type of `WorksheetEditorDialogs`. This class contains properties for each of the dialogs used in the `RadSpreadsheet` control. |
There was a problem hiding this comment.
The text says RadWorksheetEditor exposes a Dialog property, but the rest of the article (and the code samples) use Dialogs. This looks like an API name typo and will mislead readers; update the property name so it's consistent and accurate.
| The `RadWorksheetEditor` class provides the `Dialog` property, which is of the type of `WorksheetEditorDialogs`. This class contains properties for each of the dialogs used in the `RadSpreadsheet` control. | |
| The `RadWorksheetEditor` class provides the `Dialogs` property, which is of the type of `WorksheetEditorDialogs`. This class contains properties for each of the dialogs used in the `RadSpreadsheet` control. |
| The RadSpreadsheet control provides the `ActiveWorksheetEditor` property that gives you access to the active worksheet editor. You can use this property to access the `Dialogs` property of the active worksheet editor and utilize the dialogs as needed. | ||
|
|
||
| __Accessing the Dialogs__ | ||
| ```C# | ||
| var findAndReplaceDialog = this.radSpreadsheet.ActiveWorksheetEditor.Dialogs.FindAndReplaceDialog; | ||
| ``` |
There was a problem hiding this comment.
This article describes accessing dialogs via ActiveWorksheetEditor, but the PR title mentions the ActiveSheetEditor path. If the intent is to document ActiveSheetEditor, add an example that uses radSpreadsheet.ActiveSheetEditor and casts it to RadWorksheetEditor before accessing .Dialogs (and clarify when ActiveWorksheetEditor vs ActiveSheetEditor should be used).
| * `CustomFilterDialog`—Gets or sets the custom filter dialog. To set a custom custom filter dialog, extend the `CustomFilterDialogContent` class. | ||
| * `CustomSortListsDialog`—Gets or sets the custom sort lists dialog. To set a custom custom sort lists dialog, extend the `CustomSortListsDialogContent` class. |
There was a problem hiding this comment.
Remove the duplicated word "custom" ("custom custom") in this sentence; it reads like a copy/paste typo.
| * `CustomFilterDialog`—Gets or sets the custom filter dialog. To set a custom custom filter dialog, extend the `CustomFilterDialogContent` class. | |
| * `CustomSortListsDialog`—Gets or sets the custom sort lists dialog. To set a custom custom sort lists dialog, extend the `CustomSortListsDialogContent` class. | |
| * `CustomFilterDialog`—Gets or sets the custom filter dialog. To set a custom filter dialog, extend the `CustomFilterDialogContent` class. | |
| * `CustomSortListsDialog`—Gets or sets the custom sort lists dialog. To set a custom sort lists dialog, extend the `CustomSortListsDialogContent` class. |
No description provided.