Skip to main content

Component Plug-In SDK 2026 R1

Class UserFriendlyBuilderSessionInitialization

Last update: 19.06.2026

Namespace: Phoenix.BuilderUIClient
Assembly: Phoenix.BuilderUIClient.dll

public class UserFriendlyBuilderSessionInitialization

Inheritance

object ← UserFriendlyBuilderSessionInitialization

Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Constructors

UserFriendlyBuilderSessionInitialization(InitializationOption, IEnumerable, string, string, bool, string, string)

Protected constructor. Calling code should use Phoenix.BuilderUIClient.UserFriendlyBuilderSessionInitialization.PromptUser(System.String,System.String,Phoenix.DotNetUtils.DelegateCommandAsync) to display the wizard.

Properties

DesiredSaveLocation

The desired save location.

FilesToCopy

A list of relative paths of files to import into the pacz. Combining these with Phoenix.BuilderUIClient.UserFriendlyBuilderSessionInitialization.FilesToCopyBaseDir should yield the full paths to the actual files to copy. No relative paths in this list should traverse up a directory. This field is only meaningful if Phoenix.BuilderUIClient.UserFriendlyBuilderSessionInitialization.Mode is Phoenix.BuilderUIClient.UserFriendlyBuilderSessionInitialization.InitializationOption.IMPORT_FILES. Otherwise, it may be null, and should be ignored.

FilesToCopyBaseDir

The base directory for Phoenix.BuilderUIClient.UserFriendlyBuilderSessionInitialization.FilesToCopy. Combining this with Phoenix.BuilderUIClient.UserFriendlyBuilderSessionInitialization.FilesToCopy should yield the full paths to the actual files to copy. This field is only meaningful if Phoenix.BuilderUIClient.UserFriendlyBuilderSessionInitialization.Mode is Phoenix.BuilderUIClient.UserFriendlyBuilderSessionInitialization.InitializationOption.IMPORT_FILES. Otherwise, it may be null, and should be ignored.

FolderToConvert

The folder to convert to a Pacz. This field is only meaningful if Phoenix.BuilderUIClient.UserFriendlyBuilderSessionInitialization.Mode is Phoenix.BuilderUIClient.UserFriendlyBuilderSessionInitialization.InitializationOption.CONVERT_DIRECTORY. Otherwise, it may be null, and should be ignored.

Mode

The initialization mode.

SelectedName

The selected name of the pacz.

ShouldSaveExpanded

Whether or not the user requested an expanded Pacz (true for expanded, false for compressed).

Methods

BuilderUISessionFromPaczWriter(IHarnessBuilderUIClient, IPaczWriter, IRunnerSessionOptions)

A utility function to create a builder UI session from an existing Phoenix.PaczAPI.IPaczWriter.

CreateSession(UserFriendlyBuilderSessionInitialization, Guid, IHarnessBuilderUIClient, IPaczClient, IRunnerSessionOptions)

Create a new builder UI session.

PaczWriterFromDirectory(string, Guid, IPaczClient)

Create a new IPaczWriter by converting an existing directory.

PaczWriterFromFiles(IEnumerable, string, Guid, IPaczClient)

Create a new IPaczWriter by importing a list of files.

PromptUser(string, string, DelegateCommandAsync)

Connect with Ansys