getItemViaPath Method

Given a path to an item in the Composition object hierarchy, returns the object in the hierarchy that represents that item.

The “pathType” parameter value specifies the “starting point” of the path, relative to this Switch. For Switchs it can be any of the following values (case is not significant):

  • “Composition”

The path is relative to the Composition as a whole. (Therefore, the path must start with the name of a Band.)

  • “Band”

The path is relative to this Switch’s parent Band.

  • “Track”

The path is relative to this Switch’s parent Track.

  • “MessageClip” or “Clip” (either one is accepted)

The path is relative to this Switch’s parent Clip.

  • “Chain”

The path is relative to the Chain that contains this item. If nested within multiple Chains, the path is relative to the lowest-level containing Chain (the Chain “nearest to” the item in terms of the parentage hierarchy).

  • “Group”

The path is relative to the Group that contains this item. If nested within multiple Groups, the path is relative to the lowest-level containing Group (the Group “nearest to” the item in terms of the parentage hierarchy).

  • “Transaction”

The path is relative to the Transaction that contains this item. If nested within multiple Transactions, the path is relative to the lowest-level containing Transaction (the Transaction “nearest to” the item in terms of the parentage hierarchy).

  • “If”

The path is relative to the If that contains this item. If nested within multiple Transactions, the path is relative to the lowest-level containing If (the If “nearest to” the item in terms of the parentage hierarchy).

  • “Switch”

The path is relative to the Switch that contains this item. If nested within multiple Switches, the path is relative to the lowest-level containing Switch (the Switch “nearest to” the item in terms of the parentage hierarchy). The “propertyPath” parameter contains a property path as specified for “In Situ Substitution Specifications”.

object getItemViaPath(string pathType, string path)