Consultingwerk.SmartFramework.Menu.Routes.ListRouteDefinition

Namespace:

Consultingwerk.SmartFramework.Menu.Routes

Class

ListRouteDefinition

Parent classes:

Progress.Lang.Object

Consultingwerk.Framework.Base.GenericList

Consultingwerk.SmartFramework.Menu.Routes.ListRouteDefinition

Inherits:

Consultingwerk.Framework.Base.GenericList

Implements:

Consultingwerk.Framework.Base.IArrayList, Consultingwerk.Framework.Base.IEnumerable, Consultingwerk.Framework.Base.ISupportsListChanged, Consultingwerk.Framework.Base.ISupportsListHash

File:	ListRouteDefinition
Purpose:	Generic List of RouteDefinition instances
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Sat Apr 08 21:52:37 CEST 2017

Top Method Summary

Options	Name	Purpose
+	Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition Add (RouteDefinition)	Adds an item to the generic List
+	Add (RouteDefinition[])	Adds an array of items to the generic List
+	Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition AddWhenNotContained (RouteDefinition)	Adds an item to the generic List only when it is not yet contained - silently ignores keys that are already contained
+	Clear ()	Removes all items from the List Inherited from Consultingwerk.Framework.Base.GenericList
+	LOGICAL Contains (Object)	Determines if an object is a member of the List Inherited from Consultingwerk.Framework.Base.GenericList
+	Consultingwerk.Framework.Base.IEnumerator GetEnumerator ()	Returns a new IEnumerator instance for this object instance Inherited from Consultingwerk.Framework.Base.GenericList
+	Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition GetItem (integer)	Retrieves an item from the generic List
+	Progress.Lang.Object GetItemInternal__ (integer)	Returns the Item at the specified Index Inherited from Consultingwerk.Framework.Base.GenericList
+	INTEGER IndexOf (Object)	Determines the index of a specific item in the List Inherited from Consultingwerk.Framework.Base.GenericList
#	InternalAdd (Object)	Adds an Item to the List Inherited from Consultingwerk.Framework.Base.GenericList
#	InternalAdd (Object[])	Adds the Items from an Array to the List Inherited from Consultingwerk.Framework.Base.GenericList
#	Progress.Lang.Object InternalGetItem (integer)	Returns the Item at the specified Index Inherited from Consultingwerk.Framework.Base.GenericList
#	OnListChanged (ListChangedEventArgs)	Raises the ListChanged event Inherited from Consultingwerk.Framework.Base.GenericList
+	LOGICAL Remove (Object)	Removes the first occurrence of a specific object from the List Inherited from Consultingwerk.Framework.Base.GenericList
+	LOGICAL RemoveAt (integer)	Removes the List item at the specified index. Inherited from Consultingwerk.Framework.Base.GenericList
+	Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition ToArray ()	Returns an Array with the elements of the List

Top Event Summary

	Options	Name	Purpose
	+	ListChanged (Object, ListChangedEventArgs)	Raised when the List is changed by adding or removing items or clearing the list Inherited from Consultingwerk.Framework.Base.GenericList

Top Property Summary

	Options	Name	Purpose
	+	INTEGER Count	Inherited from Consultingwerk.Framework.Base.GenericList
	+	CHARACTER ListHash	Inherited from Consultingwerk.Framework.Base.GenericList

Method Detail

Top

PUBLIC Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition Add (RouteDefinition)

Purpose:	Adds an item to the generic List
Notes:

Parameters:
poItem	Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition
	And item of the Lists member type
Returns	Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition
	The new Item added to the List

Top

PUBLIC Add (RouteDefinition[])

Purpose:	Adds an array of items to the generic List
Notes:

Parameters:
poItem	Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition
	An array of items of the Lists member type

Top

PUBLIC Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition AddWhenNotContained (RouteDefinition)

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.SmartFramework.Menu.Routes.RouteDefinition
	And item of the Lists member type
Returns	Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition
	The new Item added to the List

Top

PUBLIC Clear ()

Inherited from Consultingwerk.Framework.Base.GenericList

Purpose:	Removes all items from the List
Notes:

Top

PUBLIC LOGICAL Contains (Object)

Inherited from Consultingwerk.Framework.Base.GenericList

Purpose:	Determines if an object is a member of the List
Notes:

Parameters:
poListItem	Progress.Lang.Object
	The object to locate in the List
Returns	LOGICAL
	Logical value indicating if the object is contained in the list

Top

PUBLIC Consultingwerk.Framework.Base.IEnumerator GetEnumerator ()

Inherited from Consultingwerk.Framework.Base.GenericList

Purpose:	Returns a new IEnumerator instance for this object instance
Notes:

Returns	Consultingwerk.Framework.Base.IEnumerator
	The IEnumerator instance for this object

Top

PUBLIC Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition GetItem (integer)

Purpose:	Retrieves an item from the generic List
Notes:	CAST's the element from the underlying Progress.Lang.Object based
	list

Parameters:
piIndex	INTEGER
	The 1 based index of the item to retrieve
Returns	Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition
	The item of the Lists member type

Top

PUBLIC Progress.Lang.Object GetItemInternal__ (integer)

Inherited from Consultingwerk.Framework.Base.GenericList

Purpose:	Returns the Item at the specified Index
Notes:	This method is only intended to be used by the ListEnumerator
	Any other use of this method is not supported

Parameters:
piIndex	INTEGER
	The index of the Item to be returned
Returns	Progress.Lang.Object
	The object at the specified list position

Top

PUBLIC INTEGER IndexOf (Object)

Inherited from Consultingwerk.Framework.Base.GenericList

Purpose:	Determines the index of a specific item in the List
Notes:

Parameters:
poListItem	Progress.Lang.Object
	The object to locate in the List
Returns	INTEGER
	Integer value indicating if position of the object in the list

Top

PROTECTED InternalAdd (Object)

Inherited from Consultingwerk.Framework.Base.GenericList

Purpose:	Adds an Item to the List
Notes:	Protected method to be overridden in the actual generic List class

Parameters:
poItem	Progress.Lang.Object
	The Item to add to the List

Top

PROTECTED InternalAdd (Object[])

Inherited from Consultingwerk.Framework.Base.GenericList

Purpose:	Adds the Items from an Array to the List
Notes:	Protected method to be overridden in the actual generic List class

Parameters:
poItem	Progress.Lang.Object
	The Array of Items to add to the List

Top

PROTECTED Progress.Lang.Object InternalGetItem (integer)

Inherited from Consultingwerk.Framework.Base.GenericList

Purpose:	Returns the Item at the specified Index
Notes:	Protected method to be overridden in the actual generic List class

Parameters:
piIndex	INTEGER
	The 1 based index of the Item to be returned
Returns	Progress.Lang.Object
	The object at the specified list position

Top

PROTECTED OnListChanged (ListChangedEventArgs)

Inherited from Consultingwerk.Framework.Base.GenericList

Purpose:	Raises the ListChanged event
Notes:

Parameters:
e	Consultingwerk.Framework.Base.ListChangedEventArgs
	The ListChangedEventArgs object instance with the data of the ListChanged event

Top

PUBLIC LOGICAL Remove (Object)

Inherited from Consultingwerk.Framework.Base.GenericList

Purpose:	Removes the first occurrence of a specific object from the List
Notes:

Parameters:
poListItem	Progress.Lang.Object
	The member to remove from the List
Returns	LOGICAL
	Logical value indicating if the item was removed

Top

PUBLIC LOGICAL RemoveAt (integer)

Inherited from Consultingwerk.Framework.Base.GenericList

Purpose:	Removes the List item at the specified index.
Notes:

Parameters:
piIndex	INTEGER
	The Index of the Item to remove from the List
Returns	LOGICAL
	Logical value indicating if the item was removed

Top

PUBLIC Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition ToArray ()

Purpose:	Returns an Array with the elements of the List
Notes:

Returns	Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition
	The array of elements of the Lists member type

Event Detail

Top

PUBLIC ListChanged (Object, ListChangedEventArgs)

Inherited from Consultingwerk.Framework.Base.GenericList

Purpose:	Raised when the List is changed by adding or removing items or
	clearing the list
Notes:

Parameters:
sender	Progress.Lang.Object
	The sender of the event
e	Consultingwerk.Framework.Base.ListChangedEventArgs
	The ListChangedEventArgs object instance with the data of the ListChanged event

Property Detail

Top

PUBLIC INTEGER Count

Inherited from Consultingwerk.Framework.Base.GenericList

Returns	INTEGER

Top

PUBLIC CHARACTER ListHash

Inherited from Consultingwerk.Framework.Base.GenericList

Returns	CHARACTER

info@consultingwerk.de http://www.consultingwerk.de 04.02.2020 23:22:01