Data Type Specific Members

Navigation:  Widget Designer > Script Language > Object and Member Notation (dot syntax) >

Data Type Specific Members

prev main next

Navigation:  Widget Designer > Script Language > Object and Member Notation (dot syntax) >

Data Type Specific Members

prev main next

Loading...

Show/Hide hidden text

This chapter gives an overview of the members available per data type, e.g. a string. As explained in the topic"Object and Member Notation (dot syntax)", all kinds of objects can be addressed in the scripting language by using their members which set (or return if applicable) properties or methods of that object. Please refer to the chapter "Script Language" for more details about scripting in general.

Each data type in Widget Designer, String, Integer, Double, Boolean, Date, List, Color and JSON, has its own, specific members. Those Members can be used for conversion, editing and information. Members that return a result can even be used with further members.

Please note that these methods only return values, they do not change the object they refer to themselves. One exception here are some members of the color and JSON data types.
The data type of the return value is highlighted in the table below.

Example:
  var x = "Hello World!"
  var y = x.Contains("llo").ToInteger
DebugMessage(y)

 

The Debug Logger shows "1", as the Boolean value (true) returned by the Contains-member was additionally converted to an integer value (1). The variable "x" keeps its value "Hello World!".

 

Even object properties can be used like this:

"var x = Fader1.Value.Round(2)" assigns the value of Fader1, rounded to two digits, to the local variable "x".

Below, you can find all Boolean, Color, Date, Double, Integer, Json, List, Object and String members. As the members "Type" and "Locked" are available for all data types, they are mentioned as "Variable.Type" and Variable.Locked, respectively.

One special data type is JSON, it enables you to store large sets of data and edit and retrieve this information for other purposes. The "location" of a JSON element is the key (e.g. "arr"), or in case of nested maps the path expressed with a dot syntax (e.g."map.b"). If you are interested in the use of JSON objects, please refer to the chapter Using JSON.

The object data type is always applied when it is not possible to determine the specific type of an object beforehand, e.g. for list elements, local variables without a value assigned or for the return value of a function.

hmtoggle_arrow1Boolean.Not
hmtoggle_arrow1Boolean.ToInteger
hmtoggle_arrow1Boolean.ToString
hmtoggle_arrow1Color.A
hmtoggle_arrow1Color.B
hmtoggle_arrow1Color.G
hmtoggle_arrow1Color.R
hmtoggle_arrow1Color.SetRGB
hmtoggle_arrow1Color.SetRGBA
hmtoggle_arrow1Color.ToHex
hmtoggle_arrow1Date.AddDays
hmtoggle_arrow1Date.AddHours
hmtoggle_arrow1Date.AddMilliseconds
hmtoggle_arrow1Date.AddMinutes
hmtoggle_arrow1Date.AddMonths
hmtoggle_arrow1Date.AddSeconds
hmtoggle_arrow1Date.AddYears
hmtoggle_arrow1Date.Day
hmtoggle_arrow1Date.DayOfWeek
hmtoggle_arrow1Date.DayOfYear
hmtoggle_arrow1Date.DiffDays
hmtoggle_arrow1Date.DiffHours
hmtoggle_arrow1Date.DiffMilliseconds
hmtoggle_arrow1Date.DiffMinutes
hmtoggle_arrow1Date.DiffSeconds
hmtoggle_arrow1Date.Format
hmtoggle_arrow1Date.Hour
hmtoggle_arrow1Date.Millisecond
hmtoggle_arrow1Date.Minute
hmtoggle_arrow1Date.Month
hmtoggle_arrow1Date.Second
hmtoggle_arrow1Date.ToString
hmtoggle_arrow1Date.Year
hmtoggle_arrow1Double.Ceiling
hmtoggle_arrow1Double.Floor
hmtoggle_arrow1Double.Round
hmtoggle_arrow1Double.ToInteger
hmtoggle_arrow1Double.ToString
hmtoggle_arrow1Integer.ToString
hmtoggle_arrow1Json.Add
hmtoggle_arrow1Json.Clear
hmtoggle_arrow1Json.Copy
hmtoggle_arrow1Json.Count
hmtoggle_arrow1Json.Get
hmtoggle_arrow1Json.GetDate
hmtoggle_arrow1Json.GetDouble
hmtoggle_arrow1Json.GetInteger
hmtoggle_arrow1Json.GetList
hmtoggle_arrow1Json.GetString
hmtoggle_arrow1Json.Keys
hmtoggle_arrow1Json.Remove
hmtoggle_arrow1Json.Set
hmtoggle_arrow1Json.ToFile
hmtoggle_arrow1Json.ToPrettyString
hmtoggle_arrow1Json.ToString
hmtoggle_arrow1Json.Values
hmtoggle_arrow1List.Avg
hmtoggle_arrow1List.Copy
hmtoggle_arrow1List.Count
hmtoggle_arrow1List.DecodeBytes
hmtoggle_arrow1List.Distinct
hmtoggle_arrow1List.IndexOf
hmtoggle_arrow1List.Join
hmtoggle_arrow1List.Max
hmtoggle_arrow1List.Min
hmtoggle_arrow1List.Remove
hmtoggle_arrow1List.Sort
hmtoggle_arrow1List.WhereRegex
hmtoggle_arrow1Object.ToBoolean
hmtoggle_arrow1Object.ToColor
hmtoggle_arrow1Object.ToDate
hmtoggle_arrow1Object.ToDouble
hmtoggle_arrow1Object.ToInteger
hmtoggle_arrow1Object.ToJson
hmtoggle_arrow1Object.ToList
hmtoggle_arrow1Object.ToString
hmtoggle_arrow1String.Contains
hmtoggle_arrow1String.EncodeBytes
hmtoggle_arrow1String.EndsWith
hmtoggle_arrow1String.Format
hmtoggle_arrow1String.IsEmpty
hmtoggle_arrow1String.IsMatch
hmtoggle_arrow1String.IsNumeric
hmtoggle_arrow1String.Left
hmtoggle_arrow1String.Length
hmtoggle_arrow1String.PadLeft
hmtoggle_arrow1String.PadRight
hmtoggle_arrow1String.Replace
hmtoggle_arrow1String.Right
hmtoggle_arrow1String.Split
hmtoggle_arrow1String.StartsWith
hmtoggle_arrow1String.SubString
hmtoggle_arrow1String.ToCamelCase
hmtoggle_arrow1String.ToCharArray
hmtoggle_arrow1String.ToColor
hmtoggle_arrow1String.ToDate
hmtoggle_arrow1String.ToDouble
hmtoggle_arrow1String.ToInteger
hmtoggle_arrow1String.ToJson
hmtoggle_arrow1String.ToLower
hmtoggle_arrow1String.ToSnakeCase
hmtoggle_arrow1String.ToUpper
hmtoggle_arrow1String.Trim
hmtoggle_arrow1String.TrimEnd
hmtoggle_arrow1String.TrimStart
hmtoggle_arrow1String.Unescape
hmtoggle_arrow1Variable.Locked
hmtoggle_arrow1Variable.Type