Namespace: Consultingwerk.Framework.TypeDescriptor
Class 
PropertyDescriptor Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.XmlSerializable
Consultingwerk.Framework.TypeDescriptor.PropertyDescriptor

Inherits: Consultingwerk.XmlSerializable
Implements: Consultingwerk.Framework.TypeDescriptor.IPropertyDescriptor, Consultingwerk.ISerializable

File:PropertyDescriptor
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Apr 29 07:26:24 CEST 2015
Purpose: Gets and sets the name of the type that defines the property
Notes: Returns the name of a base class when a property is inherited

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



Top Method Summary
Options Name Purpose
# AddSerializableProperties () Adds serializable properties from the calling class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.XmlSerializable
# AddSerializableProperties (character) Add a list of Serializable Properties to the SerializableProperties property
Inherited from Consultingwerk.XmlSerializable
# AddSerializableProperties (Class) Adds serializable properties from the given class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.XmlSerializable
+ Deserialize (longchar) Initializes the object instance based on the passed in LONGCHAR representation of the object instance
Inherited from Consultingwerk.XmlSerializable
+ DeserializeFromNode (handle) Deserializes the object instance based on the passed in X-NODEREF instance
Inherited from Consultingwerk.XmlSerializable
# DeserializeProperty (handle, character, character) Deserializes a single property value to the current Object
Inherited from Consultingwerk.XmlSerializable
# CHARACTER PropertyType (character) Returns the type of a property
Inherited from Consultingwerk.XmlSerializable
+ LONGCHAR Serialize () Returns an LONGCHAR representation of the object instance
Inherited from Consultingwerk.XmlSerializable
+ Serialize (handle) Serializes the properties of the current object instance to an existing X-NODEREF object
Inherited from Consultingwerk.XmlSerializable
+ Serialize (handle, character) Serializes the properties of the current object instance to an existing X-NODEREF object
Inherited from Consultingwerk.XmlSerializable
+ SerializeProperties (handle) Serializes the properties of this object instance as child nodes of the given node
Inherited from Consultingwerk.XmlSerializable
# SerializeProperty (handle, character, character) Serializes a single property value to the current parent XmlNode
Inherited from Consultingwerk.XmlSerializable
+ LONGCHAR WriteXml () Returns an LONGCHAR representation of the object instance
Inherited from Consultingwerk.XmlSerializable

Top Constructor Summary
Options Name Purpose
+ PropertyDescriptor () Constructor for the PropertyDescriptor class
+ PropertyDescriptor (character, character) Constructor for the PropertyDescriptor class
+ PropertyDescriptor (character, character, character) Constructor for the PropertyDescriptor class
+ PropertyDescriptor (character, character, character, character) Constructor for the PropertyDescriptor class
+ PropertyDescriptor (character, character, character, EditorTypeEnum) Constructor for the PropertyDescriptor class
+ PropertyDescriptor (character, character, character, EditorTypeEnum, character) Constructor for the PropertyDescriptor class
+ PropertyDescriptor (character, character, character, logical, logical) Constructor for the PropertyDescriptor class
+ PropertyDescriptor (character, character, character, logical, logical, character) Constructor for the PropertyDescriptor class
+ PropertyDescriptor (character, character, character, logical, logical, EditorTypeEnum) Constructor for the PropertyDescriptor class
+ PropertyDescriptor (character, character, character, logical, logical, EditorTypeEnum, character) Constructor for the PropertyDescriptor class
+ PropertyDescriptor (character, character, EditorTypeEnum) Constructor for the PropertyDescriptor class
+ PropertyDescriptor (character, character, EditorTypeEnum, character) Constructor for the PropertyDescriptor class
+ PropertyDescriptor (character, character, logical, logical) Constructor for the PropertyDescriptor class

Top Property Summary
Options Name Purpose
+ CHARACTER DefiningTypeName
+ LOGICAL Editable
+ Consultingwerk.Framework.TypeDescriptor.EditorTypeEnum EditorType
+ CHARACTER ListItemPairs
+ CHARACTER PropertyLabel
+ CHARACTER PropertyName
+ LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.XmlSerializable
+ LOGICAL SerializeNullValues
Inherited from Consultingwerk.XmlSerializable
+ LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.XmlSerializable
+ LOGICAL Visible


Method Detail
Top

PROTECTED AddSerializableProperties ()
Inherited from Consultingwerk.XmlSerializable
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
- ENUM
- Consultingwerk.Enum
- Consultingwerk.XmlSerializable
- Consultingwerk.Framework.Base.IEnumerable

Top

PROTECTED AddSerializableProperties (character)
Inherited from Consultingwerk.XmlSerializable
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 AddSerializableProperties (Class)
Inherited from Consultingwerk.XmlSerializable
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
- ENUM
- Consultingwerk.Enum
- Consultingwerk.Framework.Base.IEnumerable
- Consultingwerk.XmlSerializable

Parameters:
poClass Progress.Lang.Class
The declaring class
Top

PUBLIC Deserialize (longchar)
Inherited from Consultingwerk.XmlSerializable
Purpose: Initializes the object instance based on the passed in LONGCHAR
representation of the object instance
Notes:

Parameters:
pcSerializedRepresentation LONGCHAR
The stored LONGCHAR representation of the objects data
Top

PUBLIC DeserializeFromNode (handle)
Inherited from Consultingwerk.XmlSerializable
Purpose: Deserializes the object instance based on the passed in X-NODEREF
instance
Notes:

Parameters:
phRootNode HANDLE
The root node with the properties for this object
Top

PROTECTED DeserializeProperty (handle, character, character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Deserializes a single property value to the current Object
Notes: Allows to override the handling of individual properties during the
XmlSerialization
Notes:

Parameters:
phPropertyNode HANDLE
reference to the source XML Node
pcProperty CHARACTER
The name of the property
pcType CHARACTER
The type of the property
Top

PROTECTED CHARACTER PropertyType (character)
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns the type of a property
Notes: Throws an error, when the property is unknown

Parameters:
pcProperty CHARACTER
The name of the property
Returns CHARACTER
The type of the property
Top

PUBLIC LONGCHAR Serialize ()
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns an LONGCHAR representation of the object instance
Notes:

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PUBLIC Serialize (handle)
Inherited from Consultingwerk.XmlSerializable
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
Top

PUBLIC Serialize (handle, character)
Inherited from Consultingwerk.XmlSerializable
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
pcNodeName CHARACTER
The name of the XML Node
Top

PUBLIC SerializeProperties (handle)
Inherited from Consultingwerk.XmlSerializable
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 SerializeProperty (handle, character, character)
Inherited from Consultingwerk.XmlSerializable
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
Top

PUBLIC LONGCHAR WriteXml ()
Inherited from Consultingwerk.XmlSerializable
Purpose: Returns an LONGCHAR representation of the object instance
Notes: This method is a facade to the XmlSerializable:Serialize method

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data


Constructor Detail
Top

PUBLIC PropertyDescriptor ()
Purpose: Constructor for the PropertyDescriptor class
Notes:

Top

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

Parameters:
pcDefiningTypeName CHARACTER
The name of the class that defines this property
pcPropertyName CHARACTER
The name for the property
Top

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

Parameters:
pcDefiningTypeName CHARACTER
The name of the class that defines this property
pcPropertyName CHARACTER
The name for the property
pcPropertyLabel CHARACTER
The label for the property
Top

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

Parameters:
pcDefiningTypeName CHARACTER
The name of the class that defines this property
pcPropertyName CHARACTER
The name for the property
pcPropertyLabel CHARACTER
The label for the property
pcListItemPairs CHARACTER
The list item pairs (comma delimited) to use for this property
Top

PUBLIC PropertyDescriptor (character, character, character, EditorTypeEnum)
Purpose: Constructor for the PropertyDescriptor class
Notes:

Parameters:
pcDefiningTypeName CHARACTER
The name of the class that defines this property
pcPropertyName CHARACTER
The name for the property
pcPropertyLabel CHARACTER
The label for the property
poEditorType Consultingwerk.Framework.TypeDescriptor.EditorTypeEnum
The type of editor to use for the property
Top

PUBLIC PropertyDescriptor (character, character, character, EditorTypeEnum, character)
Purpose: Constructor for the PropertyDescriptor class
Notes:

Parameters:
pcDefiningTypeName CHARACTER
The name of the class that defines this property
pcPropertyName CHARACTER
The name for the property
pcPropertyLabel CHARACTER
The label for the property
poEditorType Consultingwerk.Framework.TypeDescriptor.EditorTypeEnum
The type of editor to use for the property
pcListItemPairs CHARACTER
The list item pairs (comma delimited) to use for this property
Top

PUBLIC PropertyDescriptor (character, character, character, logical, logical)
Purpose: Constructor for the PropertyDescriptor class
Notes:

Parameters:
pcDefiningTypeName CHARACTER
The name of the class that defines this property
pcPropertyName CHARACTER
The name for the property
pcPropertyLabel CHARACTER
The label for the property
plVisible LOGICAL
If the property should be visible
plEditable LOGICAL
If the property should be editable
Top

PUBLIC PropertyDescriptor (character, character, character, logical, logical, character)
Purpose: Constructor for the PropertyDescriptor class
Notes:

Parameters:
pcDefiningTypeName CHARACTER
The name of the class that defines this property
pcPropertyName CHARACTER
The name for the property
pcPropertyLabel CHARACTER
The label for the property
plVisible LOGICAL
If the property should be visible
plEditable LOGICAL
If the property should be editable
pcListItemPairs CHARACTER
The list item pairs (comma delimited) to use for this property
Top

PUBLIC PropertyDescriptor (character, character, character, logical, logical, EditorTypeEnum)
Purpose: Constructor for the PropertyDescriptor class
Notes:

Parameters:
pcDefiningTypeName CHARACTER
The name of the class that defines this property
pcPropertyName CHARACTER
The name for the property
pcPropertyLabel CHARACTER
The label for the property
plVisible LOGICAL
If the property should be visible
plEditable LOGICAL
If the property should be editable
poEditorType Consultingwerk.Framework.TypeDescriptor.EditorTypeEnum
The type of editor to use for the property
Top

PUBLIC PropertyDescriptor (character, character, character, logical, logical, EditorTypeEnum, character)
Purpose: Constructor for the PropertyDescriptor class
Notes:

Parameters:
pcDefiningTypeName CHARACTER
The name of the class that defines this property
pcPropertyName CHARACTER
The name for the property
pcPropertyLabel CHARACTER
The label for the property
plVisible LOGICAL
If the property should be visible
plEditable LOGICAL
If the property should be editable
poEditorType Consultingwerk.Framework.TypeDescriptor.EditorTypeEnum
The type of editor to use for the property
pcListItemPairs CHARACTER
The list item pairs (comma delimited) to use for this property
Top

PUBLIC PropertyDescriptor (character, character, EditorTypeEnum)
Purpose: Constructor for the PropertyDescriptor class
Notes:

Parameters:
pcDefiningTypeName CHARACTER
The name of the class that defines this property
pcPropertyName CHARACTER
The name for the property
poEditorType Consultingwerk.Framework.TypeDescriptor.EditorTypeEnum
The type of editor to use for the property
Top

PUBLIC PropertyDescriptor (character, character, EditorTypeEnum, character)
Purpose: Constructor for the PropertyDescriptor class
Notes:

Parameters:
pcDefiningTypeName CHARACTER
The name of the class that defines this property
pcPropertyName CHARACTER
The name for the property
poEditorType Consultingwerk.Framework.TypeDescriptor.EditorTypeEnum
The type of editor to use for the property
pcListItemPairs CHARACTER
The list item pairs (comma delimited) to use for this property
Top

PUBLIC PropertyDescriptor (character, character, logical, logical)
Purpose: Constructor for the PropertyDescriptor class
Notes:

Parameters:
pcDefiningTypeName CHARACTER
The name of the class that defines this property
pcPropertyName CHARACTER
The name for the property
plVisible LOGICAL
If the property should be visible
plEditable LOGICAL
If the property should be editable


Property Detail
Top

PUBLIC CHARACTER DefiningTypeName

Returns CHARACTER
Top

PUBLIC LOGICAL Editable

Returns LOGICAL
Top

PUBLIC Consultingwerk.Framework.TypeDescriptor.EditorTypeEnum EditorType

Returns Consultingwerk.Framework.TypeDescriptor.EditorTypeEnum
Top

PUBLIC CHARACTER ListItemPairs

Returns CHARACTER
Top

PUBLIC CHARACTER PropertyLabel

Returns CHARACTER
Top

PUBLIC CHARACTER PropertyName

Returns CHARACTER
Top

PUBLIC LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.XmlSerializable

Returns LOGICAL
Top

PUBLIC LOGICAL SerializeNullValues
Inherited from Consultingwerk.XmlSerializable

Returns LOGICAL
Top

PUBLIC LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.XmlSerializable

Returns LOGICAL
Top

PUBLIC LOGICAL Visible

Returns LOGICAL


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2024 18:37:26