PropertyGridBuilder
Properties
WriteAction - Func
Methods
Model(System.Object)
Sets the object to which the PropertyGrid is bound.
Parameters
value - System.Object
Columns(System.Action)
The configuration of the PropertyGrid columns which allows for setting the field and value column configuration options.
Parameters
configurator - System.Action<PropertyGridColumnsSettingsBuilder>
The configurator for the columns setting.
ContextMenu(System.Action)
Configures the ContextMenu of the PropertyGrid. If set to true enables the default ContextMenu.
Parameters
configurator - System.Action<PropertyGridContextMenuSettingsBuilder>
The configurator for the contextmenu setting.
ContextMenu()
Configures the ContextMenu of the PropertyGrid. If set to true enables the default ContextMenu.
ContextMenu(System.Boolean)
Configures the ContextMenu of the PropertyGrid. If set to true enables the default ContextMenu.
Parameters
enabled - System.Boolean
Enables or disables the contextmenu option.
EditMode(System.Boolean)
If set to true, the user will be able to edit the values of the object's properties to which the PropertyGrid is bound. By default, editing is enabled. can also be set to a string (which specifies the edit mode).The supported string values are: (Default) incell.
Parameters
value - System.Boolean
The value for EditMode
Excel(System.Action)
Configures the Excel export settings of the PropertyGrid.
Parameters
configurator - System.Action<PropertyGridExcelSettingsBuilder>
The configurator for the excel setting.
Groupable(System.Boolean)
Enables the grouping of properties. Set this configuration to false to disable grouping.
Parameters
value - System.Boolean
The value for Groupable
Height(System.Double)
Sets the height of the PropertyGrid. Numeric values are treated as pixels.
Parameters
value - System.Double
The value for Height
Items(System.Action)
Additional configuration options for the properties of the model.
Parameters
configurator - System.Action<PropertyGridItemFactory>
The configurator for the items setting.
Messages(System.Action)
Defines the text of the command buttons that are shown within the PropertyGrid. Used primarily for localization.
Parameters
configurator - System.Action<PropertyGridMessagesSettingsBuilder>
The configurator for the messages setting.
Navigatable(System.Boolean)
If set to true, the user can navigate the component with the keyboard. By default, keyboard navigation is disabled.
Parameters
value - System.Boolean
The value for Navigatable
Navigatable()
If set to true, the user can navigate the component with the keyboard. By default, keyboard navigation is disabled.
Pdf(System.Action)
Configures the PDF export settings of the PropertyGrid.
Parameters
configurator - System.Action<PropertyGridPdfSettingsBuilder>
The configurator for the pdf setting.
Resizable(System.Boolean)
When set to true the user will be able to resize columns via the context menu. When set to false the ContextMenu Resize command will not be available.
Parameters
value - System.Boolean
The value for Resizable
ShowDetails(System.Boolean)
Use this configuration to disable the ToggleDetails command button on the toolbar and to prevent the rendering of the Details/Info box.
Parameters
value - System.Boolean
The value for ShowDetails
Scrollable(System.Boolean)
If set to true, the PropertyGrid will display a scrollbar when the total row height or width exceeds the PropertyGrid height or width. By default, scrolling is enabled.
Parameters
value - System.Boolean
The value for Scrollable
Toolbar(System.Action)
If a String value is assigned to the toolbar configuration option, it will be treated as a single string template for the whole PropertyGrid toolbar and the string value will be passed as an argument to a kendo.template() function.; If a Function value is assigned (it may be a kendo.template() function call or a generic function reference), then the return value of the function will be used to render the contents of the PropertyGrid toolbar. or If an Array value is assigned, it will be treated as the list of commands which are displayed in the PropertyGrid toolbar. Commands can be custom or built-in. The supported built-in commands are:search—Adds a Search input to the ToolBar of the PropertyGrid. Search is performed by property name.sort—Adds a DropDownList with sorting options. Properties are sorted by property name.group—Renders a button for toggling between List and Group layout.details—Renders a button for toggling the Details/Info box.separator—Renders a separator element.spacer—Renders a spacer element.excel—Exports the data in MS Excel format.pdf—Exports the data in PDF format..
Parameters
configurator - System.Action<PropertyGridToolbarFactory>
The configurator for the toolbar setting.
Width(System.Double)
Sets the width of the PropertyGrid. Numeric values are treated as pixels.
Parameters
value - System.Double
The value for Width
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<PropertyGridEventBuilder>
The client events action.
Example
@(Html.Kendo().PropertyGrid()
.Name("PropertyGrid")
.Events(events => events
.BeforeEdit("onBeforeEdit")
)
)
ToComponent()
Returns the internal view component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
ScriptAttributes(System.Object,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Object
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
Render()
Renders the component in place.
ToHtmlString()
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.