Skip to content

PropertyGridControl class

Displays and edits the properties of the selected object.

Namespace: Eremex.AvaloniaUI.Controls.PropertyGrid
Assembly: Eremex.Avalonia.Controls.dll
NuGet Package: Eremex.Avalonia.Controls

Declaration

public class PropertyGridControl : TemplatedControl, IPropertyGridEditableNode, 
    IPropertyGridRowsOwner

Constructors

name description
PropertyGridControl() Initializes a new instance of the PropertyGridControl class.

Properties

name description
ActiveEditor { get; } Gets the editor that is currently active for the focused row.
AllowEditing { get; set; } Gets or sets whether users can edit row values.
AllowImmediateEditorValuePosting { get; set; } Gets or sets whether editor values are posted immediately as they change.
AllowResizing { get; set; } Gets or sets whether users can resize the captions and editors columns.
AutoGenerateRows { get; set; } Gets or sets whether rows are generated automatically from the selected object's properties.
CaptionColumnWidth { get; set; } Gets or sets the width of the captions column.
CaptionHorizontalAlignment { get; set; } Gets or sets the horizontal alignment of row captions.
CellTemplate { get; set; } Gets or sets the template that displays row values when a row defines no own template.
EditorButtonShowMode { get; set; } Gets or sets when editor buttons are displayed.
EditorColumnWidth { get; set; } Gets or sets the width of the editors column.
EditorShowMode { get; set; } Gets or sets the mouse action that activates an editor.
FocusedRow { get; set; } Gets or sets the focused row.
IgnoreValidationAttributesOnCommit { get; set; } Gets or sets whether validation attributes are ignored when an editor value is committed.
IsResizerVisible { get; } Gets whether the column resizer is displayed.
Rows { get; } Gets the collection of rows.
RowsDataTemplates { get; set; } Gets or sets the templates used to create rows from RowsSource items.
RowsSource { get; set; } Gets or sets the collection whose items are used to generate rows.
SearchText { get; set; } Gets or sets the text used to filter rows.
SelectedObject { get; set; } Gets or sets the object whose properties are displayed and edited.
SelectedObjects { get; set; } Gets or sets the collection of objects whose properties are displayed and edited. Supports editing multiple objects at once.
ShowDataErrors { get; set; } Gets or sets whether data validation errors are displayed for rows.
ShowSearchPanel { get; set; } Gets or sets whether the search panel is displayed.
ValidateRowValuesOnShowAndUpdate { get; set; } Gets or sets whether row values are validated when displayed and updated instead of when an editor value is committed.

Methods

name description
CloseEditor() Saves the active editor's value to the data object and hides the editor.
CollapseAllRows() Collapses all rows.
ExpandAllRows() Expands all rows.
HideEditor() Hides the active editor without posting its value.
PostEditor() Saves the active editor's value to the data object.
Refresh() Re-reads values from the selected object and updates row values.
RetrieveFields() Regenerates rows from the selected object's properties.
ShowEditor() Activates an editor for the focused row and selects its content.

Events

name description
event CellValueChanged Occurs after a row value has been changed.
event CellValueChanging Occurs when a user modifies a row value in an editor, before the change is committed.
event CustomCellTemplateData Occurs when the data for a row's cell template is needed. Set the Data property to provide custom data.
event HiddenEditor Occurs after an editor has been closed.
event InvalidRowValueException Occurs when an exception is thrown while a row value is saved to the data object. Set the ErrorContent property to customize the error.
event ShowingEditor Occurs before an editor is activated for a row. Cancel the event to prevent editing.
event UsingComplexDataContext Occurs before a row value of a complex type is used as the DataContext for the cell's content. Cancel the event to bind to the parent object's property instead.
event ValidateRowValue Occurs when a row value is validated. Set the ErrorContent property to indicate an error.

See Also

Used in articles