Skip to main content

Component Plug-In SDK 2026 R1

Interface IHarnessBuilderUIBase

Last update: 19.06.2026

Namespace: Phoenix.ComponentBuilderAPI
Assembly: Phoenix.ComponentBuilderAPI.dll

A base interface for the interface that a component builder UI must implement. Useful internally to handle plug-ins generically without requiring knowing the type of runner being edited. Plug-Ins should always implement Phoenix.ComponentBuilderAPI.IHarnessBuilderUI1`

[PlugInInterfaceName("Phoenix::IHarnessBuilderUI")]
public interface IHarnessBuilderUIBase : IDisposable

Implements

IDisposable

Properties

HarnessType

Returns the Type object for the IHarnessRunner that this builder UI operates on.

Methods

ShowAsync()

Request that the UI be shown.

TrySaveAsync()

Tells the UI to save any current work. If there are no change, this function should return true immediately. If there are unsaved changes, the user should be prompted to save their work with (yes, no, cancel) options.

If the plug-in writer does not wish to have this protection, just return true and do nothing.

WindowClosed

This event is raised any time the window is closed.

Connect with Ansys