Description Property

General info

Label

Description

Description

Additional information.

Data type

String

Type

Regular

Code

732

Symbolic name

MODEL_PROP_DESCRIPTION

Lua access code

syslib.model.properties.Description

Available since

1.0

Parent properties

ExternalLinks

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.

Capabilities

Name Description
TranslationTable The user will be able to provide a translation list for the content of this property, which will be reflected on User Interfaces

Examples

Read from or write to the Description property.

  • Lua

  • C#

-- Read from the Description
syslib.getvalue("<OBJECT FULL PATH>.ExternalLinks.Description")

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