Skip to main content

Component Plug-In SDK 2026 R1

Class VariableTreeProperties

Last update: 19.06.2026

Namespace: Phoenix.ComponentPlugInSDK.Models
Assembly: Phoenix.ComponentPlugInSDK.dll

This class contains Properties that define the options for the VariableTree and variable editing options.

public class VariableTreeProperties

Inheritance

object ← VariableTreeProperties

Inherited Members

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

Constructors

VariableTreeProperties(string, bool, bool, string, string, string, PickUserDataActionAsync)

Constructor.

Properties

CanAddRemove

If the UI controls can be used to add and remove variables. If this is false, the user will not be able to click to add or delete to remove variables from the tree. A false value will also remove access to the Text Based Script Editor.

ComponentName

Name to display at the root of the VariableTree.

HasNamedVariables

If the variables use a named variable property. This allows a mapping of the CAM variable name to a name that may be different to use in the Builder.

NamedVariableDisplayName

The display name of named variables.

NamedVariablePickAction

The action to invoke when the user clicks the button to the right of the user data field. If this parameter is null, the button will not be visible.

NamedVariablePickText

The text to display on the button that lets the user pick the user data. Defaults to "Pick" if this parameter is null. Note that the button will not be visible unless Phoenix.ComponentPlugInSDK.Models.VariableTreeProperties.NamedVariablePickAction is non-null.

NamedVariableToken

The token to use for named variables in the Text Based Variable Editor. This should contain only Alphanumeric characters and underscores.

Connect with Ansys