TOOLTIPHWND Property


PLBCMP GUI Only

square.png Objects

 

The TOOLTIPHWND property returns the tool tip window handle of an object. The property uses the following format:

TOOLTIPHWND={value}

Note the following:

  1. TOOLTIPHWND may be used in GETPROP statements only.

  2. {value} is a numeric variable that receives the tool tip window handle.

  3. It should be noted that a unique tool tip window is created for each PLB PANEL\WINDOW object that has at least one PLB object using the TOOLTIP property. Therefore, when a PLB program uses the Windows 'SendMessage' API to change the OS tooltip behaviors and attributes, a change to a PLB object that is a child to a specific PANEL\WINDOW will affect all of the children objects attached to that and ONLY that specific PANEL\WINDOW object. The PLB program must perform a Windows 'SendMessage' API operation to one child object for every PANEL\WINDOW object requiring a behavioral\attribute change to its OS tool tip window.

  4. The purpose of allowing this property is to provide the tool tip window handle such that users can use a general set of Windows tool tip control messages. The control messages can be sent to a specified tool tip window handle using the WINAPI for the SENDMESSAGE API. Some of the tool tip control messages that may be helpful are defined as follows:

  5.  

    Message Name

    Variable Type

    Value

    Windows Message Name

    SetDelayTime

    Integer 2

    0x403

    TTM_SETDELAYTIME

    SetTipBkColor

    Integer 2

    0x413

    TTM_SETTIPBKCOLOR

    SetTipTextColor

    Integer 2

    0x414

    TTM_SETTIPTEXTCOLOR

    GetDelayTime

    Integer 2

    0x415

    TTM_GETDELAYTIME

    SetMaxTipWidth

    Integer 2

    0x418

    TTM_SETMAXTIPWIDTH

     

  6. The TTM_SETDELAYTIME (0x403) message sets various time delays of the tool tip window. The parameters for this control in a SendMessage API are defined as follows:

  7.  

    Parameter

    Value

    Meaning

    wParam

    1

    TTDT_RESHOW

     

    2

    TTDT_AUTOPOP

     

    3

    TTDT_INITIAL

    lParam

     

    Time delay value in milliseconds

    Return

     

    Not Used

     

  8. The wParam parameter values have the following meaning:

  9.  

    Value

    Meaning

    TTDT_RESHOW

    Length of time it takes for subsequent tool tip windows to appear when the pointer is moved from one object to another.

    TTDT_AUTOPOP

    Length of time for which the tool tip popup window remains visible if the pointer remains stationary in the bounds of an object's window rectangle.

    TTDT_INITIAL

    Length of time for which the pointer must remain stationary in an objects boundary rectangle before the tool tip window will appear.

     

  10. The TTM_SETTIPBKCOLOR (0x413) message sets the background color of the tool tip window. The parameters for this control in a SendMessage API are defined as follows:

  11.  

    Parameter

    Value

    Meaning

    wParam

    nnn

    Integer value representing the BGR color applied.

    lParam

    0

     

    Return

     

    Not Used

     

  12. The TTM_SETTIPTEXTCOLOR (0x414) message sets the text color of the tool tip window. The parameters for this control in a SendMessage API are defined as follows

  13.  

    Parameter

    Value

    Meaning

    wParam

    nnn

    Integer value representing the BGR color applied.

    lParam

    0

     

    Return

     

    Not Used

     

  14. The TTM_SETMAXTIPWIDTH (0x418) message sets the maximum tool tip window width in pixels. This allows Windows to perform line wrapping at word breaks. The parameters for this control in a SendMessage API are defined as follows:

  15.  

    Parameter

    Value

    Meaning

    wParam

    0

     

    lParam

    nnn

    Tool tip window new width value in pixels

    Return

     

    Previous width value

 

See Also: Example Code, Object Properties, Object IO Instructions, Object Definitions

 



PL/B Language Reference TOOLTIP Property TOP Property