Consultingwerk.SmartFramework.Menu.SmartMenu

Namespace:

Consultingwerk.SmartFramework.Menu

Class

SmartMenu

Parent classes:

Progress.Lang.Object

Consultingwerk.OERA.EntityTable

Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Consultingwerk.SmartFramework.Menu.SmartMenu

Inherits:

Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

File:	SmartMenu
Author(s):	Marko Rüterbories
Created:	11.10.2012 00:34:53
	Purpose: Constructor of the SmartMenu class
	Notes:

Top Method Summary

Options	Name	Purpose
# A	AssignFromBuffer (handle)	Copies the buffer values to the entity table's properties Overrides Consultingwerk.SmartFramework.Menu.SmartMenu_Generated:AssignFromBuffer (handle)
# A	AssignToBuffer (handle)	Copies the entity table's properties to the buffer values Overrides Consultingwerk.SmartFramework.Menu.SmartMenu_Generated:AssignToBuffer (handle)
#	HANDLE GetChildRecord (handle, character)	Returns the first (and typically only) child record of a to-one relation Inherited from Consultingwerk.OERA.EntityTable
#	GetChildRecords (handle, character, Object, character)	Populates a List of child records Inherited from Consultingwerk.OERA.EntityTable
+	InitializeNewRow ()	Initializes a New row Inherited from Consultingwerk.OERA.EntityTable
#	OnFunctionGuidChanged (EventArgs)	Raises the FunctionGuidChanged event Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
#	OnFunctionNameChanged (EventArgs)	Raises the FunctionNameChanged event Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
#	OnHasChildChanged (EventArgs)	Raises the HasChildChanged event Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
#	OnMenuBeginsAGroupChanged (EventArgs)	Raises the MenuBeginsAGroupChanged event Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
#	OnMenuGuidChanged (EventArgs)	Raises the MenuGuidChanged event Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
#	OnMenuLargeImageChanged (EventArgs)	Raises the MenuLargeImageChanged event Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
#	OnMenuNameChanged (EventArgs)	Raises the MenuNameChanged event Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
#	OnMenuSequenceChanged (EventArgs)	Raises the MenuSequenceChanged event Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
#	OnMenuSmallImageChanged (EventArgs)	Raises the MenuSmallImageChanged event Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
#	OnMenuStructureTypeChanged (EventArgs)	Raises the MenuStructureTypeChanged event Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
#	OnParentMenuGuidChanged (EventArgs)	Raises the ParentMenuGuidChanged event Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	PopulateList (handle, character, Object, character)	Populates a List object with EntityTable objects for buffers Inherited from Consultingwerk.OERA.EntityTable
+	PopulateList (handle, Object, character)	Populates a List object with EntityTable objects for buffers Inherited from Consultingwerk.OERA.EntityTable
#	SetModified ()	Set's the current row to modified Inherited from Consultingwerk.OERA.EntityTable

Top Constructor Summary

	Options	Name	Purpose
	+	SmartMenu ()	Constructor of the SmartMenu class
	+	SmartMenu (handle)	Constructor of the SmartMenu class

Top Event Summary

Options	Name	Purpose
+	FunctionGuidChanged (Object, EventArgs)	Raised when the FunctionGuid property value changes Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	FunctionNameChanged (Object, EventArgs)	Raised when the FunctionName property value changes Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	HasChildChanged (Object, EventArgs)	Raised when the HasChild property value changes Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	MenuBeginsAGroupChanged (Object, EventArgs)	Raised when the MenuBeginsAGroup property value changes Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	MenuGuidChanged (Object, EventArgs)	Raised when the MenuGuid property value changes Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	MenuLargeImageChanged (Object, EventArgs)	Raised when the MenuLargeImage property value changes Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	MenuNameChanged (Object, EventArgs)	Raised when the MenuName property value changes Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	MenuSequenceChanged (Object, EventArgs)	Raised when the MenuSequence property value changes Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	MenuSmallImageChanged (Object, EventArgs)	Raised when the MenuSmallImage property value changes Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	MenuStructureTypeChanged (Object, EventArgs)	Raised when the MenuStructureType property value changes Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	ParentMenuGuidChanged (Object, EventArgs)	Raised when the ParentMenuGuid property value changes Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Top Property Summary

Options	Name	Purpose
+	CHARACTER FunctionGuid	Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	CHARACTER FunctionName	Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	LOGICAL HasChild	Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	LOGICAL MenuBeginsAGroup	Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	CHARACTER MenuGuid	Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	CHARACTER MenuLargeImage	Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	CHARACTER MenuName	Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	INTEGER MenuSequence	Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	CHARACTER MenuSmallImage	Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	CHARACTER MenuStructureType	Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	CHARACTER ParentMenuGuid	Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated
+	RowStateEnum RowState	Inherited from Consultingwerk.OERA.EntityTable
+	Consultingwerk.SmartFramework.Menu.ListSmartFunction SmartFunctions	Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Method Detail

Top

PROTECTED AssignFromBuffer (handle)

Overrides Consultingwerk.SmartFramework.Menu.SmartMenu_Generated:AssignFromBuffer (handle)

Purpose:	Copies the buffer values to the entity table's properties
Notes:

Parameters:
phBuffer	HANDLE
	The handle of the source buffer

Top

PROTECTED AssignToBuffer (handle)

Overrides Consultingwerk.SmartFramework.Menu.SmartMenu_Generated:AssignToBuffer (handle)

Purpose:	Copies the entity table's properties to the buffer values
Notes:

Parameters:
phBuffer	HANDLE
	The handle of the target buffer

Top

PROTECTED HANDLE GetChildRecord (handle, character)

Inherited from Consultingwerk.OERA.EntityTable

Purpose:	Returns the first (and typically only) child record of a to-one
	relation
Notes:

Parameters:
phParentBuffer	HANDLE
	The handle to the parent buffer
pcDataRelationName	CHARACTER
	The name of the data-relation to return the child buffer for
Returns	HANDLE
	The handle of the child record, already located to the first record (if any)

Top

PROTECTED GetChildRecords (handle, character, Object, character)

Inherited from Consultingwerk.OERA.EntityTable

Purpose:	Populates a List of child records
Notes:	As we currently don't support "generic Interfaces", we can only access
	the strong typed Add method of the Generic lists using the DYNAMIC-INVOKE
	statement.

Parameters:
phParentBuffer	HANDLE
	The handle to the parent buffer
pcDataRelationName	CHARACTER
	The name of the data-relation to return the child buffer for
poList	Progress.Lang.Object
	The List to populate
pcClassName	CHARACTER
	The name of the ChildClass

Top

PUBLIC InitializeNewRow ()

Inherited from Consultingwerk.OERA.EntityTable

Purpose:	Initializes a New row
Notes:	Provides a method to provide initial values when records are added to
	differentiate from the Constructor usage when Rows are populate based
	on existing DB records
	Override this method to provide initial values

Top

PROTECTED OnFunctionGuidChanged (EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raises the FunctionGuidChanged event
Notes:

Parameters:
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PROTECTED OnFunctionNameChanged (EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raises the FunctionNameChanged event
Notes:

Parameters:
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PROTECTED OnHasChildChanged (EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raises the HasChildChanged event
Notes:

Parameters:
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PROTECTED OnMenuBeginsAGroupChanged (EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raises the MenuBeginsAGroupChanged event
Notes:

Parameters:
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PROTECTED OnMenuGuidChanged (EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raises the MenuGuidChanged event
Notes:

Parameters:
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PROTECTED OnMenuLargeImageChanged (EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raises the MenuLargeImageChanged event
Notes:

Parameters:
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PROTECTED OnMenuNameChanged (EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raises the MenuNameChanged event
Notes:

Parameters:
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PROTECTED OnMenuSequenceChanged (EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raises the MenuSequenceChanged event
Notes:

Parameters:
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PROTECTED OnMenuSmallImageChanged (EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raises the MenuSmallImageChanged event
Notes:

Parameters:
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PROTECTED OnMenuStructureTypeChanged (EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raises the MenuStructureTypeChanged event
Notes:

Parameters:
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PROTECTED OnParentMenuGuidChanged (EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raises the ParentMenuGuidChanged event
Notes:

Parameters:
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PUBLIC PopulateList (handle, character, Object, character)

Inherited from Consultingwerk.OERA.EntityTable

Purpose:	Populates a List object with EntityTable objects for buffers
Notes:	Selects the buffer records using an optional Query string
	As we currently don't support "generic Interfaces", we can only access
	the strong typed Add method of the Generic lists using the DYNAMIC-INVOKE
	statement.

Parameters:
phBuffer	HANDLE
	The Buffer to return add EntityTable instances to the list
pcQueryString	CHARACTER
	The QueryString to use while populating the list
poList	Progress.Lang.Object
	The list to add the EntityTable instances to
pcClassName	CHARACTER
	The name of the class to create EntityTable instances of (child class of the EntityTable)

Top

PUBLIC PopulateList (handle, Object, character)

Inherited from Consultingwerk.OERA.EntityTable

Purpose:	Populates a List object with EntityTable objects for buffers
Notes:

Parameters:
phBuffer	HANDLE
	The Buffer to return add EntityTable instances to the list
poList	Progress.Lang.Object
	The list to add the EntityTable instances to
pcClassName	CHARACTER
	The name of the class to create EntityTable instances of (child class of the EntityTable)

Top

PROTECTED SetModified ()

Inherited from Consultingwerk.OERA.EntityTable

Purpose:	Set's the current row to modified
Notes:	When the RowState is Add or Deleted it will not be changed

Constructor Detail

Top

PUBLIC SmartMenu ()

Purpose:	Constructor of the SmartMenu class
Notes:

Top

PUBLIC SmartMenu (handle)

Purpose:	Constructor of the SmartMenu class
Notes:

Parameters:
phBuffer	HANDLE
	A source buffer to copy the values from

Event Detail

Top

PUBLIC FunctionGuidChanged (Object, EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raised when the FunctionGuid property value changes
Notes:

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PUBLIC FunctionNameChanged (Object, EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raised when the FunctionName property value changes
Notes:

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PUBLIC HasChildChanged (Object, EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raised when the HasChild property value changes
Notes:

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PUBLIC MenuBeginsAGroupChanged (Object, EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raised when the MenuBeginsAGroup property value changes
Notes:

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PUBLIC MenuGuidChanged (Object, EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raised when the MenuGuid property value changes
Notes:

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PUBLIC MenuLargeImageChanged (Object, EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raised when the MenuLargeImage property value changes
Notes:

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PUBLIC MenuNameChanged (Object, EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raised when the MenuName property value changes
Notes:

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PUBLIC MenuSequenceChanged (Object, EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raised when the MenuSequence property value changes
Notes:

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PUBLIC MenuSmallImageChanged (Object, EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raised when the MenuSmallImage property value changes
Notes:

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PUBLIC MenuStructureTypeChanged (Object, EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raised when the MenuStructureType property value changes
Notes:

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

PUBLIC ParentMenuGuidChanged (Object, EventArgs)

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Purpose:	Raised when the ParentMenuGuid property value changes
Notes:

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Property Detail

Top

PUBLIC CHARACTER FunctionGuid

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Returns	CHARACTER

Top

PUBLIC CHARACTER FunctionName

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Returns	CHARACTER

Top

PUBLIC LOGICAL HasChild

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Returns	LOGICAL

Top

PUBLIC LOGICAL MenuBeginsAGroup

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Returns	LOGICAL

Top

PUBLIC CHARACTER MenuGuid

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Returns	CHARACTER

Top

PUBLIC CHARACTER MenuLargeImage

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Returns	CHARACTER

Top

PUBLIC CHARACTER MenuName

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Returns	CHARACTER

Top

PUBLIC INTEGER MenuSequence

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Returns	INTEGER

Top

PUBLIC CHARACTER MenuSmallImage

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Returns	CHARACTER

Top

PUBLIC CHARACTER MenuStructureType

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Returns	CHARACTER

Top

PUBLIC CHARACTER ParentMenuGuid

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Returns	CHARACTER

Top

PUBLIC RowStateEnum RowState

Inherited from Consultingwerk.OERA.EntityTable

Returns	RowStateEnum

Top

PUBLIC Consultingwerk.SmartFramework.Menu.ListSmartFunction SmartFunctions

Inherited from Consultingwerk.SmartFramework.Menu.SmartMenu_Generated

Returns	Consultingwerk.SmartFramework.Menu.ListSmartFunction

info@consultingwerk.de http://www.consultingwerk.de 15.04.2024 06:00:23