VALUEBYNAME method (PropertyGrid) [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== VALUEBYNAME method (PropertyGrid) ======


 
==== Description ====
 
 
Returns the value of the named property item.
 
 
 
 
==== Syntax ====
 
<code>
itemValue = Exec_Method( ctrlEntID,     

                            "VALUEBYNAME", 

                            name,

                            newValue )
 
</code>
 
 
==== Parameters ====
 
 
 
^Name^Required^Description^
|name|Yes|Name of a property item|
|newValue|No|New value for the property|

 


 
==== Returns ====
 
 
Current value of the specified property item.
 
 
 
 
==== Remarks ====
 
 
The value depends on the type of the property item.  If the property item has a type of PGIT_COLOR$ then the returned data will be an RGB color value, if the property item has a type of PGIT_EDIT$ then the value will be a string, and so on.
 
 
 
 
==== Example ====
 
<code>
 
$Insert PS_Property_Grid_Equates

   $Insert Logical

   

   CtrlEntID = @Window : ".PRG_MAIN"

   

   // Set the full list of items...

   //

   // Data

   //    Title    - Yadda

   //    SubTitle - Whatever

   // UI

   //    Visible - TRUE$

   //    Color   - 0xFF (red)

   

   Pgl     = "Data" : @Vm : "Title"    : @Vm : PS_PGI_EDIT$     : @Vm : "Yadda"

   Pgl<-1> = "Data" : @Vm : "SubTitle" : @Vm : PS_PGI_EDIT$     : @Vm : "Whatever"

   Pgl<-1> = "UI"   : @Vm : "Visible"  : @Vm : PS_PGI_CHECK$    : @Vm : TRUE$

   Pgl<-1> = "UI"   : @Vm : "Color"    : @Vm : PS_PGI_COLORDLG$ : @Vm : 0xFF

   

   Call Set_Property_Only( CtrlEntID, "LISTX", Pgl )

   

   // Hide all "Data" items...

   Call Exec_Method( CtrlEntID, "COLLAPSE", "Data" )

   

   // Get the value of the "Color" item

   ItemVal  = Exec_Method( CtrlEntID, "VALUEBYNAME", "Color" )
 
 
 

</code>

 
==== See Also ====
 
 
[[value_property_propertygrid|VALUE property]]
 
[[valuebypos_method_propertygrid|VALUEBYPOS method]]