Blazorise Property Grid API
Explore the Blazorise Property Grid API reference for parameters, events, methods, and related types.
For examples and usage guidance, see the Property Grid documentation.
API
Parameters
PropertyGrid
| Parameter | Default | Type |
|---|---|---|
AriaLabel | "Properties" | string |
Defines the accessible property grid label. | ||
ChildContent | null | RenderFragment |
Specifies the property groups to be rendered inside this PropertyGrid. | ||
Help | null | RenderFragment |
Specifies content rendered below the scrollable property viewport. | ||
Toolbar | null | RenderFragment |
Specifies content rendered above the scrollable property viewport. | ||
PropertyGridView
| Parameter | Default | Type |
|---|---|---|
ActionTemplate | null | RenderFragment<PropertyGridActionContext> |
Defines an action template. | ||
AlphabeticalButtonIcon | SortAlphaDown | IconName |
Gets or sets the alphabetical button icon. | ||
AlphabeticalButtonTemplate | null | RenderFragment<PropertyGridViewModeContext> |
Defines the alphabetical view button template. | ||
AlphabeticalButtonTitle | "Alphabetical" | string |
Gets or sets the alphabetical button title. | ||
AriaLabel | "Properties" | string |
Gets or sets the accessible property grid label. | ||
BooleanEditorTemplate | null | RenderFragment<PropertyGridEditorContext> |
Defines a boolean editor template. | ||
CategorizedButtonIcon | List | IconName |
Gets or sets the categorized button icon. | ||
CategorizedButtonTemplate | null | RenderFragment<PropertyGridViewModeContext> |
Defines the categorized view button template. | ||
CategorizedButtonTitle | "Categorized" | string |
Gets or sets the categorized button title. | ||
ChildContent | null | RenderFragment |
Defines content rendered after all schema groups. | ||
ColorEditorTemplate | null | RenderFragment<PropertyGridEditorContext> |
Defines a color editor template. | ||
EmptyTemplate | null | RenderFragment |
Defines content rendered when the schema and child content are empty. | ||
GroupHeaderTemplate | null | RenderFragment<PropertyGridGroupContext> |
Defines a group header template. | ||
GroupTemplate | null | RenderFragment<PropertyGridGroupContext> |
Defines a complete group template. | ||
HelpTemplate | null | RenderFragment<PropertyGridHelpContext> |
Defines the selected property help template. | ||
ItemTemplate | null | RenderFragment<PropertyGridItemContext> |
Defines a complete property item template. | ||
LabelTemplate | null | RenderFragment<PropertyGridLabelContext> |
Defines a property label template. | ||
NoResultsTemplate | null | RenderFragment |
Defines content rendered when no properties match the current search. | ||
NoResultsText | "No properties found." | string |
Defines the text rendered when no properties match the current search. | ||
NumericEditorTemplate | null | RenderFragment<PropertyGridEditorContext> |
Defines a numeric editor template. | ||
Schema | null | PropertyGridSchema |
Gets or sets the schema rendered by the property grid. | ||
SearchAriaLabel | "Search properties" | string |
Gets or sets the accessible property search label. | ||
SearchDebounce | true | bool |
Gets or sets whether property search changes are debounced. | ||
SearchDebounceInterval | 300 | int |
Gets or sets the property search debounce interval in milliseconds. | ||
SearchPlaceholder | "Search" | string |
Gets or sets the property search placeholder. | ||
SearchTemplate | null | RenderFragment<PropertyGridSearchContext> |
Defines the property search template. | ||
SearchText | — | string |
Gets or sets the property search text. | ||
SelectEditorTemplate | null | RenderFragment<PropertyGridEditorContext> |
Defines a select editor template. | ||
SelectedProperty | null | PropertyGridProperty |
Gets or sets the selected property. | ||
ShowHelp | true | bool |
Gets or sets whether help for the selected property is shown. | ||
ShowSearch | true | bool |
Gets or sets whether the property search editor is shown. | ||
ShowToolbar | true | bool |
Gets or sets whether the property grid toolbar is shown. | ||
ShowViewModeButtons | true | bool |
Gets or sets whether the categorized and alphabetical view buttons are shown. | ||
TextEditorTemplate | null | RenderFragment<PropertyGridEditorContext> |
Defines a text editor template. | ||
ToolbarAriaLabel | "Property grid controls" | string |
Gets or sets the accessible property grid toolbar label. | ||
ToolbarTemplate | null | RenderFragment<PropertyGridToolbarContext> |
Defines the complete toolbar template. | ||
ViewMode | Categorized | PropertyGridViewMode |
Gets or sets how properties are arranged. Possible values: CategorizedAlphabetical | ||
Events
PropertyGridView
| Event | Type |
|---|---|
ActionInvoked | EventCallback<PropertyGridActionEventArgs> |
Occurs after a property action is invoked. | |
GroupExpandedChanged | EventCallback<PropertyGridGroupExpandedEventArgs> |
Occurs after a property group expansion state changes. | |
PropertyValueChanged | EventCallback<PropertyGridValueChangedEventArgs> |
Occurs after a property value changes. | |
SearchTextChanged | EventCallback<string> |
Occurs after the property search text changes. | |
SelectedPropertyChanged | EventCallback<PropertyGridProperty> |
Occurs after the selected property changes. | |
ViewModeChanged | EventCallback<PropertyGridViewMode> |
Occurs after the property arrangement changes. | |