Skip to main content

Component Plug-In SDK 2026 R1

Method CreateNewComponentAsync

Last update: 19.06.2026

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

CreateNewComponentAsync(Guid, IRunnerSessionOptions)

Creates a new instance of a builder using the Id of the plug-in. This creates both the Builder UI and the Runner. You must Dispose() both the returned object as well as the IHarnessBuilderUISession.Runner separately. This allows the Runner to outlive the builder UI if you so desire.

Task<IHarnessBuilderUISession> CreateNewComponentAsync(Guid builderUIId, IRunnerSessionOptions options)

Parameters

builderUIId Guid

The Id of the builder UI to instantiate.

options IRunnerSessionOptions

Options for creating the runner session that supports the builder. See Phoenix.ComponentAPI.IRunnerSessionOptions for more information on determining a safe value or for how to use this parameter as an implementer.

Returns

Task<IHarnessBuilderUISession>

A task that returns a new IHarnessBuilderUISession.

Connect with Ansys