tagdictionary-ScopedTag
scoped smart tag is available in the tagdictionary palette under the Smart Tags folder. The scoped smart tag can be applied to a baja:Component object.
Figure 29. Scoped smart tag
When applied to a component, either directly or implied by a tag rule, the smart tag searches the component's ancestors looking for a tag with the "search ID". This tag is called the matching tag and the ancestor on which it is found is called "the matching ancestor".
Without specifying anything in the scoped tag's frozen properties, the basic behavior of this smart tag is as follows:
- The search ID will be the same as scoped tag itself.
- If found, a tag with the scoped tag ID will be added to the component. The value of the added tag will be copied from the matching tag. If the matching tag is a marker tag, the added tag will be a marker tag. If the matching tag is a value tag, the added tag will have the same value as the matching tag.
This basic behavior can be modified by adding a TagInfo to the scoped tag's frozen properties. Usage is optional and each can contain only a single tag. Only the ID of the TagInfo added to these properties is of consequence and its type is ignored.
- Search Tag List property
If a
TagInfois added toSearch Tag Listproperty, the ID of thisTagInfowill be used as the search ID instead of the ID of the scoped tag. If a matching tag is found, the tag added to the component will still have the same ID as the scoped tag. If this property is empty or theTagInfohas the same ID as the scoped tag, only direct tags will be considered when searching the component's ancestors. Otherwise, both direct and implied tags will be considered. - Out Of ScopeTag List property
If a
TagInfois added to theOut Of Scope Tag Listproperty, the ID of thisTagInfois called the "out-of-scope ID". The scoped tag will not be added to the component if the component itself, the matching ancestor, or any ancestors between the component and the matching ancestor have a tag with the out-of-scope ID. If the out-of-scope ID is the same as the scoped tag ID, only direct tags will be considered. Otherwise, both direct and implied tags will be considered. If the out-of-scope ID is the same as the scoped tag ID, the scoped tag will never be added to a component. - Value Source Tag List property
If a
TagInfois added to theValue Source Tag Listproperty, the ID of thisTagInfois called the "value-source ID". If a tag exists on the matching ancestor with the value-source ID, called the "value-source tag", the value of the added tag will be copied from that tag instead of the matching tag. If a value-source tag does not exist on the matching ancestor, the value of the added tag will be copied from the matching tag. If the value-source ID is the same as the scoped tag ID, only direct tags will be considered for the value-source tag. Otherwise, both direct and implied tags will be considered.For example, if the tag with the search ID is a double value tag set to 5.0, then a double value tag set to 5.0 with the scoped tag ID will be added to descendant components. If a
TagInfois added to theValueSourceTagListproperty, the value of the scoped tag added to a component will be copied from the direct or implied tag with the same ID as theValueSourceTagListTagInfo (the value source ID) on the matching ancestor. Only direct tags (and not implied tags) will be used if the ValueSourceTagList TagInfo has the same ID as the scoped tag. If the matching ancestor does not have a tag with the value source ID, the value of the scoped tag will be copied from the tag with the search ID.
In another example using the namespace of the custom dictionary is "c:". The Search Tag List is populated so c:stateRoot will be used as the search ID instead ofhs:geoState, which is the ID of the scoped tag. The Out Of Scope Tag List is empty. The Value Source Tag List is populated so the value-source ID is n:name. If a direct or implied tag with the ID c:stateRoot is found on an ancestor of a component, a hs:geoState tag will be added to that component with a value set to the n:name tag on the matching ancestor.
Figure 30. Example scoped tag: hs:geoState
