PropertyGridBuilder

Properties

WriteAction - Func

Methods

Model(System.Object)

Sets the object to which the PropertyGrid is bound.

Parameters

value - System.Object

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.

RETURNS

Returns the current PropertyGridBuilder instance.

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<PropertyGridToolbarSettingsBuilder>

The configurator for the toolbar setting.

RETURNS

Returns the current PropertyGridBuilder instance.

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.

RETURNS

Returns the current instance of PropertyGridBuilder .

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.

RETURNS

Returns the current instance of PropertyGridBuilder .

ContextMenu()

Configures the ContextMenu of the PropertyGrid. If set to true enables the default ContextMenu.

RETURNS

Returns the current instance of PropertyGridBuilder .

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.

RETURNS

Returns the current instance of PropertyGridContextMenuSettingsBuilder .

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

RETURNS

Returns the current PropertyGridBuilder instance.

Excel(System.Action)

Configures the Excel export settings of the PropertyGrid.

Parameters

configurator - System.Action<PropertyGridExcelSettingsBuilder>

The configurator for the excel setting.

RETURNS

Returns the current instance of PropertyGridBuilder .

Groupable(System.Boolean)

Enables the grouping of properties. Set this configuration to false to disable grouping.

Parameters

value - System.Boolean

The value for Groupable

RETURNS

Returns the current PropertyGridBuilder instance.

Height(System.Double)

Sets the height of the PropertyGrid. Numeric values are treated as pixels.

Parameters

value - System.Double

The value for Height

RETURNS

Returns the current PropertyGridBuilder instance.

Items(System.Action)

Additional configuration options for the properties of the model.

Parameters

configurator - System.Action<PropertyGridItemFactory>

The configurator for the items setting.

RETURNS

Returns the current instance of PropertyGridBuilder .

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.

RETURNS

Returns the current instance of PropertyGridBuilder .

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

RETURNS

Returns the current PropertyGridBuilder instance.

Navigatable()

If set to true, the user can navigate the component with the keyboard. By default, keyboard navigation is disabled.

RETURNS

Returns the current PropertyGridBuilder instance.

Pdf(System.Action)

Configures the PDF export settings of the PropertyGrid.

Parameters

configurator - System.Action<PropertyGridPdfSettingsBuilder>

The configurator for the pdf setting.

RETURNS

Returns the current instance of PropertyGridBuilder .

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

RETURNS

Returns the current PropertyGridBuilder instance.

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

RETURNS

Returns the current PropertyGridBuilder instance.

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

RETURNS

Returns the current PropertyGridBuilder instance.

Width(System.Double)

Sets the width of the PropertyGrid. Numeric values are treated as pixels.

Parameters

value - System.Double

The value for Width

RETURNS

Returns the current PropertyGridBuilder instance.

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<PropertyGridEventBuilder>

The client events action.

RETURNS

Returns the current PropertyGridBuilder instance.

Example

Razor

 
            @(Html.Kendo().PropertyGrid()
                  .Name("PropertyGrid")
                  .Events(events => events
                      .BeforeEdit("onBeforeEdit")
                  )
            )
             

ToComponent()

Returns the internal view component.

RETURNS

The instance that represents the component.

Expression(System.String)

Sets the name of the component.

Parameters

modelExpression - System.String

RETURNS

Returns the current instance.

Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)

Sets the name of the component.

Parameters

modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer

RETURNS

Returns the current instance.

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name.

RETURNS

Returns the current instance.

Deferred(System.Boolean)

Suppress initialization script rendering. Note that this options should be used in conjunction with

Parameters

deferred - System.Boolean

RETURNS

Returns a DeferredWidgetBuilder instance.

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

RETURNS

Returns the current instance.

HtmlAttributes(System.Collections.Generic.IDictionary)

Sets the HTML attributes.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The HTML attributes.

RETURNS

Returns the current instance.

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.

RETURNS

Returns the current instance.

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.

RETURNS

Returns the current instance.

Render()

Renders the component in place.

ToHtmlString()

Returns the HTML representation of the component.

WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)

Parameters

writer - System.IO.TextWriter

encoder - System.Text.Encodings.Web.HtmlEncoder

ToClientTemplate()

Returns the client template for the component.

AsModule(System.Boolean)

Specifies whether the initialization script of the component will be rendered as a JavaScript module.

Parameters

value - System.Boolean

RETURNS

Returns the current instance.