Namespace: Consultingwerk.CommonUi.Components.TreeView
Class 
SerializableTreeNodeDetailSpec Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.JsonSerializable
Consultingwerk.CommonUi.Components.TreeView.SerializableTreeNodeDetailSpec

Inherits: Consultingwerk.JsonSerializable
Implements: Consultingwerk.IJsonSerializable

File:SerializableTreeNodeDetailSpec
Purpose:Describes a root node of a treeview
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Oct 18 18:35:14 CEST 2017
Purpose: Gets and sets the FormId of the details view
Notes: Use either FormId or Template

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



Top Method Summary
Options Name Purpose
# CHARACTER AddSerializableProperties () Adds serializable properties from the calling class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
# AddSerializableProperties (character) Add a list of Serializable Properties to the SerializableProperties property
Inherited from Consultingwerk.JsonSerializable
# CHARACTER AddSerializableProperties (Class) Adds serializable properties from the given class using ABL reflection. Supported from OpenEdge 11.6 on only.
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
# IEnumerable GetEnumerableInstance (character) Returns an instance of the enumerable type
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER GetSerializableProperties () Returns the meta data of the serializable properties
Inherited from Consultingwerk.JsonSerializable
+ 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
+ Consultingwerk.CommonUi.Components.TreeView.SerializableTreeNodeDetailSpec WithFormId (character, character, character, JsonObject) Alternative Constructor for the SerializableTreeNodeDetailSpec class
+ Consultingwerk.CommonUi.Components.TreeView.SerializableTreeNodeDetailSpec WithFormId (character, character, character, JsonObject, character, JsonObject) Alternative Constructor for the SerializableTreeNodeDetailSpec class
+ 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
+ SerializableTreeNodeDetailSpec () Constructor for the SerializableTreeNodeDetailSpec class
+ SerializableTreeNodeDetailSpec (character, character, character, JsonObject) Constructor for the SerializableTreeNodeDetailSpec class
+ SerializableTreeNodeDetailSpec (character, character, character, JsonObject, character, JsonObject) Constructor for the SerializableTreeNodeDetailSpec class
+ SerializableTreeNodeDetailSpec (Object, character, character, JsonObject) Constructor for the SerializableTreeNodeDetailSpec class
+ SerializableTreeNodeDetailSpec (Object, character, character, JsonObject, character, JsonObject) Constructor for the SerializableTreeNodeDetailSpec class

Top Property Summary
Options Name Purpose
+ CHARACTER DataSource
+ CHARACTER ForeignFields
+ Progress.Json.ObjectModel.JsonObject ForeignValues
+ CHARACTER FormId
+ Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER KeyFields
+ Progress.Json.ObjectModel.JsonObject KeyValues
+ LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER Template
+ LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable


Method Detail
Top

PROTECTED CHARACTER AddSerializableProperties ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the calling class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes: Adds properties of the following types, does not add properties of
the base classes, adds only PUBLIC properties:
- CHARACTER
- CHARACTER EXTENT
- DATE
- DATE EXTENT
- DATETIME
- DATETIME EXTENT
- DATETIME-TZ
- DATETIME-TZ EXTENT
- DECIMAL
- DECIMAL EXTENT
- INT64
- INT64 EXTENT
- INTEGER
- INTEGER EXTENT
- LOGICAL
- LOGICAL EXTENT
- LONGCHAR
- LONGCHAR EXTENT
- RAW
- RAW EXTENT
- RECID
- RECID EXTENT
- ROWID
- ROWID EXTENT
- Progress.Json.ObjectModel.JsonArray
- Progress.Json.ObjectModel.JsonObject
- ENUM
- Consultingwerk.Enum
- Consultingwerk.Framework.Base.IEnumerable
- Consultingwerk.JsonSerializable
- Consultingwerk.JsonSerializable EXTENT

Returns CHARACTER
The value of the SerializableProperties property
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

PROTECTED CHARACTER AddSerializableProperties (Class)
Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the given class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes: Adds properties of the following types, does not add properties of
the base classes, adds only PUBLIC properties:
- CHARACTER
- CHARACTER EXTENT
- DATE
- DATE EXTENT
- DATETIME
- DATETIME EXTENT
- DATETIME-TZ
- DATETIME-TZ EXTENT
- DECIMAL
- DECIMAL EXTENT
- INT64
- INT64 EXTENT
- INTEGER
- INTEGER EXTENT
- LOGICAL
- LOGICAL EXTENT
- LONGCHAR
- LONGCHAR EXTENT
- RAW
- RAW EXTENT
- RECID
- RECID EXTENT
- ROWID
- ROWID EXTENT
- Progress.Json.ObjectModel.JsonArray
- Progress.Json.ObjectModel.JsonObject
- ENUM
- Consultingwerk.Enum
- Consultingwerk.Framework.Base.IEnumerable
- Consultingwerk.JsonSerializable
- Consultingwerk.JsonSerializable EXTENT

Parameters:
poClass Progress.Lang.Class
The declaring class
Returns CHARACTER
The value of the SerializableProperties property
Top

PUBLIC Deserialize (longchar)
Inherited from Consultingwerk.JsonSerializable
Purpose: Deserializes a LONGCHAR representation of the state of the class instance
Notes:

Parameters:
pcSerializedRepresentation 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 IEnumerable GetEnumerableInstance (character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns an instance of the enumerable type
Notes: When the property value is referencing a value list instance, this
instance is returned. If not, we attempt to create a new instance

Parameters:
pcProperty CHARACTER
The name of the List property
Returns IEnumerable
The instance of the enumerable type
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 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

PUBLIC Consultingwerk.CommonUi.Components.TreeView.SerializableTreeNodeDetailSpec WithFormId (character, character, character, JsonObject)
Purpose: Alternative Constructor for the SerializableTreeNodeDetailSpec class
Notes:

Parameters:
pcFormId CHARACTER
The FormId of the details view
pcDataSource CHARACTER
The name of the DataSource in the detail view template which will be repositioned
pcForeignFields CHARACTER
The comma delimited list of foreign fields
poForeignValues Progress.Json.ObjectModel.JsonObject
The JsonObject of the foreign key values
Returns Consultingwerk.CommonUi.Components.TreeView.SerializableTreeNodeDetailSpec
The new SerializableTreeNodeDetailSpec instance
Top

PUBLIC Consultingwerk.CommonUi.Components.TreeView.SerializableTreeNodeDetailSpec WithFormId (character, character, character, JsonObject, character, JsonObject)
Purpose: Alternative Constructor for the SerializableTreeNodeDetailSpec class
Notes:

Parameters:
pcFormId CHARACTER
The FormId of the details view
pcDataSource CHARACTER
The name of the DataSource in the detail view template which will be repositioned
pcForeignFields CHARACTER
The comma delimited list of foreign fields
poForeignValues Progress.Json.ObjectModel.JsonObject
The JsonObject of the foreign key values
pcKeyFields CHARACTER
The comma delimited list of key field names
poKeyValues Progress.Json.ObjectModel.JsonObject
The JsonObject of the key field values
Returns Consultingwerk.CommonUi.Components.TreeView.SerializableTreeNodeDetailSpec
The new SerializableTreeNodeDetailSpec instance
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 SerializableTreeNodeDetailSpec ()
Purpose: Constructor for the SerializableTreeNodeDetailSpec class
Notes:

Top

PUBLIC SerializableTreeNodeDetailSpec (character, character, character, JsonObject)
Purpose: Constructor for the SerializableTreeNodeDetailSpec class
Notes:

Parameters:
pcTemplate CHARACTER
The URI of the details view template
pcDataSource CHARACTER
The name of the DataSource in the detail view template which will be repositioned
pcForeignFields CHARACTER
The comma delimited list of foreign fields
poForeignValues Progress.Json.ObjectModel.JsonObject
The JsonObject of the foreign key values
Top

PUBLIC SerializableTreeNodeDetailSpec (character, character, character, JsonObject, character, JsonObject)
Purpose: Constructor for the SerializableTreeNodeDetailSpec class
Notes:

Parameters:
pcTemplate CHARACTER
The URI of the details view template
pcDataSource CHARACTER
The name of the DataSource in the detail view template which will be repositioned
pcForeignFields CHARACTER
The comma delimited list of foreign fields
poForeignValues Progress.Json.ObjectModel.JsonObject
The JsonObject of the foreign key values
pcKeyFields CHARACTER
The comma delimited list of key field names
poKeyValues Progress.Json.ObjectModel.JsonObject
The JsonObject of the key field values
Top

PUBLIC SerializableTreeNodeDetailSpec (Object, character, character, JsonObject)
Purpose: Constructor for the SerializableTreeNodeDetailSpec class
Notes:

Parameters:
poTemplate Progress.Lang.Object
The URI of the details view template
pcDataSource CHARACTER
The name of the DataSource in the detail view template which will be repositioned
pcForeignFields CHARACTER
The comma delimited list of foreign fields
poForeignValues Progress.Json.ObjectModel.JsonObject
The JsonObject of the foreign key values
Top

PUBLIC SerializableTreeNodeDetailSpec (Object, character, character, JsonObject, character, JsonObject)
Purpose: Constructor for the SerializableTreeNodeDetailSpec class
Notes:

Parameters:
poTemplate Progress.Lang.Object
The URI of the details view template
pcDataSource CHARACTER
The name of the DataSource in the detail view template which will be repositioned
pcForeignFields CHARACTER
The comma delimited list of foreign fields
poForeignValues Progress.Json.ObjectModel.JsonObject
The JsonObject of the foreign key values
pcKeyFields CHARACTER
The comma delimited list of key field names
poKeyValues Progress.Json.ObjectModel.JsonObject
The JsonObject of the key field values


Property Detail
Top

PUBLIC CHARACTER DataSource

Returns CHARACTER
Top

PUBLIC CHARACTER ForeignFields

Returns CHARACTER
Top

PUBLIC Progress.Json.ObjectModel.JsonObject ForeignValues

Returns Progress.Json.ObjectModel.JsonObject
Top

PUBLIC CHARACTER FormId

Returns CHARACTER
Top

PUBLIC Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable

Returns Consultingwerk.IJsonDateTypeFormatter
Top

PUBLIC CHARACTER KeyFields

Returns CHARACTER
Top

PUBLIC Progress.Json.ObjectModel.JsonObject KeyValues

Returns Progress.Json.ObjectModel.JsonObject
Top

PUBLIC LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PUBLIC LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PUBLIC CHARACTER Template

Returns CHARACTER
Top

PUBLIC LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:50:59