CustomPropertyValue Property

General info

Label

Property Value

Description

The value of the custom property which can be read and written programmatically.

Data type

String

Type

Regular

Code

1247

Symbolic name

MODEL_PROP_CUSTOMPROPERTYVALUE

Lua access code

syslib.model.properties.CustomPropertyValue

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 CustomPropertyValue property.

  • Lua

  • C#

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

-- Write to the CustomPropertyValue
syslib.setvalue("<OBJECT FULL PATH>.CustomOptions.CustomProperties.CustomPropertyValue", "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 CustomPropertyValue
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.CustomOptions.CustomProperties.CustomPropertyValue"));
// Write to the CustomPropertyValue
Result result = sli.WriteValue(sc, new WriteItem("new value", "<OBJECT FULL PATH>.CustomOptions.CustomProperties.CustomPropertyValue"));