Namespace: Consultingwerk.Studio
Class 
ListAnnotation Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.Base.GenericList
Consultingwerk.Studio.ListAnnotation

Inherits: Consultingwerk.Framework.Base.GenericList
Implements: Consultingwerk.Framework.Base.IArrayList, Consultingwerk.Framework.Base.IEnumerable, Consultingwerk.Framework.Base.ISupportsListChanged, Consultingwerk.Framework.Base.ISupportsListHash

File:ListAnnotation
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Jan 27 22:33:31 CET 2013

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



Top Method Summary
Options Name Purpose
Consultingwerk.Studio.Annotation Add (Annotation) Adds an item to the generic List
Add (Annotation[]) Adds an array of items to the generic List
Consultingwerk.Studio.Annotation Add (character, character, character, integer, integer) Adds a new Annotation to the List
Consultingwerk.Studio.Annotation Add (character, integer, integer, JPNode) Adds a new Annotation to the List
Consultingwerk.Studio.Annotation AddWhenNotContained (Annotation) Adds an item to the generic List only when it is not yet contained - silently ignores keys that are already contained
Consultingwerk.Studio.Annotation FindByName (character) Finds an Annotation in the List by it's Name
Consultingwerk.Studio.Annotation GetItem (integer) Retrieves an item from the generic List
LOGICAL IsEmpty () Returns if the List is empty
Consultingwerk.Studio.Annotation Replace (Annotation, Annotation) Replaces an item in the generic List
Consultingwerk.Studio.Annotation ToArray () Returns an Array with the elements of the List


Method Detail
Top

Consultingwerk.Studio.Annotation Add (Annotation)
Purpose: Adds an item to the generic List
Notes:

Parameters:
poItem Consultingwerk.Studio.Annotation
And item of the Lists member type
Returns Consultingwerk.Studio.Annotation
The new Item added to the List
Top

Add (Annotation[])
Purpose: Adds an array of items to the generic List
Notes:

Parameters:
poItem Consultingwerk.Studio.Annotation
An array of items of the Lists member type
Top

Consultingwerk.Studio.Annotation Add (character, character, character, integer, integer)
Purpose: Adds a new Annotation to the List
Notes:

Parameters:
pcFileName CHARACTER
The file name containing the annotation
pcName CHARACTER
The name of the Annotation (including @)
pcParameter CHARACTER
The parameter list of the annotation (typically in parenthesis)
piLine INTEGER
The line number of the Annotation
piColumn INTEGER
The column number of the Annotation
Returns Consultingwerk.Studio.Annotation
The new Annotation that was added to the List
Top

Consultingwerk.Studio.Annotation Add (character, integer, integer, JPNode)
Purpose: Adds a new Annotation to the List
Notes:

Parameters:
pcFileName CHARACTER
The file name containing the annotation
piLine INTEGER
The line number of the Annotation
piColumn INTEGER
The column number of the Annotation
poNode org.prorefactor.core.JPNode
The reference to the JPNode for the annotation
Returns Consultingwerk.Studio.Annotation
The new Annotation that was added to the List
Top

Consultingwerk.Studio.Annotation AddWhenNotContained (Annotation)
Purpose: Adds an item to the generic List only when it is not
yet contained - silently ignores keys that are already
contained
Notes:

Parameters:
poItem Consultingwerk.Studio.Annotation
And item of the Lists member type
Returns Consultingwerk.Studio.Annotation
The new Item added to the List
Top

Consultingwerk.Studio.Annotation FindByName (character)
Purpose: Finds an Annotation in the List by it's Name
Notes: Performs a FIND-FIRST, does not verify if there is a second Annotation
with the same name

Parameters:
pcName CHARACTER
The Name value to search
Returns Consultingwerk.Studio.Annotation
The matching Annotation or ? when no annotation has been found
Top

Consultingwerk.Studio.Annotation GetItem (integer)
Purpose: Retrieves an item from the generic List
Notes:

Parameters:
piIndex INTEGER
The 1 based index of the item to retrieve
Returns Consultingwerk.Studio.Annotation
The item of the Lists member type
Top

LOGICAL IsEmpty ()
Purpose: Returns if the List is empty
Notes:

Returns LOGICAL
Logical value indicating if the list if empty
Top

Consultingwerk.Studio.Annotation Replace (Annotation, Annotation)
Purpose: Replaces an item in the generic List
Notes:

Parameters:
poExistingItem Consultingwerk.Studio.Annotation
The item to replace
poNewItem Consultingwerk.Studio.Annotation
The new item
Returns Consultingwerk.Studio.Annotation
The reference to the replaced item
Top

Consultingwerk.Studio.Annotation ToArray ()
Purpose: Returns an Array with the elements of the List
Notes:

Returns Consultingwerk.Studio.Annotation
The array of elements of the Lists member type


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       30.03.2026 11:12:28