Skip to main content

Component Plug-In SDK 2026 R1

Interface IHarnessBuilderUISession

Last update: 19.06.2026

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

This interface represents a single instance of a builder UI that can be used to create or edit a harness.

Instances of this interface are typically not thread safe. It uses the task-based asynchronous pattern (https://docs.microsoft.com/en-us/dotnet/standard/asynchronous-programming-patterns/task-based-asynchronous-pattern-tap )

public interface IHarnessBuilderUISession : IDisposableAndAsync, IDisposable, IHarnessSaveOperations

Implements

IDisposableAndAsync, IDisposable, IHarnessSaveOperations

Properties

Runner

Gets the Runner associated with this builder.

Methods

ShowAsync()

Tell the builder UI to be shown to the user.

TrySaveAsync()

Inform any open builder windows to ask the user to save.

ComponentChanged

This event is fired whenever the user applies changes to the harness.

TestRunRequested

This event is fired whenever the user requests a test run of the component.

WindowClosed

This event is fired whenever the builder window is closed.

Connect with Ansys