CustomPropertyName Property

General info

Label

Property Name

Description

A custom property name which can be used programmatically.

Data type

String

Type

Regular

Code

1246

Symbolic name

MODEL_PROP_CUSTOMPROPERTYNAME

Lua access code

syslib.model.properties.CustomPropertyName

Available since

1.0

Parent properties

CustomProperties

Attributes

Name Tooltip
PROP_CONFIGURABLE The property is configurable and can be changed with DataStudio and the various inmation APIs.
PROP_VISIBLE The property is visible in DataStudio and can be read by the inmation APIs.

Examples

Read from or write to the CustomPropertyName property.

  • Lua

  • C#

-- Read from the CustomPropertyName
syslib.getvalue("<OBJECT FULL PATH>.CustomOptions.CustomProperties.CustomPropertyName")

-- Write to the CustomPropertyName
syslib.setvalue("<OBJECT FULL PATH>.CustomOptions.CustomProperties.CustomPropertyName", "new value")
TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

// Read from the CustomPropertyName
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.CustomOptions.CustomProperties.CustomPropertyName"));
// Write to the CustomPropertyName
Result result = sli.WriteValue(sc, new WriteItem("new value", "<OBJECT FULL PATH>.CustomOptions.CustomProperties.CustomPropertyName"));