CFML Language Reference
Chapter 2 :  ColdFusion Functions

GetBaseTagData

Returns an object that contains data (variables, scopes, etc.) from a specified ancestor tag. By default the closest ancestor is returned. If there is no ancestor by the specified name, or if the ancestor does not expose any data (for example, CFIF), an exception will be thrown.

See also GetBaseTagList.

Syntax

GetBaseTagData(tagname [, instancenumber ] )

tagname

Required. Specifies the ancestor tag name for which the function returns data.

instancenumber

Optional. Specifies the number of ancestor levels to jump before returning data. The default is 1.

Example

<!--- This example illustrates usage of the GetBaseTagData
      function. This is 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 out the tag's execution mode --->
        Located inside the 
        <CFIF tagData.thisTag.executionMode neq 'inactive'>
            template
        <CFELSE>
            BODY
        </CFIF>
...

Copyright © 1999, Allaire Corporation. All rights reserved.