Module cSigCJPropertyGrid.pkg

============================================================================== Project : SigCj - VDF Classes for Codejock File : cSigCJPropertyGrid.pkg Description : VDF Class for Codejock control Revision : $Rev: 599 $ $Date: 2009-10-14 05:39:01 -0400 (Wed, 14 Oct 2009) $ $Author: pak $ Martin Pincott Requirements : Visual DataFlex 12.1+ Codejock SuitePro - Version 12.0.0+ Copyright : (c) 2008 VDF SIG UK Visual DataFlex Special Interest Group UK. http://www.vdfsig.co.uk/ dev@vdfsig.co.uk This file is part of SigCj. SigCj is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 2.1 of the License, or (at your option) any later version. SigCj is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. If you have the complete SigCj workspace then a copy of the GNU Lesser General Public License is in the Docs folder. If not, see <http://www.gnu.org/licenses/>. ==============================================================================

cSigCJPropertyGrid.pkg (view source)
• import declarations
  • SigCjW_PropertyGrid.pkg (view source)
  • cSigCJMethods_Mixin.pkg (view source)
  • cSigCJGlobalSettings.pkg (view source)
  • StdFont.pkg (view source)
  • brdcster.pkg (view source)
• cSigCJPropertyGrid : cSigCjComPropertyGrid
  --------------------------------------------------- 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 ---------------------------------------------------
  • Construct_Object()
    Inherited from cSigCjComPropertyGrid
    • IntegerPrivate.peVisualTheme
      Define new Properties:
    • RealPrivate.prSplitterPos
    • BooleanPrivate.pbVariableSplitterPos
    • BooleanPrivate.pbHighlightChanged
    • BooleanPrivate.pbHelpVisible
    • IntegerPrivate.piHelpHeight
    • BooleanPrivate.pbToolbarVisible
    • BooleanPrivate.pbVariableHelpHeight
    • BooleanPrivate.pbVariableItemsHeight
    • BooleanPrivate.pbShowInPlaceButtonsAlways
    • IntegerPrivate.peBorderStyle
    • 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
    • oAllPropertyGridItems : Broadcaster
      Create child objects:
  • Set(Integer eTheme)
    Inherited from cSigCJMethods_Mixin
    Create and augment procedures and functions
  • IntegerpeVisualTheme()
  • Set(Real rSplitterPos)
    Inherited from cSigCJMethods_Mixin
    • BooleanbIsCreated
  • RealprSplitterPos()
  • Set(Boolean bState)
    Inherited from cSigCJMethods_Mixin
  • BooleanpbVariableSplitterPos()
  • Set(Boolean bState)
    Inherited from cSigCJMethods_Mixin
  • BooleanpbHighlightChanged()
  • Set(Boolean bState)
    Inherited from cSigCJMethods_Mixin
  • BooleanpbHelpVisible()
  • Set(Integer iHeight)
    Inherited from cSigCJMethods_Mixin
  • IntegerpiHelpHeight()
  • Set(Boolean bState)
    Inherited from cSigCJMethods_Mixin
  • BooleanpbToolbarVisible()
  • Set(Boolean bState)
    Inherited from cSigCJMethods_Mixin
  • BooleanpbVariableHelpHeight()
  • Set(Boolean bState)
    Inherited from cSigCJMethods_Mixin
  • BooleanpbVariableItemsHeight()
  • Set(Boolean bState)
    Inherited from cSigCJMethods_Mixin
  • BooleanpbShowInPlaceButtonsAlways()
  • Set(Integer eStyle)
    Inherited from cSigCJMethods_Mixin
  • IntegerpeBorderStyle()
  • 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 : ---------------------------------------------------
    • IntegerhoDDO
    • IntegerhoMainContainer
    • IntegeriClient_ID
  • OnCreate()
    Inherited from cComActiveXControl
  • 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 : ---------------------------------------------------
  • 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 ---------------------------------------------------
  • 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) ---------------------------------------------------
  • 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 ---------------------------------------------------
  • 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 ---------------------------------------------------
    • IntegerhoButton
    • IntegerhoItem
    • IntegerhoObject_ID
    • VariantvGridItem
  • OnClick()
    Fired when ever a combo is dropped down or expand button clicked
  • OnItemChanged(Handle hoItem)
    --------------------------------------------------- Procedure : OnItemChanged Scope : Public Event Paramaters : Handle hoItem Returns : None Purpose : Occurs when a value of any PropertyGridItem has changed. Notes : ---------------------------------------------------
  • 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 ---------------------------------------------------
    • IntegerhoItem
    • IntegerhoObject_ID
  • 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 ---------------------------------------------------
    • IntegerhoItem
    • IntegerhoObject_ID
• cSigCJPropertyGridItem_Mixin : Mixin
  --------------------------------------------------- Mixin Class : cSigCJPropertyGridItem_Mixin ---------------------------------------------------
  • Define_Standard_Item_Properties()
    • StringPrivate.psLabel
    • StringPrivate.psImage
    • StringPrivate.psHelpText
    • StringPrivate.psToolTip
    • BooleanPrivate.pbCreateExpanded
    • BooleanPrivate.pbLabelEmboldened
    • HandlePrivate.phoPropertyCaptionMetrics
    • HandlePrivate.phoPropertyValueMetrics
  • Bind_Metrics()
  • Set(String sLabel)
    Inherited from cSigCJMethods_Mixin
  • StringpsLabel()
  • Set(String sImage)
    Inherited from cSigCJMethods_Mixin
    • IntegeriImageID
  • StringpsImage()
  • Set(String sHelpText)
    Inherited from cSigCJMethods_Mixin
  • StringpsHelpText()
  • Set(String sToolTip)
    Inherited from cSigCJMethods_Mixin
  • StringpsToolTip()
  • Set(Boolean bExpanded)
    Inherited from cSigCJMethods_Mixin
    • BooleanbExpandable
  • BooleanpbCreateExpanded()
  • Set(Boolean bState)
    Inherited from cSigCJMethods_Mixin
    • IntegerhoFont
    • VariantvFont
    • BooleanbUnderlined
  • BooleanpbLabelEmboldened()
• cSigCJPropertyGridCategory : cSigCjComPropertyGridItem
  --------------------------------------------------- Class : cSigCJPropertyGridCategory Superclass : cSigCjComPropertyGridItem Package : cSigCJPropertyGrid.pkg Mixins : cSigCJPropertyGridItem_Mixin Description : Categories are used to group PropertyGritItems into groups within the PropertyGrid. Categories have an expand/collapse button that can be used to Show/hide the PropertyGridItems that belong the the category. Properties : psLabel (String) psHelpText (String) psToolTip (String) pbCreateExpanded (Boolean) pbLabelEmboldened (Boolean) Events : Methods : Notes : To Do : ---------------------------------------------------
  • Construct_Object()
    Inherited from cSigCjComPropertyGridItem
  • Private.Create(Handle hoParent Boolean bRecursive)
    Create and augment procedures and functions
    • VariantvCategory
• cSigCJPropertyGridItem : cSigCjComPropertyGridItem
  --------------------------------------------------- Class : cSigCJPropertyGridItem Superclass : cSigCjComPropertyGridItem Package : cSigCJPropertyGrid.pkg Mixins : cSigCJPropertyGridItem_Mixin Description : Represents an item in the Property Grid. Properties : psLabel (String) psHelpText (String) psToolTip (String) pbCreateExpanded (Boolean) pbLabelEmboldened (Boolean) peItemType (Integer) pvValue (Variant) pbDefaultAsInitialValue (Boolean) pvDefaultValue (Variant) pvInitialValue (Variant) pvTag (Variant) pbHidden (Boolean) pbReadOnly (Boolean) pbPassword_State (Boolean) pbCapslock_State (Boolean) piForm_Margin (Integer) piValueBackgroundColor (Integer) psImage (String) psFormat (String) READ-ONLY *** Item_Server (Handle) Item_Data_Field (Integer) Events : OnChange OnEditAfter OnMoveItemDataIn OnMoveItemDataOut Methods : Procedure Set PropertyItemMask (String llMask String llLiteral Variant llPrompt) Procedure BindToDatabase (integer hFile integer iField) MoveItemDataToDatabase ReadItemFromDatabase Notes : Example call of BindToDatabase: Send BindToDatabase File_Field Sysfile.Field_1 To Do : ---------------------------------------------------
  • Construct_Object()
    Inherited from cSigCjComPropertyGridItem
    • IntegerPrivate.peItemType
    • VariantPrivate.pvValue
    • BooleanpbDefaultAsInitialValue
    • VariantPrivate.pvDefaultValue
    • VariantPrivate.pvTag
    • tdPropertyItemMaskptPropertyItemMask
    • BooleanPrivate.pbHidden
    • BooleanPrivate.pbReadOnly
    • BooleanPrivate.pbIsPassword
    • BooleanPrivate.pbCapslock
    • IntegerPrivate.piFormMargin
    • IntegerPrivate.piValueBackgroundColor
    • StringPrivate.psFormat
    • HandlePrivate.phoPropertyGridItemServer
      If this item is linked to a field in a database, we may like properties to store the server and field values
    • IntegerPrivate.piPropertyGridItemDataField
  • End_Construct_Object()
  • HandleItem_Server()
    Create and augment procedures and functions
  • IntegerItem_Data_Field()
  • MoveItemDataToDatabase()
    --------------------------------------------------- Procedure : MoveItemDataToDatabase Scope : Public Paramaters : None Returns : None Purpose : If item is bound to the database (file and field) it will simply set the field_changed_value of the item's server DDO with the value of the property grid item. Notes : Could be Broadcast as part of a save process. Take care however. If the item has a combo form it MAY be that you DON'T want to save the value (decription) but instead would want to save the itemdata or code value! If this is the case, the method can be augmented in the item object to "Get CodeFromDescription" of whatever ---------------------------------------------------
    • IntegerhoDD
    • IntegeriField
    • IntegereType
    • IntegeriValidationType
    • VariantvValue
    • StringsTrue
    • StringsFalse
    • StringsMask
  • ReadItemFromDatabase()
    --------------------------------------------------- Procedure : ReadItemFromDatabase Scope : Public Paramaters : None Returns : None Purpose : If item is bound to the database (file and field) it will simply get the field_current_value of the item's server DDO and set the value of the property grid item. Notes : Could be Broadcast as part of an initialise process Take care however. If the item has a combo form it MAY be that you DON'T want to set the value with the raw data but instead with a descriptive value. If this is the case, use Get DescriptionFromCode of the comboitem and set the value with this instead. ---------------------------------------------------
    • IntegerhoDD
    • IntegeriField
    • IntegeriValidationType
    • IntegeriType
    • VariantvValue
    • StringsState
    • DatedDate
  • Set(Integer eType)
    Inherited from cSigCJPropertyGridItem_Mixin
  • StringpeItemType()
  • Set(Variant vValue)
    Inherited from cSigCJPropertyGridItem_Mixin
  • StringpvValue()
    • VariantvValue
  • Set(Variant vValue)
    Inherited from cSigCJPropertyGridItem_Mixin
  • StringpvDefaultValue()
    • VariantvValue
  • Set(Variant vValue)
    Inherited from cSigCJPropertyGridItem_Mixin
    --------------------------------------------------- Procedure : Set pvInitialValue Scope : Public Paramaters : Variant (vVal) Returns : None Purpose : Can be used to set both the value AND the default value (to be the same) at the same time Notes : If setting a value from event OnMoveItemDataIn then this is a useful way of setting both the value AND the default Otherwise, because the initial value is set during Private.OnCreate, any value applied afterwards will be seen to be different (the default will be the intial value - undefined) ---------------------------------------------------
  • Set(Variant vValue)
    Inherited from cSigCJPropertyGridItem_Mixin
  • StringpvTag()
  • Set(Boolean bHidden)
    Inherited from cSigCJPropertyGridItem_Mixin
  • BooleanpbHidden()
  • Set(Boolean bReadOnly)
    Inherited from cSigCJPropertyGridItem_Mixin
  • BooleanpbReadOnly()
  • Set(Boolean bState)
    Inherited from cSigCJPropertyGridItem_Mixin
  • BooleanpbPassword_State()
  • Set(Boolean bState)
    Inherited from cSigCJPropertyGridItem_Mixin
  • BooleanpbCapslock_State()
  • Set(Integer iWidth)
    Inherited from cSigCJPropertyGridItem_Mixin
  • IntegerpiForm_Margin()
  • Set(Integer iColor)
    Inherited from cSigCJPropertyGridItem_Mixin
  • IntegerpiValueBackgroundColor()
  • Set(String sFormat)
    Inherited from cSigCJPropertyGridItem_Mixin
  • StringpsFormat()
  • Set(String llMask String llLiteral Variant llPrompt)
    Inherited from cSigCJPropertyGridItem_Mixin
    --------------------------------------------------- Procedure : Set PropertyItemMask Scope : Public Paramaters : llMask, llLiteral, llPrompt Returns : None Purpose : Sets the mask of a property grid item Notes : You can use any of these characters for defining your edit mask: 0 - Numeric (0-9) 9 - Numeric (0-9) or space (' ') # - Numeric (0-9) or space (' ') or ('+') or ('-') L - Alpha (a-Z) ? - Alpha (a-Z) or space (' ') a - Alpha numeric (0-9 and a-Z) a - Alpha numeric (0-9 and a-Z) or space (' ') & - All Print character only H - Hex digit (0-9 and a-F) X - Hex digit (0-9 and a-F) and space (' ') > - Forces characters to upper Case (a-Z) < - Forces characters to lower Case (a-z) llLiteral defines the prompt area of the mask where text entry is allowed. This should match the areas that you have already defined as mask fields. By default the prompt character is '_' . llPrompt is optional, but allows you to define default characters that you want displayed when the user presses the backspace key. This usually represents data that has been previously saved then restored. This makes it easy for the user to restore some or all of the default text displayed when the control was initialized. ---------------------------------------------------
    • tdPropertyItemMasktPropertyItemMask
  • DoApplyMask()
    --------------------------------------------------- Procedure : DoApplyMask Scope : Private Paramaters : None Returns : None Purpose : Called from Private.Create. Applies any mask set using 'Set PropertyItemMask' Notes : Called internally. Developer does not need to concern themself with this ---------------------------------------------------
    • tdPropertyItemMasktPropertyItemMask
  • BindToDataBase(Integer hFile Integer iField)
    --------------------------------------------------- Procedure : BindToDataBase Scope : Public Paramaters : iFile iField Returns : None Purpose : Links a grid item with the db (file and field). Sets Private.phoPropertyGridItemServer and Private.piPropertyGridItemDataField Notes : If an item is linked to the db, pbCapslock_State and piForm_Margin will be set automatically. If you don't Set psLabel or psHelpText these too will be taken from the DD Example Call: Send BindToDataBase File_Field Sysfile.Company_Name ---------------------------------------------------
    • IntegerhoDDO
    • IntegeriLength
    • IntegeriType
    • IntegeriValidationType
    • IntegeriPrecision
    • BooleanbOptionEnabled
    • StringsStatusHelp
    • StringsLabel
  • Private.Create(Handle hoParent Boolean bRecursive)
    • VariantvItem
    • IntegeriEditStyle
    • IntegereType
    • IntegerhoItem
  • OnChange()
    OnChange Called whenever an item's value is changed and user exists the item
  • OnEditAfter(String ByRef llNewValue Boolean ByRef llCancel)
    OnEditAfter Called whenever an item's value has been editted. Setting llCancel to True will stop the edit
  • OnMoveItemDataIn()
    OnMoveItemDataIn Called from DoMoveDataIn (of the property grid). This is called from OnCreate and can be used to set item data (appy from database,say)
  • OnMoveItemDataOut()
    OnMoveItemDataOut Called from DoMoveDataOut (of the property grid). This can be used to save item data to the database, say
• cSigCJPropertyGridSubCategory : cSigCJPropertyGridItem
  --------------------------------------------------- Class : cSigCJPropertyGridSubCategory Superclass : cSigCJPropertyGridItem Package : cSigCJPropertyGrid.pkg Mixins : Description : Property Grid Item in style of Category. Used for Sub Categorising items with Categories Properties : psLabel (String) psHelpText (String) psToolTip (String) pbCreateExpanded (Boolean) pbLabelEmboldened (Boolean) Events : Methods : Notes : To Do : ---------------------------------------------------
  • Construct_Object()
    Inherited from cSigCJPropertyGridItem
• cSigCJPropertyGridItemButton_Mixin : Mixin
  --------------------------------------------------- Mixin Class : cSigCJPropertyGridItemButton_Mixin ---------------------------------------------------
  • Define_Item_Button_Properties()
    • StringPrivate.psButtonCaption
    • BooleanPrivate.pbButtonEnabled
    • StringPrivate.psButtonImage
    • IntegerPrivate.piButtonID
    • StringPrivate.psButtonToolTip
    • IntegerPrivate.piButtonWidth
    • HandlePrivate.phoButtonObject
  • Set_Item_Button_Properties()
  • Set(String sCaption)
  • StringpsButtonCaption()
  • Set(Boolean bEnabled)
  • BooleanpbButtonEnabled()
  • Set(String sTooltip)
  • StringpsButtonTooltip()
  • Set(String sImage)
    • IntegeriIndex
  • StringpsButtonImage()
  • Set(Integer iID)
  • IntegerpiButtonID()
  • Set(Integer iWidth)
  • IntegerpiButtonWidth()
  • IntegerpiButtonIndex()
    --------------------------------------------------- Function : piButtonIndex Scope : Read Only Paramaters : None Returns : Integer Purpose : Retrieves index of button in array of item's buttons Notes : ---------------------------------------------------
    • IntegeriIndex
  • VariantpvItem()
    --------------------------------------------------- Function : pvItem Scope : Read Only Paramaters : None Returns : Variant (IdDispatch) Purpose : Retrieves the parent property grid item for this button (item that this button is drawn in). Notes : ---------------------------------------------------
    • VariantvItem
  • OnClick()
    Fired when ever a combo is dropped down or expand button clicked
• cSigCJPropertyGridExpandBtnItem : cSigCJPropertyGridItem
  --------------------------------------------------- Class : cSigCJPropertyGridExpandBtnItem Superclass : cSigCJPropertyGridItem Package : cSigCJPropertyGrid.pkg Mixins : cSigCJPropertyGridItemButton_Mixin Description : Property Grid Item with Expand (lookup) button '...' Properties : psLabel (String) psHelpText (String) psToolTip (String) pbCreateExpanded (Boolean) pbLabelEmboldened (Boolean) peItemType (Integer) pvValue (Variant) pbDefaultAsInitialValue (Boolean) pvDefaultValue (Variant) pvInitialValue (Variant) pvTag (Variant) pbHidden (Boolean) pbReadOnly (Boolean) pbPassword_State (Boolean) pbCapslock_State (Boolean) piForm_Margin (Integer) piValueBackgroundColor (Integer) psButtonCaption (String) pbButtonEnabled (Boolean) psButtonImage (String) piButtonWidth (Integer) psButtonTooltip (String) Events : OnClick OnChange OnEditAfter OnMoveItemDataIn OnMoveItemDataOut Methods : Procedure Set PropertyItemMask (String llMask String llLiteral Variant llPrompt) Notes : To Do : ---------------------------------------------------
  • Construct_Object()
    Inherited from cSigCJPropertyGridItem
  • Private.Create(Handle hoParent Boolean bRecursive)
    Inherited from cSigCJPropertyGridItem
    • VariantvButton
• cSigCJPropertyGridComboFormItem : cSigCJPropertyGridItem
  --------------------------------------------------- Class : cSigCJPropertyGridComboFormItem Superclass : cSigCJPropertyGridItem Package : cSigCJPropertyGrid.pkg Mixins : cSigCJPropertyGridItemButton_Mixin Description : Property Grid Item with Drop Down ComboForm Properties : psLabel (String) psHelpText (String) psToolTip (String) pbCreateExpanded (Boolean) pbLabelEmboldened (Boolean) peItemType (Integer) pvValue (Variant) pbDefaultAsInitialValue (Boolean) pvDefaultValue (Variant) pvInitialValue (Variant) pvTag (Variant) pbHidden (Boolean) pbReadOnly (Boolean) pbPassword_State (Boolean) pbCapslock_State (Boolean) piForm_Margin (Integer) piValueBackgroundColor (Integer) psButtonCaption (String) pbButtonEnabled (Boolean) psButtonImage (String) piButtonWidth (Integer) psButtonTooltip (String) Events : OnClick OnChange OnEditAfter OnMoveItemDataIn OnMoveItemDataOut OnAddLookupItems Methods : Procedure Set PropertyItemMask (String llMask String llLiteral Variant llPrompt) Procedure Set LookupItemImage (Integer iItemIndex String sImage) Procedure Set LookupItemData (Integer iItemIndex Integer iItemData) Procedure AddLookupItem (String sDescription Integer iItemData String sImage Variant vCode) Function CodeFromDescription (String sDescription Boolean ByRef bFound Returns Variant) Function ItemDataFromDescription (String sDescription Boolean ByRef bFound Returns Integer) Function DescriptionFromCode (Variant vCode Boolean ByRef bFound Returns String) Procedure ComboDeleteItems Notes : To Do : ---------------------------------------------------
  • Construct_Object()
    Inherited from cSigCJPropertyGridItem
    • tdGridItemSelectionValue[]ptaGridItemSelectionValue
  • End_Construct_Object()
    Inherited from cSigCJPropertyGridItem
  • OnAddLookupItems()
    --------------------------------------------------- Procedure : OnAddLookupItems Scope : Public Event Paramaters : None Returns : None Purpose : Intended that you would call "Send AddLookupItem" from this event to populate the combo Notes : If the item is bound to a data field that has a Field_Table_Object the combo will automatically be populated. If you want to add images you should forward Send OnAddLookupItems and then add the images ---------------------------------------------------
  • ComboDeleteItems()
    --------------------------------------------------- Procedure : ComboDeleteItems Scope : Public Method Paramaters : None Returns : None Purpose : Can be used to clear all of a comboforms data items Notes : ---------------------------------------------------
    • IntegerhoConstraint_s
    • VariantvConstraint_s
    • tdGridItemSelectionValue[]taGridItemSelectionValues
  • DoAddLookupItems()
    --------------------------------------------------- Procedure : DoAddLookupItems Scope : Private Paramaters : None Returns : None Purpose : Called from Private.Create. Adds any lookup items to the list of constraints Notes : Called internally. Developer does not need to concern themself with this ---------------------------------------------------
    • IntegerhoConstraint_s
    • IntegerhoConstraint
    • VariantvConstraint_s
    • VariantvConstraint
    • IntegeriItems
    • IntegeriItemIndex
    • tdGridItemSelectionValue[]taGridItemSelectionValues
  • AddLookupItem(String sDescription Integer iItemData String sImage Variant vCode)
    --------------------------------------------------- Procedure : AddLookupItem Scope : Public Paramaters : sCaption, iData, sImage, vCode Returns : None Purpose : 'Registers' an item for inclusion in list of item constraints (lookup values) Notes : vCode is added because it could be that the developer wants to display a descriptive value whilst mapping to a code value in the background (the code being the value that ultimately will be saved to the database) ---------------------------------------------------
    • tdGridItemSelectionValue[]taGridItemSelectionValue
    • IntegeriItems
    • IntegeriIconIndex
  • Set(Integer iItemIndex String sImage)
    Inherited from cSigCJPropertyGridItemButton_Mixin
    --------------------------------------------------- Procedure : Set LookupItemImage Scope : Public Paramaters : Integer iItemIndex String sImage Returns : None Purpose : Sets icon index for specified lookup item. Notes : MUST be called AFTER AddLookupItem ---------------------------------------------------
    • tdGridItemSelectionValue[]taGridItemSelectionValue
    • IntegeriImageIndex
  • Set(Integer iItemIndex Integer iItemData)
    Inherited from cSigCJPropertyGridItemButton_Mixin
    --------------------------------------------------- Procedure : Set LookupItemData Scope : Public Paramaters : Integer iItemIndex Integer iItemData Returns : None Purpose : Sets item data for specified lookup item. Notes : MUST be called AFTER AddLookupItem ---------------------------------------------------
    • tdGridItemSelectionValue[]taGridItemSelectionValue
  • IntegerConstraintDescriptionComparison(tdGridItemSelectionValue tDesc1 tdGridItemSelectionValue tDesc2)
    --------------------------------------------------- Function : ConstraintDescriptionComparison Scope : Private Paramaters : tdGridItemSelectionValue x2 (for comparison) Returns : Integer Purpose : To compare the Description elements of 2 structs. Notes : Used internally from CodeFromDescription and ItemDataFromDescription ---------------------------------------------------
    • IntegeriRetVal
  • VariantCodeFromDescription(String sDescription Boolean ByRef bFound)
    --------------------------------------------------- Function : CodeFromDescription Scope : Public Paramaters : sDescription, bFound (byref) Returns : Variant (vCode) Purpose : If you have the current value of an property item and you know this is one of a list of constraints you can call this function to return the 'Code' value that is associated with this 'Description' value Notes : bFound is passed by reference and tells the developer if the value that they were looking for was found or not. You can't rely on a return value of 0 (or blank) as an indication of whether it was found because these may be valid values ---------------------------------------------------
    • IntegeriSearchIndex
    • VariantvRetVal
    • tdGridItemSelectionValue[]taGridItemSelectionValues
    • tdGridItemSelectionValuetGridItemSelectionValue
  • IntegerItemDataFromDescription(String sDescription Boolean ByRef bFound)
    --------------------------------------------------- Function : ItemDataFromDescription Scope : Public Paramaters : sDescription, bFound (byref) Returns : Integer (iItemData) Purpose : If you have the current value of an property item and you know this is one of a list of constraints you can call this function to return the iItemData value that is associated with this 'Description' value Notes : bFound is passed by reference and tells the developer if the value that they were looking for was found or not. You can't rely on a return value of 0 (or blank) as an indication of whether it was found because these may be valid values ---------------------------------------------------
    • IntegeriRetVal
    • IntegeriSearchIndex
    • tdGridItemSelectionValue[]taGridItemSelectionValues
    • tdGridItemSelectionValuetGridItemSelectionValue
  • IntegerConstraintCodeComparison(tdGridItemSelectionValue tCode1 tdGridItemSelectionValue tCode2)
    --------------------------------------------------- Function : ConstraintCodeComparison Scope : Private Paramaters : tdGridItemSelectionValue x2 (for comparison) Returns : Integer Purpose : To compare the Code elements of 2 structs. Notes : Used internally from DescriptionFromCode ---------------------------------------------------
    • IntegeriRetVal
  • StringDescriptionFromCode(Variant vCode Boolean ByRef bFound)
    --------------------------------------------------- Function : DescriptionFromCode Scope : Public Paramaters : vCode, bFound (byref) Returns : sDescription Purpose : If a property grid item has a combo form with descriptions and associated code values then you can call this function to determine the description value for a specified code. This is most useful when populating the grid from a database where the raw data is a code value but you wish to show a descriptive value in the control (think dbcomforms) Notes : bFound is passed by reference and tells the developer if the value that they were looking for was found or not. You can't rely on a return value of 0 (or blank) as an indication of whether it was found because these may be valid values ---------------------------------------------------
    • StringsRetVal
    • IntegeriSearchIndex
    • tdGridItemSelectionValue[]taGridItemSelectionValues
    • tdGridItemSelectionValuetGridItemSelectionValue
  • BindToDataBase(Integer hFile Integer iField)
    Inherited from cSigCJPropertyGridItem
    --------------------------------------------------- Function : BindToDataBase Scope : Public Paramaters : Integer hFile Integer iField Returns : None Purpose : Forward Send, but then because this is a combo item, see if there is a validation table for this field If so, set the lookup items with the values from the validation table Notes : Set pbCapslock_State to False if there is a codevalidation table. It may be a capslock field, but this will be for the code, not the description (that we will be displaying) ---------------------------------------------------
    • Variant[][]vTableData
    • IntegeriTableObject
    • IntegeriItem
    • IntegerhoDD
  • ReadItemFromDatabase()
    Inherited from cSigCJPropertyGridItem
    --------------------------------------------------- Function : ReadItemFromDatabase Scope : Public Paramaters : None Returns : None Purpose : Forward Send, but then because this is a combo item, see if we have a description that matches our value If so, display this instead ---------------------------------------------------
    • IntegerhoDD
    • IntegeriField
    • VariantvValue
    • BooleanbFound
    • StringsDescription
  • MoveItemDataToDatabase()
    Inherited from cSigCJPropertyGridItem
    • IntegerhoDD
    • IntegeriField
    • VariantvValue
    • VariantvCode
    • BooleanbFound
  • Private.Create(Handle hoParent Boolean bRecursive)
    Inherited from cSigCJPropertyGridItem
    • VariantvButton
    • IntegerhoButtons
• cSigCJPropertyGridItemSpinAndSlider_Mixin : Mixin
  --------------------------------------------------- Mixin Class : cSigCJPropertyGridItemSpinAndSlider_Mixin ---------------------------------------------------
  • Define_SpinForm_and_Slider_Properties()
    • IntegerPrivate.piMax
    • IntegerPrivate.piMin
    • IntegerPrivate.piWidth
  • Set(Integer iMax)
  • IntegerpiMaximum()
  • Set(Integer iMin)
  • IntegerpiMinimum()
  • Set(Integer iWidth)
  • IntegerpiWidth()
  • ApplySettings()
• cSigCJPropertyGridSpinFormItem : cSigCJPropertyGridItem
  --------------------------------------------------- Class : cSigCJPropertyGridSpinFormItem Superclass : cSigCJPropertyGridItem Package : cSigCJPropertyGrid.pkg Mixins : cSigCJPropertyGridItemSpinAndSlider_Mixin Description : Property Grid Item with built in SpinForm Object Properties : psLabel (String) psHelpText (String) psToolTip (String) pbCreateExpanded (Boolean) pbLabelEmboldened (Boolean) peItemType (Integer) pvValue (Variant) pbDefaultAsInitialValue (Boolean) pvDefaultValue (Variant) pvInitialValue (Variant) pvTag (Variant) pbHidden (Boolean) pbReadOnly (Boolean) pbPassword_State (Boolean) pbCapslock_State (Boolean) piForm_Margin (Integer) piValueBackgroundColor (Integer) piMin (Integer) piMax (Integer) piWidth (Integer) Events : OnChange OnEditAfter OnMoveItemDataIn OnMoveItemDataOut Methods : Procedure Set PropertyItemMask (String llMask String llLiteral Variant llPrompt) Notes : To Do : ---------------------------------------------------
  • Construct_Object()
    Inherited from cSigCJPropertyGridItem
    • HandlePrivate.phoButtonObject
  • Private.Create(Handle hoParent Boolean bRecursive)
    Inherited from cSigCJPropertyGridItem
    • VariantvButton
• cSigCJPropertyGridSliderCtlItem : cSigCJPropertyGridItem
  --------------------------------------------------- Class : cSigCJPropertyGridSliderCtlItem Superclass : cSigCJPropertyGridItem Package : cSigCJPropertyGrid.pkg Mixins : cSigCJPropertyGridItemSpinAndSlider_Mixin Description : Property Grid Item with built in Slider Control Properties : psLabel (String) psHelpText (String) psToolTip (String) pbCreateExpanded (Boolean) pbLabelEmboldened (Boolean) peItemType (Integer) pvValue (Variant) pbDefaultAsInitialValue (Boolean) pvDefaultValue (Variant) pvInitialValue (Variant) pvTag (Variant) pbHidden (Boolean) pbReadOnly (Boolean) pbPassword_State (Boolean) pbCapslock_State (Boolean) piForm_Margin (Integer) piValueBackgroundColor (Integer) piMin (Integer) piMax (Integer) piWidth (Integer) Events : OnChange OnEditAfter OnMoveItemDataIn OnMoveItemDataOut Methods : Procedure Set PropertyItemMask (String llMask String llLiteral Variant llPrompt) Notes : To Do : ---------------------------------------------------
  • Construct_Object()
    Inherited from cSigCJPropertyGridItem
    • HandlePrivate.phoButtonObject
  • Private.Create(Handle hoParent Boolean bRecursive)
    Inherited from cSigCJPropertyGridItem
    • VariantvButton

References (3):

Field References (0):