Adobe ColdFusion 8

GetBaseTagData

Description

Used within a custom tag. Finds calling (ancestor) tag by name and accesses its data.

Returns

An object that contains data (variables, scopes, and so on) from an ancestor tag. If there is no ancestor by the specified name, or if the ancestor does not expose data (for example, cfif), an exception is thrown.

Category

Other functions

Function syntax

GetBaseTagData(tagname [, instancenumber ])

See also

GetBaseTagList; "High-level data exchange" in the ColdFusion Developer's Guide

Parameters

Parameter

Description
tagname

(Required) Ancestor tag name for which to return data
instancenumber

(Optional) Number of ancestor levels to jump before returning data. The default value is 1 (closest ancestor).

Example

<!--- This example shows the use of GetBaseTagData 
    function. Typically used in custom tags.--->
...
<cfif trim(inCustomTag) neq "">
        <cfoutput>
            Running in the context of a custom
            tag named #inCustomTag#.<p>
        </cfoutput>
        <!--- Get the tag instance data --->
        <cfset tagData = GetBaseTagData(inCustomTag)>
        <!--- Find the tag's execution mode --->
        Located inside the 
        <cfif tagData.thisTag.executionMode neq 'inactive'>
            template
        <cfelse>
            BODY
        </cfif>