setBrowserCaption(caption)

Sets the preview pane caption in the rich client. One of the rich-client handle methods, obtained via getRichClientApi() — a direct, synchronous bridge write to the bridge member osjxSetBrowserCaption: no validation, the string unmodified, straight to the bridge.

1. Signature

setBrowserCaption(caption: string): void;

2. Parameters

Name Type Description

caption

string

The preview pane caption to set — passed unmodified to the bridge.

3. Behavior

  • Synchronous: the bridge is a synchronous COM/JS call — setBrowserCaption(caption) invokes osjxSetBrowserCaption(caption) immediately and returns void; there is no promise to await.

  • Direct bridge write: the caption string goes straight to the bridge member osjxSetBrowserCaption — unvalidated and unnormalized.

  • Throw-safe: a missing bridge member throws the descriptive TypeError; a bridge call that throws is converted into the descriptive Error — never an uncaught host-proxy throw, on any client version (see Errors).

  • Lazy per-call read: the handle reads window.osClient per call (no creation-time snapshot) — a bridge state that is injected or swapped later is reflected immediately.

  • Reduced COM-OpenBrowser bridge: it carries exactly two members — osjxGetBrowserEnvironment + osjxSetBrowserCaption. This member is one of the two, so the call works on that surface even when the dashlet members (e.g. osjxGetSelectedObjects) are absent.

4. Examples

rich.setBrowserCaption('Vorschau');

5. Errors

  • Error('dashlet destroyed') — the dashlet was destroyed before the call.

  • TypeError: Dashlet.getRichClientApi(): the environment is not resolved yet - await the dashlet.init promise first — the handle was requested before the environment was resolved (accessor error).

  • TypeError: Dashlet.getRichClientApi(): the rich client API handle is only available in the richClient environment (current: …) — the handle was requested in the wrong environment (accessor error; the current value is named).

  • TypeError: Dashlet: the rich-client bridge does not expose "osjxSetBrowserCaption" (bridge method missing) — the bridge member is missing (the bridge at call time does not expose it).

  • Error: Dashlet: rich-client bridge call "osjxSetBrowserCaption" failed: … — the bridge call itself threw (the detail names the bridge error).