SignedWrite()

Attribute

This is the name of the attribute to be updated and is a string data type.

Can be a constant string, a reference, or an expression.

Supports bound and nested bound references.

For detailed examples of Attribute parameter uses, see the topic Examples of Using the Attribute Parameter in the SignedWrite() Function under "Managing Graphics" in the Creating and Managing Industrial Graphics User Guide.

Example 1:

"UserDefined_001.temp"

Example 2:

"Pump15" + ".valve4"

Example 3:

With UDO_7 containing two string attributes, namestrA and namestrB set to the values "Tank1" and "Tank5" respectively, the following script writes to Tank1.Level or Tank5.Level according to whether strselect is "A" or "B":

Dim strselect As String;

Dim x As Indirect;

{ logic to set strselect to "A" or "B" }

x.BindTo ("UDO_7.namestr" + strselect);

SignedWrite(x + ".Level", 243, "Set " + x + " Level", true, 0, null);

Value

This is the value to be written. Data type is object. The valid range for value must match the data type of the attribute being updated.

Value can be a constant value, a reference, an expression, or NULL if nothing is to be entered.

ReasonDescription

This is text that explains the purpose of the target attribute and the impact of changing it.

Data type is string with a maximum length is 256 characters. It can be a constant string, a reference, or an expression.

ReasonDescription is passed to the indicated Attribute as part of the write operation. The object also includes the user’s write comment, if any. A Field Attribute description is used for the ReasonDescription parameter only if the attribute is a Field Attribute and it has a description (is not null). Otherwise, the Short Description for the corresponding ApplicationObject is used for the ReasonDescription parameter.

Comment_is _Editable

This parameter indicates whether a user can edit the write comment.

Data type is Boolean.

If set to True: The comment text box is enabled with exceptions.

• If Comment_Is_Editable is true and if the Comment_ Enforcement parameter is PredefinedOnly, the comment text box is disabled. At run time, the user can only select a comment from the predefined comment list.

• If the Comment_ Enforcement parameter is not PredefinedOnly, the comment list and box are enabled. You can select a comment from the comment list and modify it in the comment box.

• If the predefined list is empty, the comment list is not shown in the dialog box.

  If set to False: The predefined comment list does not appear in the Secured Write or Verified Write dialog boxes. The editable comment text box is disabled.

Comment_Enforcement

This parameter is of data type Enum, with the following value options:

0 = Optional
The run-time user can enter a comment or leave it blank.

1 = Mandatory
The run-time user must add a comment, either by selecting from the comment list or by entering a comment in the comment box.

2 = PredefinedOnly
The run-time user can select a comment from the comment list only. The comment text box is disabled.

Predefined_Comment_List

An array of strings that can be used as predefined comments.

Data type is string. A maximum of 20 comments are allowed, each with a maximum of 200 characters.

• The array can be empty (number of elements is 0).

• Can be a constant, a reference, an expression, or NULL if empty. Can reference an attribute that contains an array of strings.

• If no predefined comment is entered, the predefined comment list is disabled at run time.

• If Comment_Is_Editable is False, the predefined comment is still placed in the editable comment text box, but the user cannot modify it at run time.