---
title: clsHelpTextCollection
summary: API reference for clsHelpTextCollection.
status: draft
owner: SAIF Doc Gen
last_reviewed: 2026-08-17
library: SAIF.Presentation.Web.Controls.AJAX.Infragistics111
reference_type: package
---

# clsHelpTextCollection

`clsHelpTextCollection` retrieves every [clsHelpText](clsHelpText.md) record for one application code, running the same master/detail join as the single-entry lookup but filtered on application code alone. It is notable for inheriting the non-generic `clsBusinessCollectionBase` rather than the generic `clsBusinessCollection(Of T)` used elsewhere in the packaged set, which may reflect an older framework generation.**

## Purpose
- Retrieves and holds every help-text record for a given application code, one `clsHelpText` per matching row, using the same master/detail join as the single-entry retrieval. ([BR-AJAX-018](../../business-rules.md#br-ajax-018-help-content-is-assembled-by-joining-master-and-detail-on-the-reference-key))
- Supports lookup of a specific entry within the collection by either ordinal index or reference key value, via overloaded `Item`/`Contains` members.
- Enforces read-only access at the collection level in the same manner as `clsHelpText`: all write-shape SQL properties on its `Criteria` throw.

## Context
- Namespace: `SAIF.Presentation.Web.Controls.V2.AJAX`
- Assembly/package: `SAIF.Presentation.Web.Controls.AJAX.Infragistics111` (packaged in `SAIF.BOF.Presentation.Web.Infragistics111`)
- Base class: `clsBusinessCollectionBase` — the non-generic collection base class from `SAIF.Framework` (package `SAIF.BOF.Framework`), unlike the generic `clsBusinessCollection(Of T)` used by some sibling packaged libraries.*
- Nested `Criteria` class implements `IBusinessCriteria` (`SAIF.Framework`) and supplies `RetrieveSQL` (SQL ID `SQL-HELP-RETRIEVE-ALL`), filtered by application code only.

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `Item` | `Default ReadOnly Property Item(index As Integer) As clsHelpText` | Returns the help-text entry at the given ordinal position |
| `Item` | `Default ReadOnly Property Item(referenceKeyValue As String) As clsHelpText` | Returns the help-text entry matching the given reference key value |
| `CurrentItem` | `ReadOnly Property CurrentItem As clsHelpText` | The entry at the collection's current cursor position |
| `Contains` | `Overloads Function Contains(referenceKeyValue As String) As Boolean` | Reports whether an entry with the given reference key value exists in the collection |
| `GetHelpTexts` | `Shared Function GetHelpTexts(dpi As IDataPortalInfo, applicationCode As String) As clsHelpTextCollection` | Factory that constructs the `Criteria` and calls `RetrieveObject` to load every matching record |

## Behavioral notes
- Result handling casts the data-portal result to an `IDataReader` and loads one `clsHelpText` per row via a private `Fill`, mirroring the single-entry retrieval's mapping logic.
- Because the join and column mapping are identical to `clsHelpText`'s single-entry retrieval, an application code with no help entries yields an empty collection rather than an error.*

## Constraints and usage notes
- All SQL access is fully parameterized (`:ApplicationCode` only); no string concatenation of caller-supplied values into SQL occurs in this class.
- This collection is read-only end to end: `Criteria.CreateSQL`, `InsertSQL`, `UpdateSQL`, and `DeleteSQL` all throw `ApplicationException(BOC.Messages.InvalidSQLProperty)` if invoked.

## Related documentation
- [Index](../../index.md)
- [Overview](../../overview.md)
- [Architecture](../../architecture.md)
- [Business rules](../../business-rules.md)
- [Operations and processes](../../operations-processes.md)
- [Database tables](../../database-tables.md)
- [SQL catalog](../../sql/index.md)
- [API reference](../index.md)

> **Note:** Statements marked with `*` were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts. Statements marked with `**` could not be confirmed; treat as unknown until verified.

## Sources
- `SAIF.Presentation.Web.Controls.AJAX.Infragistics111/clsHelpTextCollection.vb`