ADX Property Collection type object

In AskiaScript, the ADX Property Collection type object represents the collection of the properties exposed by an ADX. This object is accessible through the CurrentADC.Properties or CurrentADP.Properties object.

Returns an ADX Property.

See also:

• ADX
• ADX Property
• <properties>
• <property>

In this topic:

• Accessor:
  • [index]

• Properties:
  • Count

• Methods:
  • ToString()
  • TypeOf()

Accessor

[index]

Returns the ADX Property at the specified index.

Parameters

• index [Required] {Number}: Index (based 1) of the ADX Property.

Examples

CurrentADC.Properties[1] ' => <ADCProperty::tickColor>

CurrentADC.Properties[1].Name ' => "Tick Color"

CurrentADP.Properties[1].Name ' => "Page title"

↑ Top of page ↑

Properties

Count

Returns the count of the properties within the collection.

Returns a Number.

Example

CurrentADC.Properties.Count ' => 2

↑ Top of page ↑

Methods

ToString()

Returns a string which represents the collection of ADX properties in JSON notation.

Returns a String.

Examples

CurrentADC.Properties.ToString() ' => [
   {
       "id"     : "tickColor",
       "type" : "color",
       "value" : "0,255,0" 
   },
   {
      "id"     : "radioButtonImage",
      "type" : "image",
      "value" : "../Resources/[SurveyName]/MyImage.png" 
   },
   {
      "id"    : "tickAlign",
      "type" : "string",
      "value" : "right" 
   },
   {
      "id"    : "maxValue",
      "type" : "number",
      "value" : 12
   },
   {
      "id"    : "useImage",
      "type" : "boolean",
      "value"  : true
   },
   {
      "id"    : "questionOther",
      "type" : "question",
      "value" : {
            "shortcut" : "other", 
            "shortCaption" : "Other brand", 
            "longCaption"  : "Please specify:", 
            "type"       :  "open" 
      }
  }
]

↑ Top of page ↑

TypeOf()

Always returns "adx-properties".

Returns a String.

Examples

CurrentADC.Properties.TypeOf() ' => "adx-properties"

CurrentADP.Properties.TypeOf() ' => "adx-properties"

↑ Top of page ↑