Namespace: Consultingwerk.Studio.Proparse
Class 
ProparseHelper2 Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Studio.Proparse.ProparseHelper2

Inherits: Progress.Lang.Object


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
ClearParseUnitCache () Releases every cached parse unit
CollectNodes (INode, character, integer) Adds the given node, its following siblings and all of their children to the ttNodes temp-table
DisableParseUnitCache () Disables the parse unit cache and releases the cached parse units
EnableParseUnitCache () Enables the parse unit cache and discards anything cached before
LOGICAL ExistsChildNodeByPath (INode, character) Returns if the child node with the given node path exists
Consultingwerk.Studio.ProparseApi.INode FindChildNodeOfNodeType (INode, character) Searches for a child node of the given node with the matching node type
Consultingwerk.Studio.ProparseApi.INode FindChildNodeOfNodeTypeWithID (INode, character, character) Searches for a child node of the given node with the matching node type and ID childnode text
Consultingwerk.Studio.ProparseApi.INode FindChildNodeOfNodeTypeWithText (INode, character, character) Searches for a child node of the given node with the matching node type and text
Consultingwerk.Studio.ProparseApi.INode FindFirstChildByPositionInCode (INode) Returns the first INode in a AST by position
Consultingwerk.Studio.ProparseApi.INode FindFirstPositionedDescendant (INode) Returns the node with the earliest source position in the subtree of the given node, the node itself included
Consultingwerk.Studio.ProparseApi.INode FindRoutineParent (INode) Finds the Routine-Level Block that contains the given INode
CHARACTER FullyQualifiedTableName (IRecordNameNode) Returns the fully qualified table name
Consultingwerk.BufferFieldName GetBufferFieldName (IFieldRefNode) Returns a BufferFieldName based on the given IFieldRefNode instance
Consultingwerk.Studio.ProparseApi.INode GetChildNodeByPath (INode, character) Returns the reference to the child node with the given node path
CHARACTER GetFullFieldName (INode) Returns the full name of the represented field
CHARACTER GetFullNodeText (INode) Returns the full text of the Node
GetFullNodeText (INode, character) Appends the text of the given node and its children to the passed in return value
CHARACTER GetIdNodeText (INode) Returns the text of the ID node below the given Node
GetInternalRunStatements (INode) Returns a temp-table with all internal RUN statements in the given node (typically the Root node of a parse unit)
GetInternalRunStatements (INode, table) Returns a temp-table with all internal RUN statements in the given node (typically the Root node of a parse unit)
GetNodeChildren (INode, table) Returns a temp-table with all children (direct and indirect) of the given node
GetNodeChildrenOfNodeType (INode, character, table) Returns a temp-table with all children (direct and indirect) of the given node with the given node type
INTEGER GetRoutineDepth (INode) Returns the block level relative to the next Routine-Level Block for the given INode
Consultingwerk.Studio.ProparseApi.INode GetRoutineParent (INode) Returns the INode of the routine (method, function, procedure, ...) that contains the given node
Consultingwerk.Studio.ProparseApi.INode GetTopParent (INode) Returns the top-most parent-node, the Program_root-node, of a node
CHARACTER GetTypeName (NodeTypesEnum) Returns the type-name of the given NodeTypesEnum member
LOGICAL HasChildNodeOfNodeType (INode, character) Searches for a Childnode of the given node with the matching node type
LOGICAL HasChildNodeOfNodeType (INode, NodeTypesEnum) Searches for a Childnode of the given node with the matching node type
LOGICAL HasChildNodeOfNodeTypeWithID (INode, character, character) Searches for a Childnode of the given node with the matching node type and ID childnode text
LOGICAL HasChildNodeOfNodeTypeWithText (INode, character, character) Searches for a Childnode of the given node with the matching node type and text
initialize () Initializes proparse API
LOGICAL IsKeywordType (NodeTypesEnum) Returns whether the given node type represents an ABL keyword
Consultingwerk.Studio.ProparseApi.IVariable LookupVariable (ISymbolScope, character) Looks up a variable in the given symbol scope
INTEGER NumChildNodeOfNodeType (INode, character) Returns the number of child nodes of the given node with the matching node type
INTEGER NumChildren (INode) Returns the number of direct child nodes of the given INode
LOGICAL ParentIsTrivialDo (INode) Returns if the parent of the given INode is a simple DO: block (without any condition, e.g. DO WITH FRAME:)
Consultingwerk.Studio.ProparseApi.IParseUnit ParseFile (character) Parses a file and returns the reference to the ParseUnit
CHARACTER ParseParameterList (INode) Parses the Parameter_list of a Method/Function/Event/Constructor node
CHARACTER ParseParameterList (INode, logical) Parses the Parameter_list of a Method/Function/Event/Constructor node
CHARACTER ParseProcedureParameterList (INode) Parses the Parameter_list of a procedure (internal or external) node
CHARACTER ParseProcedureParameterList (INode, logical) Parses the Parameter_list of a procedure (internal or external) node
Consultingwerk.Studio.ProparseApi.IParseUnit ParseString (longchar) Parses the passed in String
Consultingwerk.Studio.ProparseApi.IParseUnit ParseString (longchar, IProparseApi) Parses the passed in String using the given IProparseApi instance
RemoveNode (INode) Removes a Node from the ParseUnit
ReplaceIndividualNode (INode, longchar) Replaces an individual node with the given text
ReplaceRoutineNode (INode, longchar, logical, logical) Replaces a routine node (METHOD, CONSTRUCTOR, ...) with the given text
CHARACTER TriggerCompleteEventList (INode) Returns the complete trigger Event_list node of a Trigger node
CHARACTER TriggerEventList (INode) Returns the Text of the Event_list node of a Trigger node
CHARACTER TriggerWidgetRef (INode) Returns the Text of the Widget_ref node of a Trigger node

Top Property Summary
Options Name Purpose
LOGICAL Initialized


Method Detail
Top

ClearParseUnitCache ()
Purpose: Releases every cached parse unit
Notes: SCL-5653: Also the way a consumer that has to re-read a file
from disc bypasses the cache

Top

CollectNodes (INode, character, integer)
Purpose: Adds the given node, its following siblings and all of their
children to the ttNodes temp-table
Notes: Takes the first node of a sibling chain rather than its parent,
so that the recursion does not read FirstChild a second time -
every read allocates a fresh INode wrapper (SCL-5657). An empty
pcNodeType adds all nodes

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The first INode of the sibling chain to add
pcNodeType CHARACTER
The node type to add, empty for all node types
piSequence INTEGER
The sequence of the previously added node
Top

DisableParseUnitCache ()
Purpose: Disables the parse unit cache and releases the cached parse units
Notes: SCL-5653

Top

EnableParseUnitCache ()
Purpose: Enables the parse unit cache and discards anything cached before
Notes: SCL-5653: The cache is off by default and is meant to be turned
on for the duration of a single run that parses the same files
repeatedly - a Business Entity regeneration parses one Data
Access class six times, and only one of those six parses follows
a write. Leaving it on across a session would hold ASTs alive
and gain nothing, so the enabling scope is expected to disable
it again in a FINALLY block

Top

LOGICAL ExistsChildNodeByPath (INode, character)
Purpose: Returns if the child node with the given node path exists
Notes: Paths are separated either by / or \
Supported path references, samples
EQUAL\Field_ref\ID returns the ID node of an assignment
RECORD_NAME\WHERE\AND\AND\2\QSTRING - The quoted string "b" in FOR EACH Customer WHERE Customer.Name BEGINS "Lift" AND Customer.City BEGINS "b" AND Customer.Country = "USA": (the second node, a BEGINS is referenced by the 2)
2 - returns the second child of the parent node

Parameters:
poParentNode Consultingwerk.Studio.ProparseApi.INode
The reference to the parent INode
pcPath CHARACTER
The path reference
Returns LOGICAL
Logical value indicating if the child node with the given path exists
Top

Consultingwerk.Studio.ProparseApi.INode FindChildNodeOfNodeType (INode, character)
Purpose: Searches for a child node of the given node with the matching node type
Notes: This method does not work recursively, so only direct child nodes are
processed

Parameters:
poASTNode Consultingwerk.Studio.ProparseApi.INode
The parent INode
pcChildNodeType CHARACTER
The searched child not type as returned by ProparseHelper2:GetTypeName
Returns Consultingwerk.Studio.ProparseApi.INode
The found INode or the unknown value
Top

Consultingwerk.Studio.ProparseApi.INode FindChildNodeOfNodeTypeWithID (INode, character, character)
Purpose: Searches for a child node of the given node with the matching node type
and ID childnode text
Notes: This method does not work recursively, so only direct child nodes are
processed
Useful for finding

Parameters:
poASTNode Consultingwerk.Studio.ProparseApi.INode
The parent INode
pcChildNodeType CHARACTER
The searched child node type as returned by ProparseHelper2:GetTypeName
pcChildNodeID CHARACTER
The searched child node ID node value
Returns Consultingwerk.Studio.ProparseApi.INode
The found INode or the unknown value
Top

Consultingwerk.Studio.ProparseApi.INode FindChildNodeOfNodeTypeWithText (INode, character, character)
Purpose: Searches for a child node of the given node with the matching node type
and text
Notes: This method does not work recursively, so only direct child nodes are
processed
Useful for finding Annotations with Text = "@Annotation"

Parameters:
poASTNode Consultingwerk.Studio.ProparseApi.INode
The parent INode
pcChildNodeType CHARACTER
The searched child node type as returned by ProparseHelper2:GetTypeName
pcChildNodeText CHARACTER
The searched child node Text value
Returns Consultingwerk.Studio.ProparseApi.INode
The found INode or the unknown value
Top

Consultingwerk.Studio.ProparseApi.INode FindFirstChildByPositionInCode (INode)
Purpose: Returns the first INode in a AST by position
Notes:

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The parent INode
Returns Consultingwerk.Studio.ProparseApi.INode
The found JPNode or the unknown value
Top

Consultingwerk.Studio.ProparseApi.INode FindFirstPositionedDescendant (INode)
Purpose: Returns the node with the earliest source position in the
subtree of the given node, the node itself included
Notes: SCL-5825: The first token of a statement in source order. Unlike
FindFirstChildByPositionInCode this walks the whole subtree, so
it also resolves a synthetic statement node (line 0, e.g. the
ASSIGN node of an implicit assignment statement) whose first
positioned token sits below a synthetic child such as a
Widget_ref, and does not stop at an operator token

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The root node of the subtree
Returns Consultingwerk.Studio.ProparseApi.INode
The node with the earliest source position, invalid when no node of the subtree carries one
Top

Consultingwerk.Studio.ProparseApi.INode FindRoutineParent (INode)
Purpose: Finds the Routine-Level Block that contains the given INode
Notes: Unlike GetRoutineParent this method only walks up the parent
chain (never returns the given node itself), treats the
Program_root node as a routine parent and returns the unknown
value when there is no routine parent

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The INode to return the reference to the routine-level block for
Returns Consultingwerk.Studio.ProparseApi.INode
The INode that describes the routine-level block for the given INode
Top

CHARACTER FullyQualifiedTableName (IRecordNameNode)
Purpose: Returns the fully qualified table name
Notes:

Parameters:
poRecordName Consultingwerk.Studio.ProparseApi.IRecordNameNode
The IRecordNameNode instance
Returns CHARACTER
The fully qualified table name
Top

Consultingwerk.BufferFieldName GetBufferFieldName (IFieldRefNode)
Purpose: Returns a BufferFieldName based on the given IFieldRefNode instance
Notes:

Parameters:
poFieldNode Consultingwerk.Studio.ProparseApi.IFieldRefNode
The IFieldRefNode to parse
Returns Consultingwerk.BufferFieldName
The BufferFieldName with the data of the IFieldRefNode
Top

Consultingwerk.Studio.ProparseApi.INode GetChildNodeByPath (INode, character)
Purpose: Returns the reference to the child node with the given node path
Notes: Paths are separated either by / or \
Supported path references, samples
EQUAL\Field_ref\ID returns the ID node of an assignment
RECORD_NAME\WHERE\AND\AND\2\QSTRING - The quoted string "b" in FOR EACH Customer WHERE Customer.Name BEGINS "Lift" AND Customer.City BEGINS "b" AND Customer.Country = "USA": (the second node, a BEGINS is referenced by the 2)
2 - returns the second child of the parent node

Parameters:
poParentNode Consultingwerk.Studio.ProparseApi.INode
The reference to the parent INode
pcPath CHARACTER
The path reference
Returns Consultingwerk.Studio.ProparseApi.INode
The reference to the child INode with the given node path
Top

CHARACTER GetFullFieldName (INode)
Purpose: Returns the full name of the represented field
Notes: Requires a Field_ref node or a Widget_ref node which represents a
Field_ref node

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The reference to the INode
Returns CHARACTER
The full fieldname or ?
Top

CHARACTER GetFullNodeText (INode)
Purpose: Returns the full text of the Node
Notes: Similar to the INode:ToStringFulltext implementation,
but without the leading comments and white space characters

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The node to return the full text of
Returns CHARACTER
The full text of the node
Top

GetFullNodeText (INode, character)
Purpose: Appends the text of the given node and its children to the
passed in return value
Notes: Walks the subtree in pre-order (the node first, then its
children); the leading hidden text is skipped for the very
first token only

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The node to append the text of
pcReturn CHARACTER
The return value to append to
Top

CHARACTER GetIdNodeText (INode)
Purpose: Returns the text of the ID node below the given Node
Notes: Returns ? when the given node does not contain an ID Node

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The parent node
Returns CHARACTER
The Text value of the ID node below the given node or ?
Top

GetInternalRunStatements (INode)
Purpose: Returns a temp-table with all internal RUN statements in the given
node (typically the Root node of a parse unit)
Notes:

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The node to parse
Top

GetInternalRunStatements (INode, table)
Purpose: Returns a temp-table with all internal RUN statements in the given
node (typically the Root node of a parse unit)
Notes:

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The node to parse
ttRunStatements TEMP-TABLE ttRunStatements
The temp-table with the located run statements (from Consultingwerk/Studio/Proparse/ttRunStatements.i)
Top

GetNodeChildren (INode, table)
Purpose: Returns a temp-table with all children (direct and indirect) of
the given node
Notes: The children are returned in pre-order; the given node itself
is not part of the result

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The parent INode
ttNodes TEMP-TABLE ttNodes
The temp-table with the child nodes (from Consultingwerk/Studio/Proparse/ttNodes.i)
Top

GetNodeChildrenOfNodeType (INode, character, table)
Purpose: Returns a temp-table with all children (direct and indirect) of
the given node with the given node type
Notes: The children are returned in pre-order; the given node itself
is not part of the result

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The parent INode
pcNodeType CHARACTER
The node type to add as returned by ProparseHelper2:GetTypeName
ttNodes TEMP-TABLE ttNodes
The temp-table with the child nodes (from Consultingwerk/Studio/Proparse/ttNodes.i)
Top

INTEGER GetRoutineDepth (INode)
Purpose: Returns the block level relative to the next Routine-Level Block
for the given INode
Notes: Returns the unknown value when the given node is not contained
in a routine

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The INode to return the block level for
Returns INTEGER
Block level relatively to the parent node
Top

Consultingwerk.Studio.ProparseApi.INode GetRoutineParent (INode)
Purpose: Returns the INode of the routine (method, function, procedure, ...)
that contains the given node
Notes: Returns the given node itself when it already represents a
routine node; walks up the parent chain otherwise

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The INode to return the routine parent of
Returns Consultingwerk.Studio.ProparseApi.INode
The INode of the routine containing the given node
Top

Consultingwerk.Studio.ProparseApi.INode GetTopParent (INode)
Purpose: Returns the top-most parent-node, the Program_root-node, of a node
Notes:

Parameters:
poASTNode Consultingwerk.Studio.ProparseApi.INode
The INode whose parent is sought
Returns Consultingwerk.Studio.ProparseApi.INode
The Program_root-node of poASTNode
Top

CHARACTER GetTypeName (NodeTypesEnum)
Purpose: Returns the type-name of the given NodeTypesEnum member
Notes:

Parameters:
poType Consultingwerk.Studio.ProparseApi.NodeTypesEnum
The NodeTypesEnum member
Returns CHARACTER
The name of poType
Top

LOGICAL HasChildNodeOfNodeType (INode, character)
Purpose: Searches for a Childnode of the given node with the matching node type
Notes: This method does not work recursively, so only direct child nodes are
processed

Parameters:
poASTNode Consultingwerk.Studio.ProparseApi.INode
The parent INode
pcChildNodeType CHARACTER
The searched child node type as returned by ProparseHelper2:GetTypeName
Returns LOGICAL
True when a child node with the given node type exists
Top

LOGICAL HasChildNodeOfNodeType (INode, NodeTypesEnum)
Purpose: Searches for a Childnode of the given node with the matching node type
Notes:

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The parent INode
poType Consultingwerk.Studio.ProparseApi.NodeTypesEnum
The searched child node type
Returns LOGICAL
True when a child node with the given node type exists
Top

LOGICAL HasChildNodeOfNodeTypeWithID (INode, character, character)
Purpose: Searches for a Childnode of the given node with the matching node type
and ID childnode text
Notes: Useful for finding PROCEDURE with a certain name etc.

Parameters:
poASTNode Consultingwerk.Studio.ProparseApi.INode
The parent INode
pcChildNodeType CHARACTER
The searched child node type as returned by ProparseHelper2:GetTypeName
pcChildNodeID CHARACTER
The searched child node ID node value
Returns LOGICAL
True when a child node with the given node type exists
Top

LOGICAL HasChildNodeOfNodeTypeWithText (INode, character, character)
Purpose: Searches for a Childnode of the given node with the matching node type
and text
Notes: Useful for finding Annotations with Text = "@Annotation"

Parameters:
poASTNode Consultingwerk.Studio.ProparseApi.INode
The parent INode
pcChildNodeType CHARACTER
The searched child not type as returned by ProparseHelper2:GetTypeName
pcChildNodeText CHARACTER
The searched child node Text value
Returns LOGICAL
True when a child node with the given node type exists
Top

initialize ()
Purpose: Initializes proparse API
Notes:

Top

LOGICAL IsKeywordType (NodeTypesEnum)
Purpose: Returns whether the given node type represents an ABL keyword
Notes: Passes through to the IProparseApi service implementation

Parameters:
poType Consultingwerk.Studio.ProparseApi.NodeTypesEnum
The NodeTypesEnum member to check
Returns LOGICAL
Logical value indicating if the node type represents an ABL keyword
Top

Consultingwerk.Studio.ProparseApi.IVariable LookupVariable (ISymbolScope, character)
Purpose: Looks up a variable in the given symbol scope
Notes:

Parameters:
poSymbolScope Consultingwerk.Studio.ProparseApi.ISymbolScope
The symbol scope to search in
pcVariableName CHARACTER
The name of the variable to look up
Returns Consultingwerk.Studio.ProparseApi.IVariable
The looked up variable or the unknown value
Top

INTEGER NumChildNodeOfNodeType (INode, character)
Purpose: Returns the number of child nodes of the given node with the matching
node type
Notes: This method does not work recursively, so only direct child nodes are
counted

Parameters:
poASTNode Consultingwerk.Studio.ProparseApi.INode
The parent INode
pcChildNodeType CHARACTER
The searched child node type as returned by ProparseHelper2:GetTypeName
Returns INTEGER
The number of child nodes with the given type
Top

INTEGER NumChildren (INode)
Purpose: Returns the number of direct child nodes of the given INode
Notes:

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The INode to return the number of children of
Returns INTEGER
The number of direct child nodes
Top

LOGICAL ParentIsTrivialDo (INode)
Purpose: Returns if the parent of the given INode is a simple DO: block
(without any condition, e.g. DO WITH FRAME:)
Notes:

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The INode to test the parent block of
Returns LOGICAL
Logical value indicating if the parent of the given node is a trivial DO block
Top

Consultingwerk.Studio.ProparseApi.IParseUnit ParseFile (character)
Purpose: Parses a file and returns the reference to the ParseUnit
Notes: SCL-5653: When the parse unit cache is enabled, a file whose
content is unchanged since it was last parsed is served from the
cache instead of being parsed again. Reading the 10 KB of source
needed to decide that costs microseconds, a parse of the same
file costs seconds

Parameters:
pcFilename CHARACTER
The name of the file to parse
Returns Consultingwerk.Studio.ProparseApi.IParseUnit
The proparse ParseUnit reference
Top

CHARACTER ParseParameterList (INode)
Purpose: Parses the Parameter_list of a Method/Function/Event/Constructor
node
Notes: Returns a value in the form "INPUT CHARACTER,OUTPUT INTEGER,OUTPUT DATASET-HANDLE"

Parameters:
poParentNode Consultingwerk.Studio.ProparseApi.INode
The reference to the INode of the Method/Function/Event/Constructor
Returns CHARACTER
The Character representation of the Parameter list
Top

CHARACTER ParseParameterList (INode, logical)
Purpose: Parses the Parameter_list of a Method/Function/Event/Constructor
node
Notes: Returns a value in the form "INPUT CHARACTER,OUTPUT INTEGER,OUTPUT DATASET-HANDLE"

Parameters:
poParentNode Consultingwerk.Studio.ProparseApi.INode
The reference to the INode of the Method/Function/Event/Constructor
plIncludeParameterName LOGICAL
Logical value indicating if the parameter name should be included as well
Returns CHARACTER
The Character representation of the Parameter list
Top

CHARACTER ParseProcedureParameterList (INode)
Purpose: Parses the Parameter_list of a procedure (internal or external) node
Notes: Returns a value in the form "INPUT CHARACTER,OUTPUT INTEGER,OUTPUT DATASET-HANDLE"

Parameters:
poParentNode Consultingwerk.Studio.ProparseApi.INode
The reference to the INode of the Procedure or Program_root
Returns CHARACTER
The Character representation of the Parameter list
Top

CHARACTER ParseProcedureParameterList (INode, logical)
Purpose: Parses the Parameter_list of a procedure (internal or external) node
Notes: Returns a value in the form "INPUT CHARACTER,OUTPUT INTEGER,OUTPUT DATASET-HANDLE"

Parameters:
poParentNode Consultingwerk.Studio.ProparseApi.INode
The reference to the INode of the Procedure or Program_root
plIncludeParameterName LOGICAL
Logical value indicating if the parameter name should be included as well
Returns CHARACTER
The Character representation of the Parameter list
Top

Consultingwerk.Studio.ProparseApi.IParseUnit ParseString (longchar)
Purpose: Parses the passed in String
Notes: Writes the string to a temporary file for parsing; the temporary
file is removed after the parse

Parameters:
plcString LONGCHAR
The LONGCHAR String to parse
Returns Consultingwerk.Studio.ProparseApi.IParseUnit
The proparse IParseUnit reference
Top

Consultingwerk.Studio.ProparseApi.IParseUnit ParseString (longchar, IProparseApi)
Purpose: Parses the passed in String using the given IProparseApi instance
Notes: Writes the string to a temporary file for parsing; the temporary
file is removed after the parse

Parameters:
plcString LONGCHAR
The LONGCHAR String to parse
poProparseApi Consultingwerk.Studio.ProparseApi.IProparseApi
The IProparseApi instance to parse with
Returns Consultingwerk.Studio.ProparseApi.IParseUnit
The proparse IParseUnit reference
Top

RemoveNode (INode)
Purpose: Removes a Node from the ParseUnit
Notes: When the node has a PrevSibling, the PrevSibling is linked to the NextSibling
When the node does not have a PrevSibling, the parents FirstChild is set to the NextSibling

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The INode to remove
Top

ReplaceIndividualNode (INode, longchar)
Purpose: Replaces an individual node with the given text
Notes: Should not be called more than once for a given Parse Unit as by
replacing a node all following line counts may become inaccurate
Really only replaces the text of the given node and not any nested
nodes

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The INode to replace
plcNewText LONGCHAR
The new text for the node
Top

ReplaceRoutineNode (INode, longchar, logical, logical)
Purpose: Replaces a routine node (METHOD, CONSTRUCTOR, ...) with the given
text
Notes: Should not be called more than onces for a given Parse Unit as by replacing
a routine node all following line counts may become inaccurate
Optionally replaces the comments block (a single block) or any white
spaces that precedes the method block.
When replacing all white spaces preceding the routine node
(plReplaceAllLeadingHiddenText = TRUE) it is recommended, to start
the plcNewText with two new lines (~n~n)

Parameters:
poNode Consultingwerk.Studio.ProparseApi.INode
The INode to replace
plcNewText LONGCHAR
The new text for the node
plReplaceComments LOGICAL
Replaces comments preceding the node
plReplaceAllLeadingHiddenText LOGICAL
Replaces comments and all white spaces preceding the node
Top

CHARACTER TriggerCompleteEventList (INode)
Purpose: Returns the complete trigger Event_list node of a Trigger node
Notes: Returns "":U if no Event_list node is present, comma-delimited

Parameters:
poASTNode Consultingwerk.Studio.ProparseApi.INode
The INode of the Trigger itself (ON / BlockNode)
Returns CHARACTER
The Text of the Event_list node
Top

CHARACTER TriggerEventList (INode)
Purpose: Returns the Text of the Event_list node of a Trigger node
Notes: Returns "":U if no Event_list node is present

Parameters:
poASTNode Consultingwerk.Studio.ProparseApi.INode
The INode of the Trigger itself (ON / BlockNode)
Returns CHARACTER
The Text of the Event_list node
Top

CHARACTER TriggerWidgetRef (INode)
Purpose: Returns the Text of the Widget_ref node of a Trigger node
Notes: Returns "":U if no Widget_ref node is present, drills down into the
Field_ref node if present (for UI widgets)

Parameters:
poASTNode Consultingwerk.Studio.ProparseApi.INode
The INode of the Trigger itself (ON / BlockNode)
Returns CHARACTER
The Text of the Widget_ref node


Property Detail
Top

LOGICAL Initialized

Returns LOGICAL


Temp-Table Detail

Temp-Table ttNodes

Defined in:

Temp-Table ttRunStatements

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:18:07