Introspection: Getting Information About Components - MACROMEDIA COLDFUSION MX 61-DEVELOPING COLDFUSION MX Develop Manual

Introspection: getting information about components

ColdFusion provides several ways to get information about components:
•
Requesting a component page from the browser
•
Using the ColdFusion component browser
•
Using the Dreamweaver component browser
•
Using the
GetMetaData
Development teams can use the descriptions as up-to-date API reference information.
Note: For information about how to include documentation in CFCs for display using introspection,
see "Documenting CFCs" on page
Requesting a component page from the browser
When you access a CFC directly with a web browser without specifying a component method,
the following chain of events occurs:
The request is redirected to CFCExplorer.cfc, which is located in the
1
[webroot]\CFIDE\componentutils directory.
The CFCExplorer component prompts users for the ColdFusion RDS or Administrator
2
password, if necessary.
The CFCExplorer renders an HTML description and returns it to the browser.
3
The resulting display looks like the following example:
tests.cfcs.arithCFC
Component arithCFC (Arithmetic Functions)
Miscellaneous functions for doing arithmetic
hierarchy:
path:
properties:
methods:
* - private method
Property
Prop1 (display
name here)
function
240.
WEB-INF.cftags.component
tests.cfcs.arithCFC
C:\cfmx\wwwroot\tests\cfcs\arithCFC.cfc
something
add, multiply*
Hint
I just need this for an example
Type Req. Implemented In
any arithCFC
Using ColdFusion components
Default
Value
-
233