List of All Documentation Objects
In the following section all documentation objects are displayed, DA-C context to which they correspond, and the corresponding data retrieving script generated by the Wizard for them.
Project
DA-C context
- root folder in the Project Manager Logical View.
Data retrieval
DGML scriptGetProject (ProjectData) /* use ProjectData */
Retrieved data
TProject ProjectData See "TProject properties"
File: <file_name_string>
DA-C context
- file in the Project Explorer
- directory in the Project Explorer
- file in the Editor
- the pointer sits on the file name in the Editor ( include directive )Data retrieval
DGML scriptGetFile(FileData,<file_name_string>) /* use FileData */
Retrieved data
TFile FileData See "TFile properties"
All Project files
DA-C context
- the same as for File
- Root in EV or LV of the Project ExplorerData retrieval
DGML scriptGetAllFiles(FileDataCol)
for_each(FileData in FileDataCol)
/* use FileData */
end_forRetrieved data
TFile FileData See "TFile properties"
Directory: <directory_name_string>
DA-C context
- Directory in the Project Explorer
Data retrieval
DGML scriptGetDirectory(DirectoryData, <directory_name_string>) /* use DirectoryData */
Retrieved data
TDirectory DirectoryData See "TDirectory properties"
Directory Subtree: <directory_name_string>
DA-C context
- Directory in the Project Explorer
Data retrieval
DGML scriptGetDirectorySubtree(DirectoryDataCol, <directory_name_string>)
for_each(DirectoryData in DirectoryDataCol)
/* use DirectoryData */
end_forRetrieved data
TDirectory DirectoryData See "TDirectory properties"
<category> Messages
DA-C context
- the Message Logs
Data retrieval
DGML scriptGetMessages(MessageDataCol, <category_string>)
for_each(MessageData in MessagesDataCol)
/* use MessageData */
end_forRetrieved data
TMessage MessageData See "TMessage properties"
Function: <function_name_string>
DA-C context
- Function in LV of the Project Explorer
- the pointer in the editor or Browser sits on the function nameData retrieval
DGML scriptGetFunction(FunctionData, <function_name_string>, <file_name_string>) /* use FunctionData */
Retrieved data
TFunction FunctionData See "TFunction Structure"
Global Functions
DA-C context
- the pointer sits on the function name in the Browse Global Functions window.
Data retrieval
DGML scriptGetGlobalFunctions(FunctionDataCol)
for_each(FunctionData in FunctionDataCol)
/* use FunctionData */
end_forRetrieved data
TFunction FunctionData See "TFunction Structure"
Module Functions: <file_name_string>
DA-C context
- function in LV of the Project Manager
- the pointer sits on the function name in the editor or Browser.Data retrieval
DGML scriptGetModuleFunctions (FunctionDataCol, <file_name_string>)
for_each(FunctionData in FunctionDataCol)
/* use FunctionData */
end_forRetrieved data
TFunction FunctionData See "TFunction Structure"
Module Variables: <file_name_string>
DA-C context
- variable in LV
- the pointer sits on the variable name in the Editor.Data retrieval
DGML scriptGetModuleVariables (VariableDataCol, <file_name_string>)
for_each(VariableData in VariableDataCol)
/* use VariableData */
end_forRetrieved data
TSymbol VariableData See "TSymbol (Variable) properties"
Global Variables
DA-C context
- The Browse Global Variables window
Data retrieval
DGML scriptGetGlobalVariables(VariableDataCol)
for_each(VariableData in VariableDataCol)
/* use VariableData */
end_forRetrieved data
TSymbol VariableData See "TSymbol (Variable) properties"
Module Constants: <file_name_string>
DA-C context
- constant in LV of the Project Explorer
- the pointer sits on the constant name in the Editor.Data retrieval
DGML scriptGetModuleConstants (ConstantDataCol, <file_name_string>)
for_each(ConstantData in ConstantDataCol)
/* use ConstantData */
end_forRetrieved data
TSymbol ConstantData See "TSymbol (Variable) properties"
Global Constants
DA-C context
- The browse Global Constants window
Data retrieval
DGML scriptGetGlobalConstants(ConstantDataCol)
for_each(ConstantData in ConstantDataCol)
/* use ConstantData */
end_forRetrieved data
TSymbol ConstantData See "TSymbol (Constant) properties"
Module Types: <file_name_string>
DA-C context
- local type in LV of the Project Manager
- the pointer sits on the local type name in the Editor.Data retrieval
DGML scriptGetModuleTypes (TypeDataCol, <file_name_string>)for_each(TypeData in TypeDataCol)
/* use TypeData */
end_forRetrieved data
TSymbol TypeData See "TSymbol (Type) properties"
Global Types
DA-C context
- The Browse Global Types window
Data retrieval
DGML scriptGetGlobalTypes(TypeDataCol)
for_each(TypeData in TypeDataCol)
/* use TypeData */
end_forRetrieved data
TSymbol TypeData See "TSymbol (Type) properties"
Module Macros: <file_name_string>
DA-C context
- local macro in LV of the Project Manager
- the pointer sits on the local macro name in the Editor.Data retrieval
DGML scriptGetModuleMacros (MacroDataCol, <file_name_string>)
for_each(MacroData in MacroDataCol)
/* use MacroData */
end_forRetrieved data
TSymbol MacroData See "TSymbol (Macro) properties"
Global Macros
DA-C context
- The Browse Global Macros window.
Data retrieval
DGML scriptGetGlobalMacros(MacroDataCol)
for_each(MacroData in MacroDataCol)
/* use MacroData */
end_forRetrieved data
TSymbol MacroData See "TSymbol (Macro) properties"
Declarations of <symbol_name_string>
DA-C context
- The Browse Declarations window over a global or static (non-local) variable
Data retrieval
DGML scriptGetDeclarations(DeclarationDataCol, <symbol_name_string>, <module_path_string>)
for_each(DeclarationData in DecalarationDataCol)
/* use DeclarationData */
end_forRetrieved data
TBrowse DeclarationData See "TBrowse properties"
Uses of <symbol_name_string>
DA-C context
The Browse Uses window.( for a global or a static symbol)
Data retrieval
DGML scriptGetUses(UseDataCol, <symbol_name_string>, <module_path_string>)
for_each(UseData in UseDataCol)
/* use UseData */
end_forRetrieved data
TBrowse UseData See "TBrowse properties"
Uses of <symbol_name_string> from function <function_name_string>
DA-C context
The Browse Uses window (for a local symbol)
Data retrieval
DGML scriptGetUsesInFunction(UseDataCol, <symbol_name_string>, <function_name_string>, <module_path_string>)
for_each(UseData in UseDataCol)
/* use UseData */
end_forRetrieved data
TBrowse UseData See "TBrowse properties"
Assignments of <symbol_name_string>
DA-C context
The Browse Assignments window.( for a global or a static symbol)
Data retrieval
DGML scriptGetAssignments(AssignmentDataCol, <symbol_name_string>, <module_path_string>)
for_each(AssignmentData in AssignmentDataCol)
/* use AssignmentData */
end_forRetrieved data
TBrowse AssignmentData See "TBrowse properties"
Assignment of <symbol_name_string> from function <function_name_string>
DA-C context
The Browse Assignments window.( for a global or a static symbol)
Data retrieval
DGML scriptGetAssignmentsInFunction(AssignmentDataCol, <symbol_name_string>, <function_name_string>, <module_path_string>)
for_each(AssignmentData in AssignmentDataCol)
/* use AssignmentData */
end_forRetrieved data
TBrowse AssignmentData See "TBrowse properties"
Calls to <function_name_string>
DA-C context
The Browse CallsTo window.
Data retrieval
DGML scriptGetCallsTo(CallToDataCol, <function_name_string>, <module_path_string>)
for_each(CallToData in CallToDataCol)
/* use CallToData */
end_forRetrieved data
TBrowse CallToData See "TBrowse properties"
Calls Within <function_name_string>
DA-C context
The Browse CallsWithin window.
Data retrieval
DGML scriptGetCallsWithin(CallWithinDataCol, <function_name_string>, <module_path_string>)
for_each(CallWithinData in CallWithinDataCol) CallWithinData
/* print CallWithinData */
end_forRetrieved data
TBrowse CallWithinData See "TBrowse properties"
Uses Within <function_name_string>
DA-C context
The Browse UsesWithin window
Data retrieval
DGML scriptGetUsesWithin(UsesWithinData, <function_name_string>, <module_path_string>)
/* use UsesWithinData */Retrieved data
TUsesWithin UsesWithinData See "TUsesWithin properties"
Group: <group_name_string>
DA-C context
The group in the Graph
Data retrieval
DGML scriptGetGroup(GroupData, <group_name_string>) /* use GroupData */
Retrieved data
TGroup GroupData See "TGroup properties"
Group Tree: <group_name_string>
DA-C context
The group in the Graph
Data retrieval
DGML scriptGetGroupsTree(GroupDataCol, <group_name_string>)
for_each(GroupData in GroupDataCol)
/* use GroupData */
end_forRetrieved data
TGroup GroupData See "TGroup properties"
All Project Groups
DA-C context
The group in the Graph
Data retrieval
DGML scriptGetAllGroups(GroupDataCol)
for_each(GroupData in GroupDataCol)
/* use GroupData */
end_forRetrieved data
TGroup GroupData See "TGroup properties"
View: <view_name_string>
DA-C context
Graph over a specified view
Data retrieval
DGML scriptGetView(ViewData, <view_name_string>) /* use ViewData */
Retrieved data
TView ViewData See "TView properties"
View Tree: <view_name_string>
DA-C context
Graph over a specified view
Data retrieval
DGML scriptGetViewsTree(ViewDataCol, <view_name_string>)
for_each(ViewData in ViewDataCol)
/* use ViewData */
end_forRetrieved data
TView ViewData "TView properties"
All Project Views
DA-C context
Graph over a specified view
Data retrieval
DGML scriptGetAllViews(ViewDataCol)
for_each(ViewData in ViewDataCol)
/* use ViewData */
end_forRetrieved data
TView ViewData "TView properties"
Search for: <phrase_string>
DA-C context
The Find all occurrences of <phrase_string> Browser has focus
Data retrieval
DGML scriptSearch(SearchData, <phrase_string>, <object_name_string>, <options_string>)
/* use FoundData */Retrieved data
TSearch SearchData See "TSearch properties"
Flowchart of <function_name_string>
DA-C context
Flowchart
Data retrieval
DGML scriptGetFlowChart(FlowChartImage, <function_name_string>, <module_path_string> <options_string>) /* use FlowChartImage */
Retrieved data
image FlowChartImage See "The image Directive"
Call Graph of <function_name_string>
DA-C context
Call graph
Data retrieval
DGML scriptGetCallGraph(CallGraphImage, <function_name_string>, <module_path_string>, <used_view_string>, <options_string>) /* use CallGraphImage */
Retrieved data
image CallGraphImage See "The image Directive"
Type Graph of <type_name_string>
DA-C context
Type graph
Data retrieval
DGML scriptGetTypeGraph(TypeGraphImage, <type_name_string>, <module_path_string>, "TYPE", <options_string>) /* use TypeGraphImage */
Retrieved data
image TypeGraphImage See "The image Directive"
Mixed Type Graph of : <type_name_string>
DA-C context
Mixed Type graph
Data retrieval
DGML scriptGetTypeGraph(TypeGraphImage, <type_name_string>, <module_path_string>, "MIXED", <options_string>) /* use TypeGraphImage */
Retrieved data
image TypeGraphImage See "The image Directive"
Metrics Report For <object_name_string>
DA-C context
Metrics report
Data retrieval
DGML scriptGetMetricsReport(MetricsImage, <template_name_string>, <object_type_string>,<object_name_string>, <options_string>) /* use MetricsImage */
Retrieved data
image MetricsImage See "The image Directive"
All Template Metrics Reports
DA-C context
Metrics report
Data retrieval
DGML scriptGetAllMetricsReport(MetricsImageCol, <template_name_string>, <object_type_string>, <object_name_string>)
for_each(MetricsImage in MetricsImageCol)
/* use MetricsImage */
end_forRetrieved data
image MetricsImage See "The image Directive"
Copyright © 1993-2022, RistanCASE PR