PropertyGrid

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • PropertyGrid

Provides a user interface for browsing the properties of an object.

C#

public class PropertyGrid : Control, IEnumerable<GridItem>, IEnumerable, IReadOnly

VB.NET

Public Class PropertyGrid
    Inherits Control
    Implements IEnumerable(Of GridItem), IEnumerable, IReadOnly

Constructors

PropertyGrid()

Initializes a new instance of the PropertyGrid class.

Properties

BorderStyle

BorderStyle: Indicates the border style for the property grid. (Default: None)

BrowsableAttributes

Attribute[]: Returns or sets the attributes used to filter the properties to display in the PropertyGrid.

ClientArea

Rectangle: Returns the client rectangle excluding the non-client caption and borders dimensions.

ColumnHeadersVisible

Boolean: Returns or sets whether the column that contains row headers is displayed. (Default: False)

DefaultPasswordText

String: Defines the default text to display in a PropertyGrid password cell. Since 3.5.18

EditOnEnter

Boolean: Returns or sets whether the value cell automatically enters edit mode when the row is selected. (Default: True)

HelpVisible

Boolean: Returns or sets whether the Help text is visible. (Default: True)

Item(index)

GridItem: Returns the GridItem at the specified index.

Item(label)

GridItem: Returns the first GridItem with the matching label.

NameFillWeight

Single: Returns or sets the FillWeight the Name column. 50 (%) is the default. (Default: 50)

Throws:

• ArgumentException A value less than -1 is assigned to the property.

NameTitle

String: Returns or sets the title of the Name column shown when ColumnHeadersVisible is true.

PropertySort

PropertySort: Returns or sets the type of sorting the PropertyGrid uses to display properties. (Default: CategorizedAlphabetical)

ReadOnly

Boolean: Returns or sets whether the user can edit the values of the SelectedObject. (Default: False)

Throws:

• InvalidOperationException The specified value when setting this property is true, the current cell is in edit mode, and the current cell contains changes that cannot be committed.
• Exception The specified value when setting this property would cause the control to enter edit mode, but initialization of the editing cell value failed and either there is no handler for the DataError event or the handler has set the ThrowException property to true. The exception object can typically be cast to type FormatException.

RightClickSelection

Boolean: Returns or sets whether the grid item under the pointer gets selected on a right click. (Default: False)

RowHeadersVisible

Boolean: Returns or sets whether the column that contains row headers is displayed. (Default: True)

SelectedGridItem

GridItem: Returns or sets the selected grid item.

SelectedObject

Object: Returns or sets the object for which the grid displays properties. (Default: null)

SelectedObjects

Object[]: Returns or sets the currently selected objects.

Throws:

• ArgumentException One of the items in the array of objects had a null value.

ShowHelpToolTips

Boolean: Returns or sets whether the control shows the property description text in a tooltip. (Default: False)

ToolBar

ToolBar: Returns the ToolBar control at the top of the PropertyGrid.

ToolbarVisible

Boolean: Returns or sets whether the toolbar is visible. (Default: False)

Tools

ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this control.

ToolsPosition

Position: Returns or sets the position of the ComponentTool items associated with this control. (Default: Top)

ValueTitle

String: Returns or sets the title of the Value column shown when ColumnHeadersVisible is true.

Methods

CollapseAllGridItems()

Collapses all the categories in the PropertyGrid.

Dispose(disposing)

Disposes the control.

Parameter	Type	Description
disposing	Boolean	true when this method is called by the application rather than a finalizer.

ExpandAllGridItems()

Expands all the categories in the PropertyGrid.

GetProperties(objects, attributes)

Returns a list of PropertyDescriptor used to populate the PropertyGrid.

Parameter	Type	Description
objects	Object[]	Objects to retrieve the properties from.
attributes	Attribute[]	Attributes to filter the properties.

Returns: IList<PropertyDescriptor>. A list of PropertyDescriptor objects representing the properties to load into the property grid.

The default implementation uses [GetProperties](https://docs.microsoft.com/dotnet/api/system.componentmodel.typedescriptor.getproperties(system.object,system.attribute) to retrieve the list of public properties from the selected objects.

OnFontChanged(e)

Parameter	Type	Description
e	EventArgs

OnNameFillWeightChanged(e)

Fires the NameFillWeightChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnPropertySortChanged(e)

Fires the PropertySortChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnPropertyValueChanged(e)

Fires the PropertyValueChanged event.

Parameter	Type	Description
e	PropertyValueChangedEventArgs	A PropertyValueChangedEventArgs that contains the event data.

OnPropertyValueDataError(e)

Fires the PropertyValueDataError event.

Parameter	Type	Description
e	PropertyValueDataErrorEventArgs	A PropertyValueDataErrorEventArgs that contains the event data.

OnPropertyValueFormatting(e)

Fires the PropertyValueFormatting event.

Parameter	Type	Description
e	PropertyValueFormattingEventArgs	A PropertyValueFormattingEventArgs that contains the event data.

OnReadOnlyChanged(e)

Fires the ReadOnlyChanged event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnSelectedGridItemBeginEdit(e)

Fires the SelectedGridItemBeginEdit event.

Parameter	Type	Description
e	SelectedGridItemBeginEditEventArgs	A SelectedGridItemBeginEditEventArgs that contains the event data.

OnSelectedGridItemChanged(e)

Fires the SelectedGridItemChanged event.

Parameter	Type	Description
e	SelectedGridItemChangedEventArgs	A SelectedGridItemChangedEventArgs that contains the event data.

OnSelectedGridItemEndEdit(e)

Fires the SelectedGridItemEndEdit event.

Parameter	Type	Description
e	SelectedGridItemEndEditEventArgs	A SelectedGridItemEndEditEventArgs that contains the event data.

OnSelectedObjectsChanged(e)

Fires the SelectedObjectsChanged event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnToolbarButtonClick(e)

Fires the ButtonClick event.

Parameter	Type	Description
e	ToolBarButtonClickEventArgs	A ToolBarButtonClickEventArgs that contains the event data.

OnToolbarButtonDropDown(e)

Fires the ButtonDropDown event.

Parameter	Type	Description
e	ToolBarButtonClickEventArgs	A ToolBarButtonClickEventArgs that contains the event data.

OnToolClick(e)

Fires the ToolClick event.

Parameter	Type	Description
e	ToolClickEventArgs	A ToolClickEventArgs that contains the event data.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

Refresh()

Reloads the updated values from the current SelectedObject or SelectedObjects.

Refresh(refreshChildren)

Reloads the updated values from the current SelectedObject or SelectedObjects.

Parameter	Type	Description
refreshChildren	Boolean	True to also refresh all the children of this control.

ResetSelectedProperty()

Resets the selected property to its default value.

Events

NameFillWeightChanged

EventHandler Fired when the value o the NameFillWeight property changes.

PropertySortChanged

EventHandler Fired when the sort mode is changed.

PropertyValueChanged

PropertyValueChangedEventHandler Fired when a property value changes.

PropertyValueDataError

PropertyValueDataErrorEventHandler Fired when a property value is being changed but it is incompatible with the new value.

PropertyValueFormatting

PropertyValueFormattingEventHandler Fired when the property value is being formatted to be displayed.

ReadOnlyChanged

EventHandler Fired when the value of the ReadOnly property has changed.

SelectedGridItemBeginEdit

SelectedGridItemBeginEditEventHandler Fired when the selected GridItem is entering edit mode.

SelectedGridItemChanged

SelectedGridItemChangedEventHandler Fired when the selected GridItem is changed.

SelectedGridItemEndEdit

SelectedGridItemEndEditEventHandler Fired when the selected GridItem exits edit mode.

SelectedObjectsChanged

EventHandler Fired when the objects selected by the SelectedObjects property have changed.

ToolbarButtonClick

ToolBarButtonClickEventHandler Fired when a ToolBarButton on the ToolBar is clicked.

ToolbarButtonDropDown

ToolBarButtonClickEventHandler Fired when a drop-down style ToolBarButton or its down arrow is clicked.

ToolClick

ToolClickEventHandler Fired when a ComponentTool is clicked.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
IDropTarget	Controls that support drag & drop operations implement this interface.
IReadOnly	Provides access to the ReadOnly property for coontrols that support the read-only mode.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejSerializable	Allows an object to serialize itself.