CButton.SetNotemethod

Sets the text of the note associated with a specified Command Link button.

WindowsmethodCButton.incdocumented

Syntax

FUNCTION SetNote (BYREF pwsz AS WSTRING) AS BOOLEAN

Parameters

Name		Description
`pwsz`		A pointer to a null-terminated unicode string that contains the note.
`hButton`		The handle to the button control.
`himlGlyph`		The handle of the image list.

Return value

Returns TRUE if successful, or FALSE otherwise.

Description

Sets the text of the note associated with a specified command link button.

Remarks

Beginning with comctl32 DLL version 6.01, command link buttons may have a note.

The BCM_SETNOTE message works only with the BS_COMMANDLINK and BS_DEFCOMMANDLINK button styles.

The note text is displayed underneath the main caption. Command Link buttons require extra vertical space; if the control is too short, Windows will hide the note and render a single-line layout. ake the button taller to ensure the note becomes visible.

Use this message only with the BS_SPLITBUTTON and BS_DEFSPLITBUTTON button styles.

To use this message, you must provide a manifest specifying Comclt32.dll version 6.0.

Examples

CButton.SetNote(hButton, "My note")

FUNCTON SetSplitImageList (BYVAL hButton AS HWND, BYVAL himlGlyph AS HIMAGELIST) AS BOOLEAN

CButton.SetNote(hButton, himlGlyph)

Reference

Include file CButton.inc
Defined in AfxNova/CButton.inc:575
Documented in Windows/WIndows Controls/CButton Class.md
Topic: CButton Class