<symbol> Element

This element defines the HMI symbol instance to be created on the HMI page defined by the parent <page> element or on the symbol group defined by the parent <group> element. The creation of the HMI symbol instance is triggered by an IEC code element (for example, FB instance, program instance, etc.) defined by the descendant <on...> element such as <onfunctionblock>.

The child element <symbolstyle> is used to assign style definitions referenced by the content of the element to the created HMI symbol.

Parent elements: <page>, <group>, <symbolset>

Attributes:

Attribute Description Type / Required

id Unique identifier that defines the HMI symbol name as set in the COMPONENTS under the 'HMI' category for which a symbol instance is to be created.
The id value is used as object ID in the properties window of the HMI symbol if the optional attribute displayname is not used or empty . The value is also used as name of the HMI symbol instance. Type: string
Required: yes

displayname Name of the HMI symbol instance. Placeholders enclosed in @ can be used.
The name is used as object ID in the properties window of the HMI symbol. If the attribute is not used or empty, the id is used as name. Type: string
Required: no

library Defines the HMI library added to the PLCnext Engineer project that contains the HMI symbol. Type: string
Required: no

comment Defines the comment of the symbol instance. Placeholders enclosed in @ can be used. Type: string
Required: no

issymbolset Specifies whether this symbol is replaced by the symbols/symbol groups of the <symbolset> element referenced with the corresponding id. Type: boolean true or false (default)
Required: no

unique Specifies whether the HMI symbol instance should be created once or as many times the IEC code element exists that triggers the creation.
If set to "true", the symbol instance is created once, even if the triggering IEC code element exists two or more times in the project. Type: boolean true or false (default)
Required: no

Attribute	Description	Type / Required
id	Unique identifier that defines the HMI symbol name as set in the COMPONENTS under the 'HMI' category for which a symbol instance is to be created. The id value is used as object ID in the properties window of the HMI symbol if the optional attribute displayname is not used or empty . The value is also used as name of the HMI symbol instance.	Type: string Required: yes
displayname	Name of the HMI symbol instance. Placeholders enclosed in @ can be used. The name is used as object ID in the properties window of the HMI symbol. If the attribute is not used or empty, the id is used as name.	Type: string Required: no
library	Defines the HMI library added to the PLCnext Engineer project that contains the HMI symbol.	Type: string Required: no
comment	Defines the comment of the symbol instance. Placeholders enclosed in @ can be used.	Type: string Required: no
issymbolset	Specifies whether this symbol is replaced by the symbols/symbol groups of the <symbolset> element referenced with the corresponding id.	Type: boolean true or false (default) Required: no
unique	Specifies whether the HMI symbol instance should be created once or as many times the IEC code element exists that triggers the creation. If set to "true", the symbol instance is created once, even if the triggering IEC code element exists two or more times in the project.	Type: boolean true or false (default) Required: no