Extends

• ArchBaseValueBasic

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchValueString'.

readonly isArchValueString :boolean

Returns true indicating that this is an ArchValueString instance.

readonly isCollection :boolean

Returns false indicating that this value is a singleton value and not a collection value.

Inherited From:

• ArchBaseValueSingleton#isCollection

readonly valueText :string

Returns a JavaScript string representing the value specified on this ArchBaseValueSingleton instance. If this value is an expression, it returns the expression text. If this value is a variable, it returns the variable text. If this value is a literal, it will return a string that represents the value. Overall this property is meant to be a quick and easy way to look at a "value" string but it is not meant to be some kind of fully inclusive description of this ArchBaseValueSingleton instance overall. For most values that inherit from this class, it's pretty obvious what to expect as the returned string but there are a couple worth mentioning:

ArchValueCurrency       - a string formatted with '<amount>|<code>" where code is an ISO 4217 string.
ArchValueDate           - a string formatted as 'YYYY-MM-DD' where YYYY is 4 digit year, MM is 2 digit month and DD is two digit day.
ArchValueDateTime       - an ISO 8601 formatted string.
ArchValueDuration       - an XSD formatted duration string.
ArchValueTime           - a string formatted as 'hh:mm:ss' where hh is 2 digit hour, mm is 2 digit minute and ss is 2 digit second.

While we don't guarantee it in Scripting because this isn't the same runtime function evaluation engine that flows use, when accessing this property on a singleton value will be very similar to calling the ToString function in expressions at runtime.

Inherited From:

• ArchBaseValueSingleton#valueText

Methods

setExpressionNotSet()

This method sets the expression of NOT_SET on this value.

Inherited From:

• ArchBaseValueSingleton#setExpressionNotSet

setExpressionString(stringVal)

Sets the supplied JavaScript string as expression text. This text will be escaped properly for use in an expression. So if you were to pass in 'He said, "boo"', the resulting expression that is generated here will be "He said, "boo""

Parameters:

Name	Type	Description
stringVal	string	the text to set on this string value. If you pass in undefined or null, a string of "" will be set as the expression text value.

setLiteralString(stringVal)

Sets the literal text for this value.

Parameters:

Name	Type	Description
stringVal	string	the text to set on this string value. If you pass in undefined or null, a blank string will be set as the literal value.