Simple And Composite Properties of DGML Types

In the following section all properties for every DGML type value are specified, as well as the appropriate scripts generated for them by the Wizard.

All scripts are written without the delimiters #{ and }# in order to increase legibility. These delimiters appear in DT after the Wizard has been used. In places where the input parameters assume concrete values in the form of constants, these parameters are labeled <name_parameter_type> (e.g. <file_name_string>). Output function parameters are named (e.g. ProjectData) and if used as the input parameters of some other function, or in order to provide access to composite property members, they retain their names. If a variable is of the TCollection<Type> type, it has the suffix Col.

TProject properties

SIMPLE PROPERTIES

Name

Name

DGML script

ProjectData.Name

Name

Alias

DGML script

ProjectData.Alias
COMPOSITE PROPERTIES

Name

Root Directory

DGML script

GetDirectory(DirectoryData, ProjectData.RootDir) /* use DirectoryData */

Retrieved data

TDirectory DirectoryData See "TDirectory properties"

Name

Database Directory

DGML script

GetDirectory(DirectoryData, ProjectData.DatabaseDir) /* use DirecotryData */

Retrieved data

TDirectory DirectoryData See "TDirectory properties"

Name

Referential Directory

DGML script

GetDirectory(DirectoryData, ProjectData.ReferentialRootDir) /* use DirecotryData */

Retrieved data

TDirectory DirectoryData See "TDirectory properties"

Name

User Help File

DGML script

GetFile(FileData, ProjectData.UserHelpFile) /* use FileData */

Retrieved data

TFile FileData See "TFile properties"

Name

VCSData

DGML script

GetProjectVCSData(VCSData, ProjectData.Name) /* use VCSData */

Retrieved data

TProjectVCS VCSData See "TProjectVCSData properties"

TProjectVCSData properties

SIMPLE PROPERTIES

Name

Referential Label

DGML script

VCSData.ReferentialLabel

Name

Version Label

DGML script

VCSData.VersionLabel

TFile properties

SIMPLE PROPERTIES

Name

Name

DGML script

FileData.Name

Name

ProjectName

DGML script

FileData.ProjectName

Name

FullName

DGML script

FileData.FullName

Name

Path

DGML script

FileData.Path

Name

ProjectPath

DGML script

FileData.ProjectPath

Name

Size

DGML script

FileData.Size

Name

Alias

DGML script

FileData.Alias

Name

Created

DGML script

FileData.Created

Name

Accesed

DGML script

FileData.Accessed

Name

Modified

DGML script

FileData.Modified

Name

Attributes

DGML script

for_each (attr in FileData.Attributes)
  attr
end_for

Name

MakeOptions

DGML script

FileData.MakeOptions

Name

FileText *

DGML script

InsertFileText(FileData.Name, <format_string>)

Name

FileComment *

DGML script

InsertFileComment(FileData.Name, <format_string>)

Name

VCSHistory

DGML script

InsertVCSHistory(FileData.Name)

Name

VCSDifference *

DGML script

InsertVCSDifference(FileData.Name, <version_label_string>)

<format_string> for the FileText and FileComment property:

- Formatted
- Unformatted

<version_label_string> for the VCSDifference property:

- possible values are all Version labels of the file.

COMPOSITE PROPERTIES

Name

Dependencies

DGML script

GetFileDependencies(FileDependenciesCol, FileData.Name )
for_each(Dependant in FileDependenciesCol) GetFile(DependData, Dependant)
  /* use DependData */
end_for

Retrieved data

TFile DependData See "TFile properties"

Name

Messages

DGML script

GetFileMessages ( MessageDataCol , FileData.Name, <category_string> )
for_each(MessageData in MessageDataCol)
  /* use MessageData */
end_for

Retrieved data

TMessage MessageData See "TMessage properties"

Name

Functions

DGML script

GetModuleFunctions (FunctionDataCol, FileData.Name)
for_each(FunctionData in FunctionDataCol)
  /* use FunctionData */
end_for

Retrieved data

TFunction FunctionData See "TFunction Structure"

Name

Variables

DGML script

GetModuleVariables (VariableDataCol, FileData.Name)
for_each (VariableData in VariableDataCol)
  /* use VariableData */
end_for

Retrieved data

TSymbol VariableData See "TSymbol (Variable) properties"

Name

Constants

DGML script

GetModuleConstants (ConstantDataCol, FileData.Name)
for_each(ConstantData in ConstantDataCol)
  /* use ConstantData */
end_for

Retrieved data

TSymbol ConstantData See "TSymbol (Constant) properties"

Name

Types

DGML script

GetModuleTypes (TypeDataCol, FileData.Name)
for_each(TypeDat in TypeDataCol)
  /* use TypeData */
end_for

Retrieved data

TSymbol TypeData See "TSymbol (Type) properties"

Name

Macros

DGML script

GetModuleMacros (MacroDataCol, FileData.Name )
for_each(MacroData in MacroDataCol)
  /* use MacroData*/
end_for

Retrieved data

TSymbol MacroData See  "TSymbol (Macro) properties"

Name

VCSdata

DGML script

GetFileVCS(VCSData, FileData.Name) /* use VCSData */

Retrieved data

TFileVCSData VCSData See "TFileVCSData properties"

TFileVCSData properties

SIMPLE PROPERTIES

Name

LastChange

DGML script

VCSData.LastChange

Name

Status

DGML script

VCSData.Status

Name

Lockers

DGML script

for_each (locker in VCSData.Lockers)
  locker
end_for

Name

VersionLabels

DGML script

VCSData.VersionLabels

TDirectory properties

SIMPLE PROPERTIES

Name

Name

DGML script

DirectoryData.Name

Name

ProjectName

DGML script

DirectoryData.ProjectName

Name

FullName

DGML script

DirectoryData.FullName

Name

Alias

DGML script

DirectoryData.Alias

Name

Created

DGML script

DirectoryData.Created
COMPOSITE PROPERTIES

Name

Files

DGML script

for_each(File in DirectoryData.Files)
  GetFile(FileData, File) /* use FileData */
end_for

Retrieved data

TFile FileData See "TFile properties"

Name

Subdirectories

DGML script

for_each(DirectoryData in DirectoryData.Sudirectories)
  GetDirectory(SubDirectoryData, DirectoryData) /* project SubDirectoryData */
end_for

Retrieved data

TDirectory SubDirectoryData See "TDirectory properties"

TMessage properties

SIMPLE PROPERTIES 

Name

Category

DGML script

MessageData.Category

Name

Line

DGML script

MessageData.Line

Name

Message

DGML script

MessageData.Message

Name

Note

DGML script

MessageData.Note
COMPOSITE PROPERTIES

Name

File

DGML script

GetFile(FileData, MessageData.File) /* use FileData */

Retrieved data

TFile FileData See "TFile properties"

Name

Function

DGML script

GetFunction(FunctionData, MessageData.Function, MessageData.File) /* use FunctionData */

Retrieved data

TFunction FunctionData See "TFunction Structure"

TSymbol (Function) properties

SIMPLE PROPERTIES

Name

Name

DGML script

FunctionData.Name

Name

Type

DGML script

FunctionData.Type

Name

DACComment

DGML script

FunctionData.DACComment

Name

FunctionBody *

DGML script

InsertFunctionBody(FunctionData.Name, FunctionData.FileName, <format_string>)

Name

FunctionComment *

DGML script

InsertFunctionComment(FunctionData.Name, FunctionData.FileName, <format_string>)

<format_string> for the FunctionBody and FunctionComment property:

- Formatted
- Unformatted

COMPOSITE PROPERTIES

Name

File

DGML script

GetFile(FileData, FunctionData.FileName) /* use FileData */

Retrieved data

TFile FileData See "TFile properties"

Name

Parameters

DGML script

for_each(ParamData in FunctionData.Param)
  /* use ParamData */
end_for

Retrieved data

TSymbol ParamData See "TSymbol Structure"

Name

CallGraph *

DGML script

GetCallGraph(CallGraphImage, FunctionData.Name, <used_view_string>, <options_string>)
/* use CallGraphImage */

Retrieved data

image CallGraphImage See "The image Directive"

Name

Flowchart

DGML script

GetFlowChart(FlowChartImage, FunctionData.Name, <options_string>) /* use FlowChart */

Retrieved data

image FlowChartImage See "The image Directive"

Name

Declarations

DGML script

GetDeclarations(DeclarationDataCol,FunctionData.Name)
for_each(DeclarationData in DecalarationDataCol)
  /* use DeclarationData */
end_for

Retrieved data

TBrowse DeclarationData See "TBrowse properties"

Name

CallsTo

DGML script

GetCallsTo(CallToDataCol, FunctionData.Name, FunctionData.FileName)
for_each(CallToData in CallToDataCol)
  /* use CallToData */
end for

Retrieved data

TBrowse CallToData See "TBrowse properties"

Name

CallsWithin

DGML script

GetCallsWithin(CallWithinDataCol, FunctionData.Name, FuntionData.FileName)
for_each(CallWithinData in CallWithinDataCol)
  /* use CallWithinData */
end for

Retrieved data

TBrowse CallWithinData See "TBrowse properties"

Name

UsesWithin

DGML script

GetUsesWithin(UsesWithinData, FunctionData.Name, FuntionData.FileName)
/* use UsesWithinData */

Retrieved data

TUsesWithin UsesWithinData See "TUsesWithin properties"

<used_view_string> for the CallGraph property:

- NULL
- all views

TSymbol (Variable) properties

SIMPLE PROPERTIES 

Name

Name

DGML script

VariableData.Name

Name

Type

DGML script

VariableData.Type

Name

DACComment

DGML script

VariableData.DACComment
COMPOSITE PROPERTIES 

Name

File

DGML script

GetFile(FileData, VariableData.FileName) /* use FileData */

Retrieved data

TFile FileData See "TFile properties"

Name

OwnerFunction

DGML script

If(VariableData.OwnerFunction!="")
  GetFunction(FunctionData, VariableData.OwnerFunction, VariableData.File)
  /* use FunctionData */
end_if

Retrieved data

TFunction FunctionData See "TFunction Structure"

Name

Declarations

DGML script

GetDeclarations(DeclarationDataCol, VariableData.Name, VariableData.FileName)
for_each(DeclarationData in DeclarationDataCol)
  /* use DeclarationData */
end_for

Retrieved data

TBrowse DeclarationData See "TBrowse properties"

Name

Uses

DGML script

GetUses(UseDataCol, VariableData.Name, VariableData.FileName)
for_each(UseData in UseDataCol)
  /* use Use */
end for

Retrieved data

TBrowse UseData See "TBrowse properties"

Name

Assignment

DGML script

GetAssignment(AssignmentDataCol, VariableData.Name, VariableData.FileName)
for_each(AssignmentData in AssignmentDataCol)
  /* use AssignmentData */
end_for

Retrieved data

TBrowse AssignmentData See "TBrowse properties"

TSymbol (Constant) properties

SIMPLE PROPERTIES  

Name

Name

DGML script

ConstantData.Name

Name

Type

DGML script

ConstantData.Type

Name

DACComment

DGML script

ConstantData.DACComment
COMPOSITE PROPERTIES  

Name

File

DGML script

GetFile(FileData, ConstantData.FileName) /* use FileData */

Retrieved data

TFile FileData See "TFile properties"

Name

OwnerFunction

DGML script

If(ConstantData.OwnerFunction!="")
  GetFunction(FunctionData, ConstantData.OwnerFunction, ConstantData.File)
  /* use FunctionData */
end_if

Retrieved data

TFunction FunctionData See "TFunction Structure"

Name

Declarations

DGML script

GetDeclarations(DecalarationDataCol, ConstantData.Name, ConstantData.FileName)
for_each(DeclarationData in DecalarationDataCol)
  /* use DeclarationData */
end_for

Retrieved data

TBrowse DeclarationData See "TBrowse properties"

Name

Uses

DGML script

GetUses(UseDataCol, ConstantData.Name, ConstantData.FileName)
for_each(UseData in UseDataCol)
  /* use UseData */
end_for

Retrieved data

TBrowse UseData See "TBrowse properties"

TSymbol (Type) properties

SIMPLE PROPERTIES 

Name

Name

DGML script

TypeData.Name

Name

Type

DGML script

TypeData.Type

Name

DACComment

DGML script

TypeData.DACComment
COMPOSITE PROPERTIES 

Name

File

DGML script

GetFile(FileData, TypeData.FileName) /* use FileData */

Retrieved data

TFile FileData See "TFile properties"

Name

OwnerFunction

DGML script

If(TypeData.OwnerFunction!="")
  GetFunction(FunctionData, TypeData.OwnerFunction, TypeData.File)
  /* use FunctionData */
end_if

Retrieved data

TFunction FunctionData See "TFunction Structure"

Name

Declarations

DGML script

GetDeclarations(DecalarationDataCol, TypeData.Name, TypeData.FileName)
for_each(DeclarationData in DecalarationDataCol)
  /* use DeclarationData */
end_for

Retrieved data

TBrowse DeclarationData See "TBrowse properties"

Name

Uses

DGML script

GetUses(UseDataCol, TypeData.Name, TypeData.FileName)
for_each(UseData in UseDataCol)
  /* use UseData */
end_for

Retrieved data

TBrowse UseData See "TBrowse properties"

Name

TypeGraph

DGML script

GetTypeGraph(TypeGraphImage, TypeData.Name, ##...##) /* use TypeGraphImage */

Retrieved data

image TypeGraphImage See "The image Directive"

TSymbol (Macro) properties

SIMPLE PROPERTIES 

Name

Name

DGML script

MacroData.Name
COMPOSITE PROPERTIES 

Name

File

DGML script

GetFile(FileData, MacroData.FileName) /* use FileData */

Retrieved data

TFile FileData See "TFile properties"

Name

Uses

DGML script

GetUses(UseDataCol, MacroData.Name, MacroData.FileName)
for_each(UseData in UseDataCol)
  /* use UseData */
end_for

Retrieved data

TBrowse UseData See "TBrowse properties"

TBrowse properties

SIMPLE PROPERTIES 

Name

Level

DGML script

DeclarationData.Level

Name

Items

DGML script

for_each(Item in DeclarationData.Items)
  Item /* print Item */
end_for
COMPOSITE PROPERTIES 

Name

File

DGML script

GetFile(FileData, DeclarationData.FilePath) /* use FileData */

Retrieved data

TFile FileData See "TFile properties"

TUsesWithin properties

COMPOSITE PROPERTIES 

Name

PublicVarUses

DGML script

for_each(VariableData in UsesWithinData.PubicVarUses)
  /* use VariableData */
end_for

Retrieved data

TSymbol VariableData See "TSymbol Structure"

Name

LocalVarUses

DGML script

for_each(VariableData in UsesWithinData.LocalVarUses)
  /* use VariableData */
end_for

Retrieved data

TSymbol VariableData See "TSymbol Structure"

Name

PublicConstUses

DGML script

for_each(ConstData in UsesWithinData.PubicConstUses)
  /* use ConstData */
end_for

Retrieved data

TSymbol ConstData See "TSymbol Structure"

Name

LocalConstUses

DGML script

for_each(ConstData in UsesWithinData.LocalConstUses)
  /* use ConstData */
end_for

Retrieved data

TSymbol ConstData See "TSymbol Structure"

TGroup properties

SIMPLE PROPERTIES 

Name

Name

DGML script

GroupData.Name
COMPOSITE PROPERTIES 

Name

Functions

DGML script

for_each(FunctionData in GroupData.Functions)
  /* use FunctionData */
end_for

Retrieved data

TFunction FunctionData See "TFunction Structure"

Name

Groups

DGML script

for_each(GroupName in GroupData.SubGroups) GetGroup(GroupData, GroupName)
  /* use GroupData */
end_for

Retrieved data

TGroup GroupData See "TGroup properties"

Name

Call Graph

DGML script

GetCallGraph(CallGraphImage, "Group " + GroupData.Name, "","", <options_string>)
/* use CallGraphImage */

Retrieved data

image CallGraphImage See "The image Directive"

TView properties

SIMPLE PROPERTIES 

Name

Name

DGML script

ViewData.Name
COMPOSITE PROPERTIES 

Name

Groups

DGML script

for_each(GroupName in ViewData.Groups)
  GetGroup(GroupData, GroupName)
  /* use GroupData */
end_for

Retrieved data

TGroup GroupData See "TGroup properties"

Name

Views

DGML script

for_each(ViewName in ViewData.SubViews)
  GetView(ViewData, ViewName)
  /* use ViewData */
end_for

Retrieved data

TView ViewData See "TView properties"

Name

Call Graph

DGML script

GetCallGraph (CallGraphImage, "", "",ViewData.Name, <options_string>)/* use CallGraphImage */

Retrieved data

image CallGraphImage See "The image Directive"

TSearch properties

SIMPLE PROPERTIES 

Name

Count

DGML script

SearchData.Count
COMPOSITE PROPERTIES 

Name

FoundList

DGML script

for_each(FoundData in SearchData.FoundList)
  /* use FoundData */
end_for

Retrieved data

TFound FoundData See "TFound properties"

TFound properties

SIMPLE PROPERTIES 

Name

FileName

DGML script

FoundData.FileName

Name

Items

DGML script

for_each( item in FoundData.Items)
  item
end_for

RistanCASE Logo Copyright © 1993-2022, RistanCASE PR