Custom Properties ($prop)

Document created by DPM Admin Employee on Jul 21, 2017Last modified by Trishala Kalal on Aug 14, 2017
Version 2Show Document
  • View in full screen mode

Provides an easy shortcut for accessing the Custom Properties in the Composition without having to traverse the object model.

CustomProperty Methods

string value(string itemType, string propertyPath)

Returns the value of the specified Custom Property.

The "itemType" parameter value indicates the type of item containing the property (not case sensitive):

      • "Composition"
      • "Band"
      • "Track"
      • "MessageClip"
      • "Message"
      • "Browser Action"
      • "Target"
      • "Destination"

The "propertyPath" parameter contains a property path as specified for In Situ Substitution Expressions:

void set(string itemType, string propertyPath, var newValue)

Sets a new value into the specified Custom Property.

The "itemType" and "propertyPath" parameters are the same as for the "value" method, above.


The "newValue" parameter is the new value for the property.  It can be null.  (The "undefined" value is treated as null).