> For the complete documentation index, see [llms.txt](https://docs.flatredball.com/gum/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flatredball.com/gum/code/gum-tool-code-contributing-and-plugins/datauigrid.md).

# DataUiGrid

## Introduction

The DataUiGrid is similar to the Windows Forms PropertyGrid: a reflection-based control which displays the properties on an object in real time. It can also display properties through explicit get and set methods rather than reflection. Gum uses it for the **Variables** tab, but it is general purpose and can be used in any Avalonia application.

The grid is split into two projects in the Gum repository:

* `DataUi.Core` holds the data model (`MemberCategory`, `InstanceMember`, and the `IDataUi` interface). It has no UI framework dependency.
* `AvaloniaDataUi` holds the Avalonia `DataUiGrid` control and its editors.

The DataUiGrid can be used with reflection or its Categories can be manually populated. Using reflection is easier to set up, but does not provide as much flexibility. Manually building up Categories takes more work, but provides the most flexibility.

{% hint style="info" %}
The Gum tool used to be a WPF application, and older versions of this page described the WPF grid in `WpfDataUi`. The data model types keep their `WpfDataUi` and `WpfDataUi.DataTypes` namespaces, so code that builds categories and instance members does not change.
{% endhint %}

## Adding References

Add a project reference to `AvaloniaDataUi/AvaloniaDataUi.csproj`. It brings `DataUi.Core` with it.

## Adding a DataUiGrid in Code

Construct a grid in code like any other Avalonia control:

```csharp
// Initialize
var grid = new AvaloniaDataUi.DataUiGrid();
// add the grid to a layout control such as a Grid or StackPanel...
```

## Using the grid in code

To use the grid, set its Instance property to the object you want to view. For example:

```csharp
// Initialize
// A MemoryStream shows that the grid works with any object:
System.IO.MemoryStream memoryStream = new System.IO.MemoryStream();

grid.Instance = memoryStream;
```

The grid displays one row for each public property on the object, grouped into categories.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flatredball.com/gum/code/gum-tool-code-contributing-and-plugins/datauigrid.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.