---
title: HierarchialGridArgs
summary: API reference for HierarchialGridArgs.
status: draft
owner: SAIF documentation team
last_reviewed: 2026-08-17
library: SAIF.Presentation.Web.Binding.Infragistics103
reference_type: embedded
---

# HierarchialGridArgs

This hierarchical-grid argument carrier extends `clsObjectBindingArgs` with an internal band-to-column-key map used by the classic `UltraWebGrid` binder. The manager passes it when a hierarchical grid needs a different key property for each band instead of one flat key shared by the whole grid.

## Purpose
- Capture per-band key-property mappings for hierarchical `UltraWebGrid` bindings.
- Let grid registration code describe nested grid identity rules without changing the binder contract.
- Reuse the base binding metadata from `clsObjectBindingArgs` when hierarchical grid bindings also need standard source and bind-type information.

## Context
- Namespace: `SAIF.Presentation.Web.Binding`
- Assembly/package: `SAIF.Presentation.Web.Binding.Infragistics103` (embedded/bundled as source, not independently packaged)

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| Add | `Public Sub Add(ByVal inBandKey As String, ByVal inColumnKey As String)` | Registers the key-property name a specific grid band should use. |
| New | `Public Sub New(ByVal inBandKey As String, ByVal inColumnKey As String)` | Creates the mapping collection and seeds it with one band/key entry. |
| New | `Public Sub New()` | Creates an empty mapping collection for incremental population. |
| GetKeyProperty | `Public Function GetKeyProperty(ByVal inBandKey As String) As String` | Returns the configured key property for a band, or `String.Empty` when no mapping exists. |

## Behavioral notes
- The underlying dictionary is populated only through `Add` or the seeded constructor, so unknown bands resolve to `String.Empty` rather than throwing from the public API.
- This type inherits `clsObjectBindingArgs`, but its distinctive responsibility is the extra band-key dictionary rather than generic control metadata.

## Constraints and usage notes
- Use this type only for classic hierarchical `UltraWebGrid` bindings; flat grids can use a single key property or `UltraGridBindingArgs`.
- Populate every band that the binder must resolve during object lookup.

## Sources
- `SAIF.Presentation.Web.Binding.Infragistics103\clsObjectBindingArgs.vb`