Class: cSigCJPropertyGrid

--------------------------------------------------- Class : cSigCJPropertyGrid Superclass : cSigCjComPropertyGrid Package : cSigCJPropertyGrid.pkg Mixins : cSigCJImage_Manager_Mixin Description : Represents a PropertyGrid control. The property grid comes with a built in toolbar for easy sorting and grouping, and a help panel to display information on each selected item. Properties : peVisualTheme (Integer) prSplitterPos (Real) pbVariableSplitterPos (Boolean) pbHighlightChanged (Boolean) pbHelpVisible (Bolean) piHelpHeight (Integer) pbToolbarVisible (Boolean) pbVariableHelpHeight (Boolean) pbVariableItemsHeight (Boolean) pbShowInPlaceButtonsAlways (Boolean) peBorderStyle (Integer) Events : OnMoveDataIn OnMoveDataOut OnItemChanged (Handle hoItem) Methods : Procedure DoMoveDataIn Procedure DoMoveDataOut Procedure Apply Procedure DoEnumerateAllPropertyGridItems Function AddImage (String sImage Integer iId Integer eImageType Returns Integer) Notes : To Do : Currently unable to get psFormat to work for item type 'double'. Need to look at this ---------------------------------------------------

Class Hierarchy:

DFCOMACTIVEXCONTROL

cComActiveXControl

cSigCjComPropertyGrid

cSigCJPropertyGrid

Mixins:

cSigCJMethods_Mixin,

Class Definition

Properties

HandlephoMainContainerObjectID

Property phoMainContainerObjectID The object ID of the main container object (ie the view) that contains any DDs that this grid will use Set automatically (in Item_Data_Set) if not specified, but can be set by the developer

BooleanPrivate.pbHelpVisible

BooleanPrivate.pbHighlightChanged

BooleanPrivate.pbShowInPlaceButtonsAlways

BooleanPrivate.pbToolbarVisible

BooleanPrivate.pbVariableHelpHeight

BooleanPrivate.pbVariableItemsHeight

BooleanPrivate.pbVariableSplitterPos

IntegerPrivate.peBorderStyle

IntegerPrivate.peVisualTheme

Define new Properties:

IntegerPrivate.piHelpHeight

RealPrivate.prSplitterPos

Functions and Procedures

Apply()

--------------------------------------------------- Procedure : Apply Scope : Public Method Paramaters : None Returns : None Purpose : Simply sends DoMoveDataOut Notes : If you have coded OnMoveDataOut and OnMoveItemDataOut to save data to the database, it can be triggered simply by calling 'Apply' of the control ---------------------------------------------------

Construct_Object()

Inherited from cSigCjComPropertyGrid

DoEnumerateAllPropertyGridItems(Integer iMsg)

--------------------------------------------------- Procedure : DoEnumerateAllPropertyGridItems Scope : Public Paramaters : iMsg Returns : None Purpose : As objects of type cSigCJPropertyGridItem are created they are registered with a Broadcaster object DoEnumerateAllPropertyGridItems simply sends the passed message to all registered objects Notes : ---------------------------------------------------

DoMoveDataIn()

--------------------------------------------------- Procedure : DoMoveDataIn Scope : Public Method Paramaters : None Returns : None Purpose : Calls OnMoveDataIn of the property grid object and also OnMoveItemDataIn of all property grid item objects Notes : Can be called as a means of loading the property grid items with data ---------------------------------------------------

DoMoveDataOut()

--------------------------------------------------- Procedure : DoMoveDataOut Scope : Public Method Paramaters : None Returns : None Purpose : Calls OnMoveDataOut of the property grid object and also OnMoveItemDataOut of all property grid item objects Notes : Can be called as a means of saving the property grid's data (from Request_save for example) ---------------------------------------------------

HandleItem_Data_Set(Integer iFile_Number)

--------------------------------------------------- Procedure : Item_Data_Set Scope : Private Paramaters : iFile_Number Returns : Handle Purpose : Pass a file number and this function will return the object id of the DDO in the view whose main_file matches the passed value. Uses internally when binding property grid items to a database (Procedure BindToDataBase) Notes : ---------------------------------------------------

OnClick()

Fired when ever a combo is dropped down or expand button clicked

OnComAfterEdit(Variant llItem String ByRef llNewValue Boolean ByRef llCancel)

Inherited from cSigCjCom_DPropertyGridEvents

--------------------------------------------------- Procedure : OnComAfterEdit Scope : Private Event Paramaters : llItem, llNewValue (byRef), llCancel (byRef) Returns : None Purpose : Called when an edit operation is complete Sends OnEditAfter message to item object Notes : Called internally. Developer does not need to concern themself with this ---------------------------------------------------

OnComInplaceButtonDown(Variant llButton Variant llCancel)

Inherited from cSigCjCom_DPropertyGridEvents

--------------------------------------------------- Procedure : OnComInplaceButtonDown Scope : Private Event Paramaters : llButton, llCancel Returns : None Purpose : Called when ever an items lookup button is clicked. Sends OnClick to the appropriate item object Notes : Called internally. Developer does not need to concern themself with this Only objects of class cSigCJPropertyGridComboFormItem and cSigCJPropertyGridExpandbtnItem will receive OnClick ---------------------------------------------------

OnComValueChanged(Variant llItem)

Inherited from cSigCjCom_DPropertyGridEvents

--------------------------------------------------- Procedure : OnComValueChanged Scope : Private Event Paramaters : llItem Returns : None Purpose : Occurs when the value of a PropertyGridItem has changed. Sends OnChange message to item object Notes : Called internally. Developer does not need to concern themself with this ---------------------------------------------------

OnCreate()

Inherited from cComActiveXControl

OnItemChanged(Handle hoItem)

--------------------------------------------------- Procedure : OnItemChanged Scope : Public Event Paramaters : Handle hoItem Returns : None Purpose : Occurs when a value of any PropertyGridItem has changed. Notes : ---------------------------------------------------

OnMoveDataIn()

--------------------------------------------------- Procedure : OnMoveDataIn Scope : Event Paramaters : None Returns : None Purpose : Called from DoMoveDataIn. Simple hook that can used for moving data into the control (ie find a record in a dd) Notes : The message OnMoveItemDataIn will also be sent to all grid items ---------------------------------------------------

OnMoveDataOut()

--------------------------------------------------- Procedure : OnMoveDataOut Scope : Event Paramaters : None Returns : None Purpose : Called from DoMoveDataOut. Simple hook that can used for moving data out of the control Notes : The message OnMoveItemDataOut will also be sent to all grid items ---------------------------------------------------

BooleanpbHelpVisible()

BooleanpbHighlightChanged()

BooleanpbShowInPlaceButtonsAlways()

BooleanpbToolbarVisible()

BooleanpbVariableHelpHeight()

BooleanpbVariableItemsHeight()

BooleanpbVariableSplitterPos()

IntegerpeBorderStyle()

IntegerpeVisualTheme()

IntegerpiHelpHeight()

RealprSplitterPos()

Set(Integer eTheme)

Inherited from cSigCJMethods_Mixin

Create and augment procedures and functions

Set(Real rSplitterPos)

Inherited from cSigCJMethods_Mixin

Set(Boolean bState)

Inherited from cSigCJMethods_Mixin

Set(Boolean bState)

Inherited from cSigCJMethods_Mixin

Set(Boolean bState)

Inherited from cSigCJMethods_Mixin

Set(Integer iHeight)

Inherited from cSigCJMethods_Mixin

Set(Boolean bState)

Inherited from cSigCJMethods_Mixin

Set(Boolean bState)

Inherited from cSigCJMethods_Mixin

Set(Boolean bState)

Inherited from cSigCJMethods_Mixin

Set(Boolean bState)

Inherited from cSigCJMethods_Mixin

Set(Integer eStyle)

Inherited from cSigCJMethods_Mixin

References (2):