Consultingwerk.Windows.Framework.LaunchAnnotationFormCallParameter

Namespace:

Consultingwerk.Windows.Framework

Class

LaunchAnnotationFormCallParameter

Parent classes:

Progress.Lang.Object

Consultingwerk.JsonSerializable

Consultingwerk.Windows.Framework.LaunchAnnotationFormCallParameter

Inherits:

Consultingwerk.JsonSerializable

Implements:

Consultingwerk.Windows.Framework.IAnnotationBasedFormHash, Consultingwerk.SmartFramework.IFunctionCallParameter, Consultingwerk.IJsonSerializable

File:	LaunchAnnotationFormCallParameter
Purpose:	Function call parameter implementation that can launch
	an annotations (Business Entity Descriptor) based
	GUI for .NET form
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Mon Dec 30 13:02:52 CET 2019

Top Method Summary

Options	Name	Purpose
#	AddSerializableProperties (character)	Add a list of Serializable Properties to the SerializableProperties property Inherited from Consultingwerk.JsonSerializable
+	Deserialize (longchar)	Deserializes a LONGCHAR representation of the state of the class instance Inherited from Consultingwerk.JsonSerializable
+	DeserializeFromJsonObject (JsonObject)	Initializes the object instance based on the passed in JsonObject representation of the object instance Inherited from Consultingwerk.JsonSerializable
#	DeserializeProperty (JsonObject, character, character)	Deserializes a single property value to the current JsonObject Inherited from Consultingwerk.JsonSerializable
#	Progress.Windows.Form FindFormInstance ()	Locates the reference to a running Form instance
+	RAW GetFormHash (IAnnotationBasedFormHash)	Builds a hash value for an IAnnotationBasedFormHash
+	CHARACTER GetSerializableProperties ()	Returns the meta data of the serializable properties Inherited from Consultingwerk.JsonSerializable
+	Progress.Lang.Object Invoke (logical, Object)	Invokes/Starts the function associated with the IFunctionCallParameter object
+	LOGICAL IsActive ()	Returns true when the function is currently active (runninng)
+	LOGICAL ReActivate ()	ReActivates the function
+	LONGCHAR Serialize ()	Returns a LONGCHAR representation of the state of the class instance Inherited from Consultingwerk.JsonSerializable
#	SerializeProperty (JsonObject, character, character)	Serializes a single property value to the current JsonObject Inherited from Consultingwerk.JsonSerializable
+	Progress.Json.ObjectModel.JsonObject ToJsonObject ()	Returns a JsonObject representation of the state of the class instance Inherited from Consultingwerk.JsonSerializable
#	WaitForShowDialog (Form, DialogResult)	Executes the WAIT-FOR ShowDialog for a DialogForm
+	LONGCHAR WriteJson ()	Returns a LONGCHAR representation of the state of the class instance Inherited from Consultingwerk.JsonSerializable
+	LONGCHAR WriteXml ()	Returns an XML LONGCHAR representation of the object instance Inherited from Consultingwerk.JsonSerializable
+	HANDLE XmlSerialize (handle)	Serializes the properties of the current object instance to an existing X-NODEREF object Inherited from Consultingwerk.JsonSerializable
+	XmlSerializeProperties (handle)	Serializes the properties of this object instance as child nodes of the given node Inherited from Consultingwerk.JsonSerializable
#	XmlSerializeProperty (handle, character, character)	Serializes a single property value to the current parent XmlNode Inherited from Consultingwerk.JsonSerializable

Top Constructor Summary

	Options	Name	Purpose
	+	LaunchAnnotationFormCallParameter ()	Constructor for the LaunchAnnotationFormCallParameter class
		LaunchAnnotationFormCallParameter ()	Constructor for the LaunchAnnotationFormCallParameter class

Top Property Summary

Options	Name	Purpose
+	LOGICAL AllowMultiple
+	CHARACTER BusinessEntityName
+	CHARACTER CharacterParameterValue
+	Consultingwerk.Windows.Framework.FormStartTypeEnum DefaultFormStartType
+	CHARACTER EditorControl
+	CHARACTER FormAction
+	CHARACTER FormLogicClassName
+	Consultingwerk.Windows.Framework.FormStartTypeEnum FormStartType
+	CHARACTER FormTitle
+	CHARACTER IconFileName
+	CHARACTER ImageKey
+	Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter	Inherited from Consultingwerk.JsonSerializable
+	LOGICAL SerializeEmptyLists	Inherited from Consultingwerk.JsonSerializable
+	LOGICAL SerializeNullValues	Inherited from Consultingwerk.JsonSerializable
+	LOGICAL UseCharacterParameterValue
+	LOGICAL UseSerializedTypeInformation	Inherited from Consultingwerk.JsonSerializable
+	CHARACTER ViewerLogicClassName
+	CHARACTER ViewName

Method Detail

Top

PROTECTED AddSerializableProperties (character)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Add a list of Serializable Properties to the SerializableProperties property
Notes:	Required as a workaround to full reflection only. We may remove this
	method once Progress Software has implemented full reflection

Parameters:
pcSerializableProperties	CHARACTER
	A comma delimited list of serializable properties

Top

PUBLIC Deserialize (longchar)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Deserializes a LONGCHAR representation of the state of the class instance
Notes:

Parameters:
pcSerializedReprasentation	LONGCHAR
	The stored LONGCHAR representation of the objects data

Top

PUBLIC DeserializeFromJsonObject (JsonObject)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Initializes the object instance based on the passed in JsonObject
	representation of the object instance
Notes:

Parameters:
poJsonObject	Progress.Json.ObjectModel.JsonObject
	The stored JsonObject representation of the objects data

Top

PROTECTED DeserializeProperty (JsonObject, character, character)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Deserializes a single property value to the current JsonObject
Notes:	Allows to override the handling of individual properties during the
	JsonSerialization
Notes:

Parameters:
poJsonObject	Progress.Json.ObjectModel.JsonObject
	The reference to the source JsonObject
pcProperty	CHARACTER
	The name of the property in the JsonObject
pcType	CHARACTER
	The type of the property

Top

PROTECTED Progress.Windows.Form FindFormInstance ()

Purpose:	Locates the reference to a running Form instance
Notes:

Returns	Progress.Windows.Form
	The reference to the running Form instance

Top

PUBLIC RAW GetFormHash (IAnnotationBasedFormHash)

Purpose:	Builds a hash value for an IAnnotationBasedFormHash
Notes:

Parameters:
poParameter	Consultingwerk.Windows.Framework.IAnnotationBasedFormHash
	The IAnnotationBasedFormHash instance
Returns	RAW
	The hash value

Top

PUBLIC CHARACTER GetSerializableProperties ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Returns the meta data of the serializable properties
Notes:

Returns	CHARACTER
	The serializable properties meta data as a comma delimited list

Top

PUBLIC Progress.Lang.Object Invoke (logical, Object)

Purpose:	Invokes/Starts the function associated with the IFunctionCallParameter
	object
Notes:

Parameters:
plForceNewInstance	LOGICAL
	Logical value indicating if a new Instance should be started (True/False/?)
poContext	Progress.Lang.Object
	An optional reference to a context (could be the Control that launches the function)
Returns	Progress.Lang.Object
	The reference to the Form that has been launched

Top

PUBLIC LOGICAL IsActive ()

Purpose:	Returns true when the function is currently active (runninng)
Notes:

Returns	LOGICAL
	True when the function is currently active (runninng)

Top

PUBLIC LOGICAL ReActivate ()

Purpose:	ReActivates the function
Notes:

Returns	LOGICAL
	True when the function was successfully reactivated

Top

PUBLIC LONGCHAR Serialize ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Returns a LONGCHAR representation of the state of the class instance
Notes:	Returns the classname together with the Json serialization

Returns	LONGCHAR
	The LONGCHAR representation of the ISerializable objects data

Top

PROTECTED SerializeProperty (JsonObject, character, character)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Serializes a single property value to the current JsonObject
Notes:	Allows to override the handling of individual properties during the
	JsonSerialization

Parameters:
poJsonObject	Progress.Json.ObjectModel.JsonObject
	The reference to the target JsonObject
pcProperty	CHARACTER
	The name of the property in the JsonObject
pcType	CHARACTER
	The type of the property

Top

PUBLIC Progress.Json.ObjectModel.JsonObject ToJsonObject ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Returns a JsonObject representation of the state of the class instance
Notes:	Returns the classname together with the Json serialization of the
	object

Returns	Progress.Json.ObjectModel.JsonObject
	The Progress.Json.ObjectModel.JsonObject representation of the ISerializable objects data

Top

PROTECTED WaitForShowDialog (Form, DialogResult)

Purpose:	Executes the WAIT-FOR ShowDialog for a DialogForm
Notes:	avoid using WAIT-FOR in a non-void method to simplify compilation
	on OpenEdge 10.2B

Parameters:
poForm	System.Windows.Forms.Form
	The DialogForm to show
poDialogResult	System.Windows.Forms.DialogResult
	OUTPUT The DialogResult member that is the result of the ShowDialog method

Top

PUBLIC LONGCHAR WriteJson ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Returns a LONGCHAR representation of the state of the class instance
Notes:	Returns the classname together with the Json serialization
	This method is a facade to the JsonSerializable:Serialize method

Returns	LONGCHAR
	The LONGCHAR representation of the ISerializable objects data

Top

PUBLIC LONGCHAR WriteXml ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Returns an XML LONGCHAR representation of the object instance
Notes:

Returns	LONGCHAR
	The LONGCHAR representation of the ISerializable objects data

Top

PUBLIC HANDLE XmlSerialize (handle)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Serializes the properties of the current object instance to
	an existing X-NODEREF object
Notes:

Parameters:
phParent	HANDLE
	The reference to the parent XML Node or Document
Returns	HANDLE
	The X-NODEREF with the properties of the serialized object

Top

PUBLIC XmlSerializeProperties (handle)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Serializes the properties of this object instance as child nodes of
	the given node
Notes:

Parameters:
phObjectNode	HANDLE
	The reference to the X-NODEREF object that represents the node for the current instance

Top

PROTECTED XmlSerializeProperty (handle, character, character)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Serializes a single property value to the current parent XmlNode
Notes:	Allows to override the handling of individual properties during the
	XmlSerialization

Parameters:
phParentNode	HANDLE
	The reference to the parent XML Node
pcProperty	CHARACTER
	The name of the property in the JsonObject
pcType	CHARACTER
	The type of the property

Constructor Detail

Top

PUBLIC LaunchAnnotationFormCallParameter ()

Purpose:	Constructor for the LaunchAnnotationFormCallParameter class
Notes:

Top

STATIC LaunchAnnotationFormCallParameter ()

Purpose:	Constructor for the LaunchAnnotationFormCallParameter class
Notes:

Property Detail

Top

PUBLIC LOGICAL AllowMultiple

Returns	LOGICAL

Top

PUBLIC CHARACTER BusinessEntityName

Returns	CHARACTER

Top

PUBLIC CHARACTER CharacterParameterValue

Returns	CHARACTER

Top

PUBLIC Consultingwerk.Windows.Framework.FormStartTypeEnum DefaultFormStartType

Returns	Consultingwerk.Windows.Framework.FormStartTypeEnum

Top

PUBLIC CHARACTER EditorControl

Returns	CHARACTER

Top

PUBLIC CHARACTER FormAction

Returns	CHARACTER

Top

PUBLIC CHARACTER FormLogicClassName

Returns	CHARACTER

Top

PUBLIC Consultingwerk.Windows.Framework.FormStartTypeEnum FormStartType

Returns	Consultingwerk.Windows.Framework.FormStartTypeEnum

Top

PUBLIC CHARACTER FormTitle

Returns	CHARACTER

Top

PUBLIC CHARACTER IconFileName

Returns	CHARACTER

Top

PUBLIC CHARACTER ImageKey

Returns	CHARACTER

Top

PUBLIC Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter

Inherited from Consultingwerk.JsonSerializable

Returns	Consultingwerk.IJsonDateTypeFormatter

Top

PUBLIC LOGICAL SerializeEmptyLists

Inherited from Consultingwerk.JsonSerializable

Returns	LOGICAL

Top

PUBLIC LOGICAL SerializeNullValues

Inherited from Consultingwerk.JsonSerializable

Returns	LOGICAL

Top

PUBLIC LOGICAL UseCharacterParameterValue

Returns	LOGICAL

Top

PUBLIC LOGICAL UseSerializedTypeInformation

Inherited from Consultingwerk.JsonSerializable

Returns	LOGICAL

Top

PUBLIC CHARACTER ViewerLogicClassName

Returns	CHARACTER

Top

PUBLIC CHARACTER ViewName

Returns	CHARACTER

info@consultingwerk.de http://www.consultingwerk.de 04.02.2020 23:43:00