UnHighlight

Summary

Use this function to remove a highlighted asset if a Highlight call was made to it earlier. Child assets will also be unhighlighted by default, however this feature is optional (see AndChildren).

Parameters

Target

Type: Text Default: None

Specifies the name or ARDI ID of the asset you wish to unhighlight. If using an asset ID, begin the target with the '#' character.

AndChildren

Type: Boolean Default: True

This parameter specifies whether or not to unhighlight all of the child assets. If true, then the script will also remove highlights from all child assets which are parented to the target asset.

See Also

Examples

<unhighlight Target="SomeObject" />
This code will remove a highlight from an asset named SomeObject and also all of its child assets.
<unhighlight Target="SomeObject" AndChildren="false"/>
This code will remove a highlight from an asset named SomeObject only, leaving any highlighted child assets still highlighted.