COMSOL 6.4 - General Properties

General Properties

The following table lists properties that are available for several different user interface components, including form objects. In the table below, a user interface component is referred to as an object.


Property	Value	Default	Description
background	String	default	The background color for the corresponding user interface element.
enabled	true \| false	true	If the value is true, the corresponding object is enabled in the user interface, which means that the user can interact with the object.
font	String	default	The font family name. The special value default means that the font to use is determined by the parent object, which is the corresponding setting in the Settings window of the Forms node.
fontbold	true \| false	false	If true the font uses boldface style.
fontitalic	true \| false	false	If true the font uses italic style.
fontunderline	true \| false	false	If true the font uses underline style.
fontsize	String	-1	The font size in points. The special value -1 represents the default size, which means that the size is taken from the parent object (the Forms node) or from the system default size if no parent object defines the size.
foreground	String	default	The foreground color for the corresponding user interface element.
visible	true \| false	true	If the value is true, the corresponding object is visible in the user interface.

A foreground or background color property is represented by a string value. The available colors are: black, blue, cyan, gray, green, magenta, red, white, and yellow, or a custom color may also be defined. The special value default means that the color is taken from the parent object. Depending on the parent type, this could mean that default is or , referring to the corresponding setting in the window in the Form Editor. An arbitrary RGB color can be represented by a string of the form rgb(red,green,blue) where red, green, and blue are integers between 0 and 255. Color properties can also be manipulated using the getColor and setColor methods to directly access the red, green, and blue color components. If a color property has the value default, it does not have red, green, and blue values. In this case, the getColor method returns the array [0,0,0].

Example Code

The following example reads the current background color for a form, makes the color darker, and applies the modified color to the same form.

int[] rgb = app.form("form1").getColor("background");

for (int i = 0; i < 3; i++)

rgb[i] /= 2;

app.form("form1").setColor("background", rgb[0], rgb[1], rgb[2]);

The following line of code sets the background color to black:

app.form("form1").set("background", "black");

The following line of code sets the background color to default which in the case of the background color property corresponds to the Form Editor setting .

app.form("form1").set("background", "default");

The following line of code sets the background color to the RGB values 125, 45, and 43.

app.form("form1").set("background", "rgb(125,45,43)");