ChangeProperty (Schematic Editor and Layout Editor)

Changes properties using the ChangeProperty command. This command can be executed by oEditor to change editor properties, by oDesign to change design-level properties, and by oProject to change project-level properties. It supports creation, editing, and deletion of properties. In HFSS and Maxwell, only Variable and Separator properties can be deleted.

Note: The ChangeProperty command supports multiple tab targets such as DesignTab, ComponentTab, and others. Property names and fields vary depending on the tab context.

Use the script recording feature to edit a property and view the resulting script entry, or use GetPropertyValue to inspect the expected format.

UI Access None
Parameters
Name Type Description
<PropTabArray> Array Structured array containing tab-level property changes. See detailed structure below.
Return Value None

 

Python Syntax

ChangeProperty(["Name:AllTabs", <PropTabArray>, <PropTabArray>, ...])

Python Example 
oEditor.ChangeProperty([
"NAME:AllTabs",
...PropTabArray entries...
])

 

Property Array Structure

The following structure defines the nested arrays and parameters used in ChangeProperty. Each array must follow the specified order and naming convention.

["Name:<PropTab>",

<PropServersArray>,

<NewPropsArray>,

<ChangedPropsArray>,

<DeletedPropsArray>]

<PropServersArray>

["Name:PropServers", <PropServer>, <PropServer>, ...]

<NewPropsArray>

["Name:NewProps", <PropDataArray>, <PropDataArray>, ...]

<ChangedPropsArray>

["Name:ChangedProps", <PropDataArray>, <PropDataArray>, ...]

<DeletedPropsArray>

["Name:DeletedProps", <PropName>, <PropName>, ...]

<PropDataArray>

["NAME:<PropName>",

"PropType:=", <PropType>,

"NewName:=", <string>,

"Description:=", <string>,

"NewRowPosition:=", <int>,

"ReadOnly:=", <bool>,

"Hidden:=", <bool>,

<PropTypeSpecificArgs>]

<PropType>

Type: string

Identifies the type of property when a new property is added. In HFSS and Maxwell, only separator properties and variable properties can be added.

"SeparatorProp"

"VariableProp"

"TextProp"

"NumberProp"

"ValueProp"

"CheckboxProp"

"MenuProp"

"PointProp"

"VPointProp"

"V3DPointProp"

"ButtonProp"

NewName

Specify the new name of a property if the property’s name is being edited. In HFSS and Maxwell, the name can only be changed for separators and variables.

Description

Specify a description of the property. In HFSS and Maxwell, the description can only be changed for separators and variables.

NewRowPosition

Used to reorder rows in the Property dialog box.

In HFSS, this only applies to the Project > Project Variables panel and the HFSS > DesignProperties panel.

In Maxwell, this only applies to the Project > Project Variables panel and the Maxwell3D > DesignProperties, Maxwell2D > Design Properties, or RMxprt > Design Properties panels. Specify the new zero-based row index of the variable or separator.

ReadOnly

Used to mark a property as "read only" so it cannot be modified. In HFSS and Maxwell, this flag can only be set for variables and separators.

Hidden

Used to hide a property so it cannot be viewed outside of the Property dialog box. In HFSS and Maxwell, this flag can only be set for variables and separators.

<PropTypeSpecificArgs>

SeparatorProp: no arguments

TextProp: "Value:=", <string>

NumberProp: "Value:=", <double>

ValueProp: "Value:=", <value>

CheckboxProp: "Value:=", <bool>

MenuProp: "Value:=", <string>

PointProp: "X:=", <double>, "Y:=", <double>

VPointProp: "X:=", <value>, "Y:=", <value>

V3DPointProp: "X:=", <value>, "Y:=", <value>, "Z:=", <value>

Material Button: "Material:=", <string>

Color Button: "R:=", <int>, "G:=", <int>, "B:=", <int>

Transparency Button: "Value:=", <double>

<PropTypeSpecificArgs> for VariableProps

Syntax:

"Value:=", <value>, <OptimizationFlagsArray>, <TuningFlagsArray>, <SensitivityFlagsArray>, <StatisticsFlagsArray>

Parameters:

<OptimizationFlagsArray>

["NAME:Optimization",

"Included:=", <bool>,

"Min:=", <value>,

"Max:=", <value>]

<TuningFlagsArray>

["NAME:Tuning",

"Included:=", <bool>,

"Step:=", <value>,

"Min:=", <value>,

"Max:=", <value>]

<SensitivityFlagsArray>

["NAME:Sensitivity",

"Included:=", <bool>,

"Min:=", <value>,

"Max:=", <value>,

"IDisp:=", <value>]

<StatisticsFlagsArray>

["NAME:Statistical",

"Included:=", <bool>,

"Dist:=", <Distribution>,

"StdD:=", <value>,

"Min:=", <value>,

"Max:=", <value>,

"Tol:=", <string>]

<Distribution>

Type: string

Value should be "Gaussian" or "Uniform"

StdD

Standard deviation.

Min

Low cut-off for the distribution.

Max

High cut-off for the distribution.

Tol

Tolerance for uniform distributions. Format is "<int>%". Example: "20%".