Skip to main content

Component Plug-In SDK 2026 R1

Method OpenBuilderUIForComponentAsync

Last update: 19.06.2026

Namespace: Phoenix.ComponentAPI
Assembly: Phoenix.ComponentAPI.dll

OpenBuilderUIForComponentAsync(IHarnessRunnerSession)

Creates the builder UI to edit the given instantiated IHarnessSession. No IPaczWriter local session may be open on this runner when calling this method.

Task<IHarnessBuilderUISession> OpenBuilderUIForComponentAsync(IHarnessRunnerSession session)

Parameters

session IHarnessRunnerSession

The session to instantiate a builder UI for. The session must have been created by this client object. It is illegal to call this function more than once without calling Dispose on the returned IHarnessBuilderUISession first.

Returns

Task<IHarnessBuilderUISession>

A task that returns a new IHarnessBuilderUISession.

Exceptions

InvalidOperationException

If a builder or local edit session is already open for the given runner session

Connect with Ansys