﻿---
title: MessageFormatting
summary: API reference for the SAIF.Application.MessageFormatting type.
status: draft
owner: SAIF Doc Gen
last_reviewed: 2026-07-24
library: SAIF.Application
reference_type: package
---

# MessageFormatting

`SAIF.Application.MessageFormatting` is a shared helper for converting message collections into display-ready strings for Windows, web, and user-defined presentation contexts.

## Purpose
- Centralize reusable message-string formatting logic.
- Provide helpers that normalize message aggregation across multiple caller presentation styles.

## Context
- Namespace: `SAIF.Application`
- Assembly/package: `SAIF.BOF.Application`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `GetMessagesForWindows` | `Public Shared Function GetMessagesForWindows(ByVal inMessages As String()) As String` | Format a message collection for Windows-style presentation. |
| `GetMessagesForWeb` | `Public Shared Function GetMessagesForWeb(ByVal inMessages As String()) As String` | Format a message collection for web presentation. |
| `GetMessagesUserDefined` | `Public Shared Function GetMessagesUserDefined(ByVal inMessages As String(), ByVal inConcatString As String) As String` | Format a message collection using a caller-supplied separator. |
| `BuildMessageString` | `Public Shared Function BuildMessageString(ByVal inMessages As Generic.List(Of String), ByVal inConcatString As String) As String` | Build a single string from a list of messages and a separator. |
| `AppendMessageString` | `Public Shared Sub AppendMessageString(ByRef inMessage As String, ByVal inMessages As Generic.List(Of String), ByVal inConcatString As String)` | Append a formatted message string to an existing target string. |

## Behavioral notes
- Duplicate suppression in formatted message output aligns with [BR-002](../../business-rules.md#br-002-duplicate-message-text-is-suppressed).
- The helper focuses on string composition rather than persistence or transport concerns.

## Constraints and usage notes
- Methods are shared helper operations rather than instance-based stateful behavior.
- Consumers should choose the formatting variant that matches their UI or service output context.

## Sources
- `Application\SAIF.Application\MessageFormatting.vb`
