sean-m
/
Vanara
mirror of https://github.com/dahall/Vanara.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Fixed all the window messages broken when I fixed them the last time. Doh.

pull/285/head
dahall 2022-03-12 09:11:39 -07:00
parent 9e57ba3a14
commit 6ee30c5fca
11 changed files with 432 additions and 323 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
PInvoke/ComCtl32/CommCtrl.Header.cs
View File

@ -235,7 +235,6 @@ namespace Vanara.PInvoke
{
/// <summary>
/// Clears the filter for a given header control. You can send this message explicitly or use the <c>Header_ClearFilter</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>A column value indicating which filter to clear.</para>
@ -243,6 +242,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns an integer. The <c>LRESULT</c> is cast to an integer that indicates <c>TRUE</c>(1) or <c>FALSE</c>(0).</para>
/// </summary>
/// <remarks>
/// If the column value is specified as -1, all the filters are cleared, and the HDN_FILTERCHANGE notification is sent only once.
/// </remarks>
@ -252,7 +252,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Creates a semi-transparent version of an item's image for use as a dragging image. You can send this message explicitly or
/// use the <c>Header_CreateDragImage</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -262,12 +261,12 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a handle to an image list that contains the new image as its only element.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-createdragimage
HDM_CREATEDRAGIMAGE = HDM_FIRST + 16, // int, 0
/// <summary>
/// Deletes an item from a header control. You can send this message explicitly or use the <c>Header_DeleteItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>An index of the item to delete.</para>
@ -275,10 +274,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-deleteitem
HDM_DELETEITEM = HDM_FIRST + 2, // int, 0
/// <summary>Moves the input focus to the edit box when a filter button has the focus.</summary>
/// <summary>Moves the input focus to the edit box when a filter button has the focus.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>A value specifying the column to edit.</para>
@ -303,13 +303,13 @@ namespace Vanara.PInvoke
/// </list>
/// <para><strong>Returns</strong></para>
/// <para>Returns an integer. The <c>LRESULT</c> is cast to an integer that indicates <c>TRUE</c>(1) or <c>FALSE</c>(0).</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-editfilter
HDM_EDITFILTER = HDM_FIRST + 23, // int, bool
/// <summary>
/// Gets the width of the bitmap margin for a header control. You can send this message explicitly or use the
/// <c>Header_GetBitmapMargin</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -320,13 +320,13 @@ namespace Vanara.PInvoke
/// Returns the width of the bitmap margin in pixels. If the bitmap margin was not previously specified, the default value of 3*
/// <c>GetSystemMetrics</c> (SM_CXEDGE) is returned.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-getbitmapmargin
HDM_GETBITMAPMARGIN = HDM_FIRST + 21, // 0,0
/// <summary>
/// Gets the item in a header control that has the focus. Send this message explicitly or by using the
/// <c>Header_GetFocusedItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Not used. Must be zero.</para>
@ -334,13 +334,13 @@ namespace Vanara.PInvoke
/// <para>Not used. Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the index of the item in focus.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-getfocuseditem
HDM_GETFOCUSEDITEM = HDM_FIRST + 27, // 0,0
/// <summary>
/// Gets the handle to the image list that has been set for an existing header control. You can send this message explicitly or
/// use the <c>Header_GetImageList</c> or <c>Header_GetStateImageList</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>*wParam*</em></para>
/// <para>One of the following values:</para>
@ -362,12 +362,12 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a handle to the image list set for the header control.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-getimagelist
HDM_GETIMAGELIST = HDM_FIRST + 9, // 0, 0
/// <summary>
/// Gets information about an item in a header control. You can send this message explicitly or use the <c>Header_GetItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>The index of the item for which information is to be retrieved.</para>
@ -379,6 +379,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>
/// If the HDI_TEXT flag is set in the <c>mask</c> member of the <c>HDITEM</c> structure, the control may change the
/// <c>pszText</c> member of the structure to point to the new text instead of filling the buffer with the requested text.
@ -389,7 +390,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Gets a count of the items in a header control. You can send this message explicitly or use the <c>Header_GetItemCount</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -397,13 +397,13 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the number of items if successful, or -1 otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-getitemcount
HDM_GETITEMCOUNT = HDM_FIRST + 0, // 0, 0
/// <summary>
/// Gets the bounding rectangle of the split button for a header item with style <c>HDF_SPLITBUTTON</c>. Send this message
/// explicitly or by using the <c>Header_GetItemDropDownRect</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>The zero-based index of the header control item for which to retrieve the bounding rectangle.</para>
@ -414,6 +414,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>The header item must have style <c>HDF_SPLITBUTTON</c>.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-getitemdropdownrect
HDM_GETITEMDROPDOWNRECT = HDM_FIRST + 25, // int, RECT
@ -421,7 +422,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Gets the bounding rectangle for a given item in a header control. You can send this message explicitly or use the
/// <c>Header_GetItemRect</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>The zero-based index of the header control item for which to retrieve the bounding rectangle.</para>
@ -432,13 +432,13 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns nonzero if successful, or zero otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-getitemrect
HDM_GETITEMRECT = HDM_FIRST + 7, // int, RECT*
/// <summary>
/// Gets the current left-to-right order of items in a header control. You can send this message explicitly or use the
/// <c>Header_GetOrderArray</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -451,6 +451,7 @@ namespace Vanara.PInvoke
/// Returns nonzero if successful, and the buffer at lParam receives the item number for each item in the header control in the
/// order in which they appear from left to right. Otherwise, the message returns zero.
/// </para>
/// </summary>
/// <remarks>
/// <para>
/// The number of elements in lParam is specified in wParam and must be equal to the number of items in the control. For example,
@ -466,7 +467,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Gets the bounding rectangle of the overflow button when the <c>HDS_OVERFLOW</c> style is set on the header control and the
/// overflow button is visible. Send this message explicitly or by using the <c>Header_GetOverflowRect</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Not used. Must be zero.</para>
@ -477,6 +477,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful; otherwise, <c>FALSE</c>.</para>
/// </summary>
/// <remarks>The header control must have style <c>HDF_SPLITBUTTON</c>.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-getoverflowrect
HDM_GETOVERFLOWRECT = HDM_FIRST + 26, // 0, RECT*
@ -484,7 +485,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Gets the Unicode character format flag for the control. You can send this message explicitly or use the
/// <c>Header_GetUnicodeFormat</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -495,11 +495,12 @@ namespace Vanara.PInvoke
/// Returns the Unicode format flag for the control. If this value is nonzero, the control is using Unicode characters. If this
/// value is zero, the control is using ANSI characters.
/// </para>
/// </summary>
/// <remarks>See the remarks for <c>CCM_GETUNICODEFORMAT</c> for a discussion of this message.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-getunicodeformat
HDM_GETUNICODEFORMAT = 0X2006, // CCM_GETUNICODEFORMAT,
/// <summary>Tests a point to determine which header item, if any, is at the specified point.</summary>
/// <summary>Tests a point to determine which header item, if any, is at the specified point.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -510,12 +511,12 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the index of the item at the specified position, if any, or 1 otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-hittest
HDM_HITTEST = HDM_FIRST + 6, // 0, HDHITTEST
/// <summary>
/// Inserts a new item into a header control. You can send this message explicitly or use the <c>Header_InsertItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -527,13 +528,13 @@ namespace Vanara.PInvoke
/// <para>A pointer to an <c>HDITEM</c> structure that contains information about the new item.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the index of the new item if successful, or -1 otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-insertitem
HDM_INSERTITEM = HDM_FIRST + 10, // int, HDITEM
/// <summary>
/// Retrieves information used to set the size and position of the header control within the target rectangle of the parent
/// window. You can send this message explicitly or use the <c>Header_Layout</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -544,6 +545,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>
/// <para>
/// The <c>pwpos</c> member of the lParam structure receives size and position values appropriate for positioning the control
@ -562,7 +564,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves an index value for an item based on its order in the header control. You can send this message explicitly or use
/// the <c>Header_OrderToIndex</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -573,13 +574,13 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns INT that indicates the item index. If wParam is invalid (negative or too large), the return equals wParam.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-ordertoindex
HDM_ORDERTOINDEX = HDM_FIRST + 15, // int, 0
/// <summary>
/// Sets the width of the margin, specified in pixels, of a bitmap in an existing header control. You can send this message
/// explicitly or use the <c>Header_SetBitmapMargin</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>The width, specified in pixels, of the margin that surrounds a bitmap within an existing header control.</para>
@ -590,13 +591,13 @@ namespace Vanara.PInvoke
/// Returns the width of the bitmap margin, in pixels. If the bitmap margin was not previously specified, the default value of 3*
/// <c>GetSystemMetrics</c> (SM_CXEDGE) is returned.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-setbitmapmargin
HDM_SETBITMAPMARGIN = HDM_FIRST + 20,// iWidth, 0
/// <summary>
/// Sets the timeout interval between the time a change takes place in the filter attributes and the posting of an
/// HDN_FILTERCHANGE notification. You can send this message explicitly or use the <c>Header_SetFilterChangeTimeout</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -604,13 +605,13 @@ namespace Vanara.PInvoke
/// <para>The timeout value, in milliseconds.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the index of the filter control being modified.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-setfilterchangetimeout
HDM_SETFILTERCHANGETIMEOUT = HDM_FIRST + 22, // 0, int
/// <summary>
/// Sets the focus to a specified item in a header control. Send this message explicitly or by using the
/// <c>Header_SetFocusedItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Not used. Must be zero.</para>
@ -618,13 +619,13 @@ namespace Vanara.PInvoke
/// <para>The index of item.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-setfocuseditem
HDM_SETFOCUSEDITEM = HDM_FIRST + 28, // 0, int
/// <summary>
/// Changes the color of a divider between header items to indicate the destination of an external drag-and-drop operation. You
/// can send this message explicitly or use the <c>Header_SetHotDivider</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>The type of value represented by lParam. This value can be one of the following:</para>
@ -652,6 +653,7 @@ namespace Vanara.PInvoke
/// <para>If wParam is <c>FALSE</c>, lParam represents the integer index of the divider to be highlighted.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a value equal to the index of the divider that the control highlighted.</para>
/// </summary>
/// <remarks>
/// This message creates an effect that a header control automatically produces when it has the <c>HDS_DRAGDROP</c> style. The
/// <c>HDM_SETHOTDIVIDER</c> message is intended to be used when the owner of the control handles drag-and-drop operations manually.
@ -662,7 +664,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Assigns an image list to an existing header control. You can send this message explicitly or use the
/// <c>Header_SetImageList</c> or <c>Header_SetStateImageList</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>*wParam*</em></para>
/// <para>One of the following values:</para>
@ -687,13 +688,13 @@ namespace Vanara.PInvoke
/// Returns the handle to the image list previously associated with the control. Returns <c>NULL</c> upon failure or if no image
/// list was set previously.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-setimagelist
HDM_SETIMAGELIST = HDM_FIRST + 8, // HDSIL_, hImageList
/// <summary>
/// Sets the attributes of the specified item in a header control. You can send this message explicitly or use the
/// <c>Header_SetItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>The current index of the item whose attributes are to be changed.</para>
@ -704,6 +705,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns nonzero upon success, or zero otherwise.</para>
/// </summary>
/// <remarks>
/// The <c>HDITEM</c> structure that supports this message supports item order and image list information. By using these
/// members, you can control the order in which items are displayed and specify images to appear with items.
@ -713,7 +715,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets the left-to-right order of header items. You can send this message explicitly or use the <c>Header_SetOrderArray</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>The size of the buffer at lParam, in elements. This value must equal the value returned by <c>HDM_GETITEMCOUNT</c>.</para>
@ -724,6 +725,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns nonzero if successful, or zero otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-setorderarray
HDM_SETORDERARRAY = HDM_FIRST + 18, // iCount, lpArray
@ -731,7 +733,6 @@ namespace Vanara.PInvoke
/// Sets the UNICODE character format flag for the control. This message allows you to change the character set used by the
/// control at run time rather than having to re-create the control. You can send this message explicitly or use the
/// <c>Header_SetUnicodeFormat</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -742,6 +743,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous Unicode format flag for the control.</para>
/// </summary>
/// <remarks>See the remarks for <c>CCM_SETUNICODEFORMAT</c> for a discussion of this message.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdm-setunicodeformat
HDM_SETUNICODEFORMAT = 0X2005, // CCM_SETUNICODEFORMAT,
@ -759,7 +761,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_BEGINDRAG pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHEADER</c> structure containing information about the header item that is being dragged.</para>
@ -768,6 +769,7 @@ namespace Vanara.PInvoke
/// To allow the header control to automatically manage drag-and-drop operations, return <c>FALSE</c>. If the owner of the
/// control is manually performing drag-and-drop reordering, return <c>TRUE</c>.
/// </para>
/// </summary>
/// <remarks>
/// A header control defaults to automatically managing drag-and-drop reordering. Returning <c>TRUE</c> to indicate external
/// (manual) drag-and-drop management allows the owner of the control to provide custom services as part of the drag-and-drop process.
@ -783,12 +785,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_BEGINFILTEREDIT pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHEADER</c> structure that contains additional information about the filter that is being edited.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdn-beginfilteredit
HDN_BEGINFILTEREDIT = HDN_FIRST - 14,
@ -801,7 +803,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_BEGINTRACK pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -810,6 +811,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>FALSE</c> to allow tracking of the divider, or <c>TRUE</c> to prevent tracking.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdn-begintrack
HDN_BEGINTRACK = HDN_FIRST - 26,
@ -821,7 +823,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_DIVIDERDBLCLICK pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -829,6 +830,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdn-dividerdblclick
HDN_DIVIDERDBLCLICK = HDN_FIRST - 25,
@ -840,12 +842,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_DROPDOWN pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHEADER</c> structure that contains information on the header control.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// <para>
/// The example in the Syntax section shows how the notification receiver casts <c>LPARAM</c> to retrieve the <c>NMHEADER</c>
@ -864,7 +866,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_ENDDRAG pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHEADER</c> structure containing information about the header item that was being dragged.</para>
@ -873,6 +874,7 @@ namespace Vanara.PInvoke
/// To allow the control to automatically place and reorder the item, return <c>FALSE</c>. To prevent the item from being placed,
/// return <c>TRUE</c>.
/// </para>
/// </summary>
/// <remarks>
/// If the owner is performing external (manual) drag-and-drop management, it must return <c>FALSE</c>. The owner then must
/// reorder header items manually by sending <c>HDM_SETITEM</c> or <c>HDM_SETORDERARRAY</c>.
@ -888,12 +890,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_ENDFILTEREDIT pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHEADER</c> structure that contains additional information about the filter that is being edited.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdn-endfilteredit
HDN_ENDFILTEREDIT = HDN_FIRST - 15,
@ -905,7 +907,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_ENDTRACK pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -913,6 +914,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdn-endtrack
HDN_ENDTRACK = HDN_FIRST - 27,
@ -924,7 +926,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_FILTERBTNCLICK pNMHDFilterBtnClk = (LPNMHDFILTERBTNCLICK) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -936,6 +937,7 @@ namespace Vanara.PInvoke
/// notification code gives the parent window an opportunity to synchronize its user interface elements. Return <c>FALSE</c> if
/// you do not want the notification sent.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdn-filterbtnclick
HDN_FILTERBTNCLICK = HDN_FIRST - 13,
@ -947,7 +949,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_FILTERCHANGE pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -956,6 +957,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdn-filterchange
HDN_FILTERCHANGE = HDN_FIRST - 12,
@ -967,7 +969,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_GETDISPINFO pNMHDDispInfo = (LPNMHDDISPINFO) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -976,6 +977,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns an LRESULT.</para>
/// </summary>
/// <remarks>
/// Fill the appropriate members of the structure to return the requested information to the header control. If your message
/// handler sets the <c>mask</c> member of the <c>NMHDDISPINFO</c> structure to HDI_DI_SETITEM, the header control stores the
@ -992,7 +994,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_ITEMCHANGED pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1001,6 +1002,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdn-itemchanged
HDN_ITEMCHANGED = HDN_FIRST - 21,
@ -1012,7 +1014,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_ITEMCHANGING pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1021,6 +1022,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>FALSE</c> to allow the changes, or <c>TRUE</c> to prevent them.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdn-itemchanging
HDN_ITEMCHANGING = HDN_FIRST - 20,
@ -1032,7 +1034,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_ITEMCLICK pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1041,6 +1042,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>A header control sends this notification code after the user releases the left mouse button.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdn-itemclick
HDN_ITEMCLICK = HDN_FIRST - 22,
@ -1053,12 +1055,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_ITEMDBLCLICK pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHEADER</c> structure that contains information about this notification code.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdn-itemdblclick
HDN_ITEMDBLCLICK = HDN_FIRST - 23,
@ -1070,12 +1072,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_ITEMKEYDOWN pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHEADER</c> structure that contains additional information about the key that is being pressed.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdn-itemkeydown
HDN_ITEMKEYDOWN = HDN_FIRST - 17,
@ -1087,7 +1089,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_ITEMSTATEICONCLICK pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1095,6 +1096,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdn-itemstateiconclick
HDN_ITEMSTATEICONCLICK = HDN_FIRST - 16,
@ -1106,7 +1108,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_OVERFLOWCLICK pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1120,6 +1121,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// <para>
/// The notification receiver casts <c>LPARAM</c> to retrieve the <c>NMHEADER</c> structure. <c>WPARAM</c> contains the ID of the
@ -1138,7 +1140,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>HDN_TRACK pNMHeader = (LPNMHEADER) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1147,6 +1148,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>FALSE</c> to continue tracking the divider, or <c>TRUE</c> to end tracking.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/hdn-track
HDN_TRACK = HDN_FIRST - 28,
}

39
PInvoke/ComCtl32/CommCtrl.IPAddress.cs
View File

@ -19,7 +19,7 @@ namespace Vanara.PInvoke
/// <summary>IP Address Messages</summary>
public enum IPAddressMessage
{
/// <summary>Clears the contents of the IP address control.</summary>
/// <summary>Clears the contents of the IP address control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -27,10 +27,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is not used.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ipm-clearaddress
IPM_CLEARADDRESS = WindowMessage.WM_USER + 100,
/// <summary>Sets the address values for all four fields in the IP address control.</summary>
/// <summary>Sets the address values for all four fields in the IP address control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -42,11 +43,12 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is not used.</para>
/// </summary>
/// <remarks>This message does not generate an <c>IPN_FIELDCHANGED</c> notification.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/ipm-setaddress
IPM_SETADDRESS = WindowMessage.WM_USER + 101,
/// <summary>Gets the address values for all four fields in the IP address control.</summary>
/// <summary>Gets the address values for all four fields in the IP address control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -60,10 +62,11 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the number of nonblank fields.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ipm-getaddress
IPM_GETADDRESS = WindowMessage.WM_USER + 102,
/// <summary>Sets the valid range for the specified field in the IP address control.</summary>
/// <summary>Sets the valid range for the specified field in the IP address control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>A zero-based field index to which the range will be applied.</para>
@ -74,6 +77,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns nonzero if successful, or zero otherwise.</para>
/// </summary>
/// <remarks>
/// If the user enters a value in the field that is outside of this range, the control will send the IPN_FIELDCHANGED
/// notification with the entered value. If the value is still outside of the range after sending the notification, the control
@ -84,7 +88,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets the keyboard focus to the specified field in the IP address control. All of the text in that field will be selected.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -95,10 +98,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is not used.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ipm-setfocus
IPM_SETFOCUS = WindowMessage.WM_USER + 104,
/// <summary>Determines if all fields in the IP address control are blank.</summary>
/// <summary>Determines if all fields in the IP address control are blank.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -106,6 +110,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns nonzero if all fields are blank, or zero otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ipm-isblank
IPM_ISBLANK = WindowMessage.WM_USER + 105,
}
@ -114,15 +119,19 @@ namespace Vanara.PInvoke
public enum IPAddressNotification
{
/// <summary>
/// Sent when the user changes a field in the control or moves from one field to another. This notification code is sent in the
/// form of a WM_NOTIFY message.
/// </summary>
/// <param name="lParam">
/// A pointer to an NMIPADDRESS structure that contains information about the changed address. The iValue member of this
/// structure will contain the entered value, even if it is out of the range of the field. You can modify this member to any
/// value that is within the range for the field in response to this notification code.
/// </param>
/// <returns>The return value is ignored.</returns>
/// <para>Sent when the user changes a field in the control or moves from one field to another. This notification code is sent in the form of a <c>WM_NOTIFY</c> message.</para>
/// <para><code>IPN_FIELDCHANGED lpnmipa = (LPNMIPADDRESS) lParam; </code></para>
/// <para>
/// <strong>Parameters</strong>
/// </para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMIPADDRESS</c> structure that contains information about the changed address. The <c>iValue</c> member of this structure will contain the entered value, even if it is out of the range of the field. You can modify this member to any value that is within the range for the field in response to this notification code.</para>
/// <para>
/// <strong>Returns</strong>
/// </para>
/// <para>The return value is ignored.</para></summary>
/// <remarks>This notification code is not sent in response to a <c>IPM_SETADDRESS</c> message.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/ipn-fieldchanged
IPN_FIELDCHANGED = IPN_FIRST - 0
}

16
PInvoke/ComCtl32/CommCtrl.Messages.cs
View File

@ -24,7 +24,6 @@
/// <summary>
/// Sets the Unicode character format flag for the control. This message enables you to change the character set used by the
/// control at run time rather than having to re-create the control.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -35,10 +34,11 @@
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous Unicode format flag for the control.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ccm-setunicodeformat
CCM_SETUNICODEFORMAT = CCM_FIRST + 5,
/// <summary>Gets the Unicode character format flag for the control.</summary>
/// <summary>Gets the Unicode character format flag for the control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -49,10 +49,11 @@
/// Returns the Unicode format flag for the control. If this value is nonzero, the control is using Unicode characters. If this
/// value is zero, the control is using ANSI characters.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ccm-getunicodeformat
CCM_GETUNICODEFORMAT = CCM_FIRST + 6,
/// <summary>This message is used to inform the control that you are expecting a behavior associated with a particular version.</summary>
/// <summary>This message is used to inform the control that you are expecting a behavior associated with a particular version.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>The version number.</para>
@ -63,6 +64,7 @@
/// Returns the version specified in the previous <c>CCM_SETVERSION</c> message. If wParam is set to a value greater than the
/// current DLL version, it returns -1.
/// </para>
/// </summary>
/// <remarks>
/// <para>
/// In a few cases, a control may behave differently, depending on the version. This primarily applies to bugs that were fixed in
@ -82,7 +84,7 @@
// https://docs.microsoft.com/en-us/windows/win32/controls/ccm-setversion
CCM_SETVERSION = CCM_FIRST + 0x7,
/// <summary>Gets the version number for a control set by the most recent <c>CCM_SETVERSION</c> message.</summary>
/// <summary>Gets the version number for a control set by the most recent <c>CCM_SETVERSION</c> message.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -92,6 +94,7 @@
/// <para>
/// Returns the version number set by the most recent <c>CCM_SETVERSION</c> message. If no such message has been sent, it returns zero.
/// </para>
/// </summary>
/// <remarks>
/// <para>
/// This message does not return the DLL version. See Shell Versions for a discussion of how to use <c>DllGetVersion</c> to
@ -108,7 +111,7 @@
/// <summary/>
CCM_SETNOTIFYWINDOW = CCM_FIRST + 0x9, // wParam == hwndParent.
/// <summary>Sets the visual style of a control.</summary>
/// <summary>Sets the visual style of a control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -116,6 +119,7 @@
/// <para>A pointer to a Unicode string that contains the control visual style to set.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is not used.</para>
/// </summary>
/// <remarks>
/// <para>Note</para>
/// <para>
@ -129,7 +133,6 @@
/// <summary>
/// Enables automatic high dots per inch (dpi) scaling in Tree-View controls, List-View controls, ComboBoxEx controls, Header
/// controls, Buttons, Toolbar controls, Animation controls, and Image Lists.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Set to <c>TRUE</c>.</para>
@ -137,6 +140,7 @@
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is not used.</para>
/// </summary>
/// <remarks>
/// <para>Quick Launch and Taskbar should not specify a dpi scaling, because the images are already scaled.</para>
/// <para>Any control that uses an image list created with the SmallIcon metric should not scale its icons.</para>

43
PInvoke/ComCtl32/CommCtrl.Progress.cs
View File

@ -11,7 +11,7 @@ namespace Vanara.PInvoke
[PInvokeData("Commctrl.h")]
public enum ProgressMessage
{
/// <summary>Sets the minimum and maximum values for a progress bar and redraws the bar to reflect the new range.</summary>
/// <summary>Sets the minimum and maximum values for a progress bar and redraws the bar to reflect the new range.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -26,6 +26,7 @@ namespace Vanara.PInvoke
/// Returns the previous range values if successful, or zero otherwise. The <c>LOWORD</c> specifies the previous minimum value,
/// and the <c>HIWORD</c> specifies the previous maximum value.
/// </para>
/// </summary>
/// <remarks>
/// <para>
/// If you do not set the range values, the system sets the minimum value to 0 and the maximum value to 100. Because this message
@ -37,7 +38,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/pbm-setrange
PBM_SETRANGE = WindowMessage.WM_USER + 1,
/// <summary>Sets the current position for a progress bar and redraws the bar to reflect the new position.</summary>
/// <summary>Sets the current position for a progress bar and redraws the bar to reflect the new position.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Signed integer that becomes the new position.</para>
@ -45,6 +46,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous position.</para>
/// </summary>
/// <remarks>
/// <para>If wParam is outside the range of the control, the position is set to the closest boundary.</para>
/// <para>Do not send this message to a control that has the <c>PBS_MARQUEE</c> style.</para>
@ -54,7 +56,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Advances the current position of a progress bar by a specified increment and redraws the bar to reflect the new position.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Amount to advance the position.</para>
@ -62,6 +63,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous position.</para>
/// </summary>
/// <remarks>
/// <para>If the increment results in a value outside the range of the control, the position is set to the nearest boundary.</para>
/// <para>The behavior of this message is undefined if it is sent to a control that has the <c>PBS_MARQUEE</c> style.</para>
@ -72,7 +74,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Specifies the step increment for a progress bar. The step increment is the amount by which the progress bar increases its
/// current position whenever it receives a <c>PBM_STEPIT</c> message. By default, the step increment is set to 10.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>New step increment.</para>
@ -80,13 +81,13 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous step increment.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/pbm-setstep
PBM_SETSTEP = WindowMessage.WM_USER + 4,
/// <summary>
/// Advances the current position for a progress bar by the step increment and redraws the bar to reflect the new position. An
/// application sets the step increment by sending the <c>PBM_SETSTEP</c> message.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -94,6 +95,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous position.</para>
/// </summary>
/// <remarks>
/// When the position exceeds the maximum range value, this message resets the current position so that the progress indicator
/// starts over again from the beginning.
@ -103,7 +105,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets the minimum and maximum values for a progress bar to 32-bit values, and redraws the bar to reflect the new range.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Minimum range value. By default, the minimum value is zero.</para>
@ -115,11 +116,12 @@ namespace Vanara.PInvoke
/// in its <c>HIWORD</c>. If the previous ranges were 32-bit values, the return value consists of the <c>LOWORD</c> s of both
/// 32-bit limits.
/// </para>
/// </summary>
/// <remarks>To retrieve the entire high and low 32-bit values, use the <c>PBM_GETRANGE</c> message.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/pbm-setrange32
PBM_SETRANGE32 = WindowMessage.WM_USER + 6, // lParam = high, wParam = low
/// <summary>Retrieves information about the current high and low limits of a given progress bar control.</summary>
/// <summary>Retrieves information about the current high and low limits of a given progress bar control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -150,10 +152,11 @@ namespace Vanara.PInvoke
/// Returns an INT that represents the limit value specified by wParam. If lParam is not <c>NULL</c>, lParam must point to a
/// <c>PBRANGE</c> structure that is to be filled with both limit values.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/pbm-getrange
PBM_GETRANGE = WindowMessage.WM_USER + 7, // wParam = return (TRUE ? low : high). lParam = PPBRANGE or NULL
/// <summary>Retrieves the current position of the progress bar.</summary>
/// <summary>Retrieves the current position of the progress bar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -161,10 +164,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a <c>UINT</c> value that represents the current position of the progress bar.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/pbm-getpos
PBM_GETPOS = WindowMessage.WM_USER + 8,
/// <summary>Sets the color of the progress indicator bar in the progress bar control.</summary>
/// <summary>Sets the color of the progress indicator bar in the progress bar control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -177,11 +181,12 @@ namespace Vanara.PInvoke
/// <para>
/// Returns the previous progress indicator bar color, or CLR_DEFAULT if the progress indicator bar color is the default color.
/// </para>
/// </summary>
/// <remarks>When visual styles are enabled, this message has no effect.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/pbm-setbarcolor
PBM_SETBARCOLOR = WindowMessage.WM_USER + 9, // lParam = bar color
/// <summary>Sets the background color in the progress bar.</summary>
/// <summary>Sets the background color in the progress bar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -192,11 +197,12 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous background color, or CLR_DEFAULT if the background color is the default color.</para>
/// </summary>
/// <remarks>When visual styles are enabled, this message has no effect.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/pbm-setbkcolor
PBM_SETBKCOLOR = CommonControlMessage.CCM_SETBKCOLOR, // lParam = bkColor
/// <summary>Sets the progress bar to marquee mode. This causes the progress bar to move like a marquee.</summary>
/// <summary>Sets the progress bar to marquee mode. This causes the progress bar to move like a marquee.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Indicates whether to turn the marquee mode on or off.</para>
@ -207,6 +213,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Always returns <c>TRUE</c>.</para>
/// </summary>
/// <remarks>
/// <para>
/// Use this message when you do not know the amount of progress toward completion but wish to indicate that progress is being made.
@ -227,7 +234,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the step increment from a progress bar. The step increment is the amount by which the progress bar increases its
/// current position whenever it receives a <c>PBM_STEPIT</c> message. By default, the step increment is set to 10.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -235,10 +241,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the current step increment.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/pbm-getstep
PBM_GETSTEP = WindowMessage.WM_USER + 13,
/// <summary>Gets the background color of the progress bar.</summary>
/// <summary>Gets the background color of the progress bar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -246,6 +253,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the background color of the progress bar.</para>
/// </summary>
/// <remarks>
/// <para>This is the color set by the <c>PBM_SETBKCOLOR</c> message. The default value is CLR_DEFAULT, which is defined in commctrl.h.</para>
/// <para>This function only affects the classic mode, not any visual style.</para>
@ -253,7 +261,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/pbm-getbkcolor
PBM_GETBKCOLOR = WindowMessage.WM_USER + 14,
/// <summary>Gets the color of the progress bar.</summary>
/// <summary>Gets the color of the progress bar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -261,6 +269,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the color of the progress bar.</para>
/// </summary>
/// <remarks>
/// <para>
/// This is the color set by the <c>PBM_SETBARCOLOR</c> message. The default value is CLR_DEFAULT, which is defined in commctrl.h.
@ -270,7 +279,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/pbm-getbarcolor
PBM_GETBARCOLOR = WindowMessage.WM_USER + 15,
/// <summary>Sets the state of the progress bar.</summary>
/// <summary>Sets the state of the progress bar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>State of the progress bar that is being set. One of the following values.</para>
@ -296,10 +305,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous state.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/pbm-setstate
PBM_SETSTATE = WindowMessage.WM_USER + 16, // wParam = PBST_[State] (NORMAL, ERROR, PAUSED)
/// <summary>Gets the state of the progress bar.</summary>
/// <summary>Gets the state of the progress bar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -325,6 +335,7 @@ namespace Vanara.PInvoke
/// <term>Paused.</term>
/// </item>
/// </list>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/pbm-getstate
PBM_GETSTATE = WindowMessage.WM_USER + 17,
}

68
PInvoke/ComCtl32/CommCtrl.Tab.cs
View File

@ -88,7 +88,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the image list associated with a tab control. You can send this message explicitly or by using the
/// <c>TabCtrl_GetImageList</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -96,12 +95,12 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the handle to the image list if successful, or <c>NULL</c> otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-getimagelist
TCM_GETIMAGELIST = TCM_FIRST + 2,
/// <summary>
/// Assigns an image list to a tab control. You can send this message explicitly or by using the <c>TabCtrl_SetImageList</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -109,13 +108,13 @@ namespace Vanara.PInvoke
/// <para>Handle to the image list to assign to the tab control.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the handle to the previous image list, or <c>NULL</c> if there is no previous image list.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-setimagelist
TCM_SETIMAGELIST = TCM_FIRST + 3,
/// <summary>
/// Retrieves the number of tabs in the tab control. You can send this message explicitly or by using the
/// <c>TabCtrl_GetItemCount</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -123,13 +122,13 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the number of items if successful, or zero otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-getitemcount
TCM_GETITEMCOUNT = TCM_FIRST + 4,
/// <summary>
/// Retrieves information about a tab in a tab control. You can send this message explicitly or by using the
/// <c>TabCtrl_GetItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Index of the tab.</para>
@ -142,6 +141,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>
/// If the TCIF_TEXT flag is set in the <c>mask</c> member of the <c>TCITEM</c> structure, the control may change the
/// <c>pszText</c> member of the structure to point to the new text instead of filling the buffer with the requested text. The
@ -152,7 +152,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets some or all of a tab's attributes. You can send this message explicitly or by using the <c>TabCtrl_SetItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Index of the item.</para>
@ -164,12 +163,12 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-setitem
TCM_SETITEM = TCM_FIRST + 61,
/// <summary>
/// Inserts a new tab in a tab control. You can send this message explicitly or by using the <c>TabCtrl_InsertItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Index of the new tab.</para>
@ -180,12 +179,12 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the index of the new tab if successful, or -1 otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-insertitem
TCM_INSERTITEM = TCM_FIRST + 62,
/// <summary>
/// Removes an item from a tab control. You can send this message explicitly or by using the <c>TabCtrl_DeleteItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Index of the item to delete.</para>
@ -193,12 +192,12 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-deleteitem
TCM_DELETEITEM = TCM_FIRST + 8,
/// <summary>
/// Removes all items from a tab control. You can send this message explicitly or by using the <c>TabCtrl_DeleteAllItems</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -206,13 +205,13 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-deleteallitems
TCM_DELETEALLITEMS = TCM_FIRST + 9,
/// <summary>
/// Retrieves the bounding rectangle for a tab in a tab control. You can send this message explicitly or by using the
/// <c>TabCtrl_GetItemRect</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Index of the tab.</para>
@ -220,13 +219,13 @@ namespace Vanara.PInvoke
/// <para>Pointer to a <c>RECT</c> structure that receives the bounding rectangle of the tab, in viewport coordinates.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-getitemrect
TCM_GETITEMRECT = TCM_FIRST + 10,
/// <summary>
/// Determines the currently selected tab in a tab control. You can send this message explicitly or by using the
/// <c>TabCtrl_GetCurSel</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -234,12 +233,12 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the index of the selected tab if successful, or -1 if no tab is selected.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-getcursel
TCM_GETCURSEL = TCM_FIRST + 11,
/// <summary>
/// Selects a tab in a tab control. You can send this message explicitly or by using the <c>TabCtrl_SetCurSel</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Index of the tab to select.</para>
@ -247,6 +246,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the index of the previously selected tab if successful, or -1 otherwise.</para>
/// </summary>
/// <remarks>
/// A tab control does not send a TCN_SELCHANGING or TCN_SELCHANGE notification code when a tab is selected using this message.
/// </remarks>
@ -256,7 +256,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Determines which tab, if any, is at a specified screen position. You can send this message explicitly or by using the
/// <c>TabCtrl_HitTest</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -264,13 +263,13 @@ namespace Vanara.PInvoke
/// <para>Pointer to a <c>TCHITTESTINFO</c> structure that specifies the screen position to test.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the index of the tab, or -1 if no tab is at the specified position.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-hittest
TCM_HITTEST = TCM_FIRST + 13,
/// <summary>
/// Sets the number of bytes per tab reserved for application-defined data in a tab control. You can send this message explicitly
/// or by using the <c>TabCtrl_SetItemExtra</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Number of extra bytes.</para>
@ -278,6 +277,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>
/// <para>
/// By default, the number of extra bytes is four. An application that changes the number of extra bytes cannot use the
@ -292,7 +292,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Calculates a tab control's display area given a window rectangle, or calculates the window rectangle that would correspond to
/// a specified display area. You can send this message explicitly or by using the <c>TabCtrl_AdjustRect</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -304,6 +303,7 @@ namespace Vanara.PInvoke
/// <para>Pointer to a <c>RECT</c> structure that specifies the given rectangle and receives the calculated rectangle.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// This message applies only to tab controls that are at the top. It does not apply to tab controls that are on the sides or bottom.
/// </remarks>
@ -313,7 +313,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets the width and height of tabs in a fixed-width or owner-drawn tab control. You can send this message explicitly or by
/// using the <c>TabCtrl_SetItemSize</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -324,6 +323,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the old width and height. The width is in the <c>LOWORD</c> of the return value, and the height is in the <c>HIWORD</c>.</para>
/// </summary>
/// <remarks>
/// If the width is set to a value less than the image width set by <c>ImageList_Create</c>, the width of the tab is set to the
/// lowest value that is greater than the image width.
@ -334,7 +334,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Removes an image from a tab control's image list. You can send this message explicitly or by using the
/// <c>TabCtrl_RemoveImage</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Index of the image to remove.</para>
@ -342,6 +341,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// The tab control updates each tab's image index, so each tab remains associated with the same image as before. If a tab is
/// using the image being removed, the tab will be set to have no image.
@ -352,7 +352,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets the amount of space (padding) around each tab's icon and label in a tab control. You can send this message explicitly or
/// by using the <c>TabCtrl_SetPadding</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -361,13 +360,13 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-setpadding
TCM_SETPADDING = TCM_FIRST + 43,
/// <summary>
/// Retrieves the current number of rows of tabs in a tab control. You can send this message explicitly or by using the
/// <c>TabCtrl_GetRowCount</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -375,6 +374,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the number of rows of tabs.</para>
/// </summary>
/// <remarks>Only tab controls that have the <c>TCS_MULTILINE</c> style can have multiple rows of tabs.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-getrowcount
TCM_GETROWCOUNT = TCM_FIRST + 44,
@ -382,7 +382,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the handle to the tooltip control associated with a tab control. You can send this message explicitly or by using
/// the <c>TabCtrl_GetToolTips</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -390,6 +389,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the handle to the tooltip control if successful, or <c>NULL</c> otherwise.</para>
/// </summary>
/// <remarks>
/// A tab control creates a tooltip control if it has the <c>TCS_TOOLTIPS</c> style. You can also assign a tooltip control to a
/// tab control by using the <c>TCM_SETTOOLTIPS</c> message.
@ -399,7 +399,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Assigns a tooltip control to a tab control. You can send this message explicitly or by using the <c>TabCtrl_SetToolTips</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Handle to the tooltip control.</para>
@ -407,6 +406,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>You can retrieve the tooltip control associated with a tab control by using the <c>TCM_GETTOOLTIPS</c> message.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-settooltips
TCM_SETTOOLTIPS = TCM_FIRST + 46,
@ -414,7 +414,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Returns the index of the item that has the focus in a tab control. You can send this message explicitly or by using the
/// <c>TabCtrl_GetCurFocus</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -422,6 +421,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the index of the tab item that has the focus.</para>
/// </summary>
/// <remarks>The item that has the focus may be different than the selected item.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-getcurfocus
TCM_GETCURFOCUS = TCM_FIRST + 47,
@ -429,7 +429,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets the focus to a specified tab in a tab control. You can send this message explicitly or by using the
/// <c>TabCtrl_SetCurFocus</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Index of the tab that gets the focus.</para>
@ -437,6 +436,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// <para>
/// If the tab control has the <c>TCS_BUTTONS</c> style (button mode), the tab with the focus may be different from the selected
@ -455,7 +455,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets the minimum width of items in a tab control. You can send this message explicitly or by using the
/// <c>TabCtrl_SetMinTabWidth</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -465,13 +464,13 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns an INT value that represents the previous minimum tab width.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-setmintabwidth
TCM_SETMINTABWIDTH = TCM_FIRST + 49,
/// <summary>
/// Resets items in a tab control, clearing any that were set to the <c>TCIS_BUTTONPRESSED</c> state. You can send this message
/// explicitly or by using the <c>TabCtrl_DeselectAll</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -482,13 +481,13 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this message is not used.</para>
/// </summary>
/// <remarks>This message is only meaningful if the <c>TCS_BUTTONS</c> style flag has been set.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-deselectall
TCM_DESELECTALL = TCM_FIRST + 50,
/// <summary>
/// Sets the highlight state of a tab item. You can send this message explicitly or by using the <c>TabCtrl_HighlightItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>An <c>INT</c> value that specifies the zero-based index of a tab control item.</para>
@ -499,6 +498,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns nonzero if successful, or zero otherwise.</para>
/// </summary>
/// <remarks>In Comctl32.dll version 6.0, this message has no visible effect when a theme is active.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-highlightitem
TCM_HIGHLIGHTITEM = TCM_FIRST + 51,
@ -506,7 +506,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets the extended styles that the tab control will use. You can send this message explicitly or by using the
/// <c>TabCtrl_SetExtendedStyle</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -517,6 +516,7 @@ namespace Vanara.PInvoke
/// <para>Value specifying the extended tab control styles. This value is a combination of tab control extended styles.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a <c>DWORD</c> value that contains the previous tab control extended styles.</para>
/// </summary>
/// <remarks>
/// <para>
/// The wParam parameter allows you to modify one or more extended styles without having to retrieve the existing styles first.
@ -531,7 +531,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the extended styles that are currently in use for the tab control. You can send this message explicitly or by using
/// the <c>TabCtrl_GetExtendedStyle</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -542,6 +541,7 @@ namespace Vanara.PInvoke
/// Returns a <c>DWORD</c> value that represents the extended styles currently in use for the tab control. This value is a
/// combination of tab control extended styles.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-getextendedstyle
TCM_GETEXTENDEDSTYLE = TCM_FIRST + 53,
@ -549,7 +549,6 @@ namespace Vanara.PInvoke
/// Sets the Unicode character format flag for the control. This message allows you to change the character set used by the
/// control at run time rather than having to re-create the control. You can send this message explicitly or use the
/// <c>TabCtrl_SetUnicodeFormat</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -560,6 +559,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous Unicode format flag for the control.</para>
/// </summary>
/// <remarks>See the remarks for <c>CCM_SETUNICODEFORMAT</c> for a discussion of this message.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-setunicodeformat
TCM_SETUNICODEFORMAT = CommonControlMessage.CCM_SETUNICODEFORMAT,
@ -567,7 +567,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the Unicode character format flag for the control. You can send this message explicitly or use the
/// <c>TabCtrl_GetUnicodeFormat</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -578,6 +577,7 @@ namespace Vanara.PInvoke
/// Returns the Unicode format flag for the control. If this value is nonzero, the control is using Unicode characters. If this
/// value is zero, the control is using ANSI characters.
/// </para>
/// </summary>
/// <remarks>See the remarks for <c>CCM_GETUNICODEFORMAT</c> for a discussion of this message.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcm-getunicodeformat
TCM_GETUNICODEFORMAT = CommonControlMessage.CCM_GETUNICODEFORMAT
@ -595,12 +595,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TCN_KEYDOWN pnm = (NMTCKEYDOWN*) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>Pointer to an <c>NMTCKEYDOWN</c> structure.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcn-keydown
TCN_KEYDOWN = TCN_FIRST - 0,
@ -612,12 +612,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TCN_SELCHANGE lpnmhdr = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>Pointer to an <c>NMHDR</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>To determine the currently selected tab, use the <c>TabCtrl_GetCurSel</c> macro.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcn-selchange
TCN_SELCHANGE = TCN_FIRST - 1,
@ -630,12 +630,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TCN_SELCHANGING lpnmhdr = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>Pointer to an <c>NMHDR</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> to prevent the selection from changing, or <c>FALSE</c> to allow the selection to change.</para>
/// </summary>
/// <remarks>To determine the currently selected tab, use the <c>TabCtrl_GetCurSel</c> macro.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcn-selchanging
TCN_SELCHANGING = TCN_FIRST - 2,
@ -648,7 +648,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TCN_GETOBJECT lpnmon = (LPNMOBJECTNOTIFY) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -657,6 +656,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The application processing this notification code must return zero.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcn-getobject
TCN_GETOBJECT = TCN_FIRST - 3,
@ -668,12 +668,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TCN_FOCUSCHANGE lpnmh = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>Pointer to an <c>NMHDR</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tcn-focuschange
TCN_FOCUSCHANGE = TCN_FIRST - 4,
}

66
PInvoke/ComCtl32/CommCtrl.TaskDialog.cs
View File

@ -218,7 +218,7 @@ namespace Vanara.PInvoke
[PInvokeData("Commctrl.h", MSDNShortId = "bb787473")]
public enum TaskDialogMessage : uint
{
/// <summary>Recreates a task dialog with new contents, simulating the functionality of a multi-page wizard.</summary>
/// <summary>Recreates a task dialog with new contents, simulating the functionality of a multi-page wizard.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Not used. Must be zero.</para>
@ -229,6 +229,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
/// <remarks>
/// <para>
/// To launch a wizard task dialog, use the <c>TaskDialogIndirect</c> function. As the user navigates using the wizard, send this
@ -247,7 +248,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/tdm-navigate-page
TDM_NAVIGATE_PAGE = WindowMessage.WM_USER + 101,
/// <summary>Simulates the action of a button click in a task dialog.</summary>
/// <summary>Simulates the action of a button click in a task dialog.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>An <c>int</c> that specifies the ID of the button to be clicked.</para>
@ -255,6 +256,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
/// <remarks>
/// The button ID specified by wParam is sent to the <c>TaskDialogCallbackProc</c> callback function as part of a
/// TDN_BUTTON_CLICKED notification code. After the callback function returns, the task dialog is closed if S_OK was returned
@ -263,7 +265,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/tdm-click-button
TDM_CLICK_BUTTON = WindowMessage.WM_USER + 102, // wParam = Button ID
/// <summary>Indicates whether the hosted progress bar of a task dialog should be displayed in marquee mode.</summary>
/// <summary>Indicates whether the hosted progress bar of a task dialog should be displayed in marquee mode.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -274,11 +276,12 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
/// <remarks>For information on marquee mode, see Progress Bar Control.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdm-set-marquee-progress-bar
TDM_SET_MARQUEE_PROGRESS_BAR = WindowMessage.WM_USER + 103, // wParam = 0 (nonMarque) wParam != 0 (Marquee)
/// <summary>Sets the state of the progress bar in a task dialog.</summary>
/// <summary>Sets the state of the progress bar in a task dialog.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>An <c>int</c> that specifies the state of the progress bar. This parameter can be one of the following values.</para>
@ -305,10 +308,11 @@ namespace Vanara.PInvoke
/// <para><strong>Returns</strong></para>
/// <para>If the function succeeds, the return value is non zero.</para>
/// <para>If the function fails, the return value is zero. To get extended error information call GetLastError.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdm-set-progress-bar-state
TDM_SET_PROGRESS_BAR_STATE = WindowMessage.WM_USER + 104, // wParam = new progress state
/// <summary>Sets the minimum and maximum values for the progress bar in a task dialog.</summary>
/// <summary>Sets the minimum and maximum values for the progress bar in a task dialog.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -322,10 +326,11 @@ namespace Vanara.PInvoke
/// Returns the previous minimum and maximum values, if successful, or zero otherwise. The <c>LOWORD</c> contains the minimum
/// value, and the <c>HIWORD</c> contains the maximum value.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdm-set-progress-bar-range
TDM_SET_PROGRESS_BAR_RANGE = WindowMessage.WM_USER + 105, // lParam = MAKELPARAM(nMinRange, nMaxRange)
/// <summary>Sets the position of the progress bar in a task dialog.</summary>
/// <summary>Sets the position of the progress bar in a task dialog.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>An <c>int</c> that specifies the new position.</para>
@ -333,10 +338,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous position.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdm-set-progress-bar-pos
TDM_SET_PROGRESS_BAR_POS = WindowMessage.WM_USER + 106, // wParam = new position
/// <summary>Starts and stops the marquee display of the progress bar in a task dialog, and sets the speed of the marquee.</summary>
/// <summary>Starts and stops the marquee display of the progress bar in a task dialog, and sets the speed of the marquee.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -350,11 +356,12 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
/// <remarks>For information on marquee mode, see Progress Bar Control.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdm-set-progress-bar-marquee
TDM_SET_PROGRESS_BAR_MARQUEE = WindowMessage.WM_USER + 107, // wParam = 0 (stop marquee), wParam != 0 (start marquee), lparam = speed (milliseconds between repaints)
/// <summary>Updates a text element in a task dialog.</summary>
/// <summary>Updates a text element in a task dialog.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -386,11 +393,12 @@ namespace Vanara.PInvoke
/// <para>The new text to use.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
/// <remarks>The size or layout of the task dialog may change to accommodate the new text.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdm-set-element-text
TDM_SET_ELEMENT_TEXT = WindowMessage.WM_USER + 108, // wParam = element (TASKDIALOG_ELEMENTS), lParam = new element text (LPCWSTR)
/// <summary>Simulates the action of a radio button click in a task dialog.</summary>
/// <summary>Simulates the action of a radio button click in a task dialog.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>An <c>int</c> value that specifies the ID of the radio button to be clicked.</para>
@ -398,6 +406,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
/// <remarks>
/// The specified radio button ID is sent to the <c>TaskDialogCallbackProc</c> callback function as part of a
/// TDN_RADIO_BUTTON_CLICKED notification code. After the callback function returns, the radio button will be selected.
@ -405,7 +414,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/tdm-click-radio-button
TDM_CLICK_RADIO_BUTTON = WindowMessage.WM_USER + 110, // wParam = Radio Button ID
/// <summary>Enables or disables a push button in a task dialog.</summary>
/// <summary>Enables or disables a push button in a task dialog.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>An <c>int</c> value that specifies the ID of the push button to be enabled or disabled.</para>
@ -413,10 +422,11 @@ namespace Vanara.PInvoke
/// <para>Specifies button state. Set to 0 to disable the button; set to nonzero to enable the button.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdm-enable-button
TDM_ENABLE_BUTTON = WindowMessage.WM_USER + 111, // lParam = 0 (disable), lParam != 0 (enable), wParam = Button ID
/// <summary>Enables or disables a radio button in a task dialog.</summary>
/// <summary>Enables or disables a radio button in a task dialog.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>An <c>int</c> value that specifies the ID of the radio button to be enabled or disabled.</para>
@ -424,10 +434,11 @@ namespace Vanara.PInvoke
/// <para>Specifies button state. Set to 0 to disable the button; set to nonzero to enable the button.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdm-enable-radio-button
TDM_ENABLE_RADIO_BUTTON = WindowMessage.WM_USER + 112, // lParam = 0 (disable), lParam != 0 (enable), wParam = Radio Button ID
/// <summary>Simulates a click of the verification checkbox of a task dialog, if it exists.</summary>
/// <summary>Simulates a click of the verification checkbox of a task dialog, if it exists.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para><c>TRUE</c> to set the state of the checkbox to be checked; <c>FALSE</c> to set it to be unchecked.</para>
@ -435,10 +446,11 @@ namespace Vanara.PInvoke
/// <para><c>TRUE</c> to set the keyboard focus to the checkbox; <c>FALSE</c> otherwise.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdm-click-verification
TDM_CLICK_VERIFICATION = WindowMessage.WM_USER + 113, // wParam = 0 (unchecked), 1 (checked), lParam = 1 (set key focus)
/// <summary>Updates a text element in a task dialog.</summary>
/// <summary>Updates a text element in a task dialog.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -471,6 +483,7 @@ namespace Vanara.PInvoke
/// <para>Pointer to a Unicode string that contains the new text.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
/// <remarks>
/// <para>
/// To avoid clipping, the new text must be no longer than the existing text. Setting the text to a shorter string does not cause
@ -488,7 +501,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Specifies whether a given task dialog button or command link should have a User Account Control (UAC) shield icon; that is,
/// whether the action invoked by the button requires elevation.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>The ID of the push button or command link to be updated.</para>
@ -499,10 +511,11 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdm-set-button-elevation-required-state
TDM_SET_BUTTON_ELEVATION_REQUIRED_STATE = WindowMessage.WM_USER + 115, // wParam = Button ID, lParam = 0 (elevation not required), lParam != 0 (elevation required)
/// <summary>Refreshes the icon of a task dialog.</summary>
/// <summary>Refreshes the icon of a task dialog.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Indicates which icon element to update. This parameter must be one of the following values:</para>
@ -566,6 +579,7 @@ namespace Vanara.PInvoke
/// </list>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
/// <remarks>
/// <para>
/// The layout of the task dialog with the icon may fail and this may not be reflected in the return value. A return value of
@ -596,7 +610,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TDN_CREATED WPARAM wParam; LPARAM lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -604,6 +617,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdn-created
TDN_CREATED = 0,
@ -615,7 +629,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TDN_NAVIGATED WPARAM wParam; LPARAM lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -623,6 +636,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdn-navigated
TDN_NAVIGATED = 1,
@ -634,7 +648,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TDN_BUTTON_CLICKED WPARAM wParam; LPARAM lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>An <c>int</c> that specifies the ID of the button or comand link that was selected.</para>
@ -645,6 +658,7 @@ namespace Vanara.PInvoke
/// To prevent the task dialog from closing, the application must return <c>S_FALSE</c>, otherwise the task dialog is closed and
/// the button ID is returned via the original application call.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdn-button-clicked
TDN_BUTTON_CLICKED = 2,
@ -656,7 +670,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TDN_HYPERLINK_CLICKED WPARAM wParam; LPARAM lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -664,6 +677,7 @@ namespace Vanara.PInvoke
/// <para>Pointer to a wide-character string containing the URL of the hyperlink.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdn-hyperlink-clicked
TDN_HYPERLINK_CLICKED = 3,
@ -677,7 +691,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TDN_TIMER WPARAM wParam; LPARAM lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -687,6 +700,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>To reset the tickcount, the application must return <c>S_FALSE</c>, otherwise the tickcount will continue to increment.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdn-timer
TDN_TIMER = 4,
@ -698,7 +712,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TDN_DESTROYED WPARAM wParam; LPARAM lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -706,6 +719,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdn-destroyed
TDN_DESTROYED = 5,
@ -717,7 +731,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TDN_RADIO_BUTTON_CLICKED WPARAM wParam; LPARAM lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>An <c>int</c> that specifies the ID corresponding to the radio button that was clicked.</para>
@ -725,6 +738,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdn-radio-button-clicked
TDN_RADIO_BUTTON_CLICKED = 6,
@ -736,7 +750,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TDN_DIALOG_CONSTRUCTED WPARAM wParam; LPARAM lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -744,6 +757,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdn-dialog-constructed
TDN_DIALOG_CONSTRUCTED = 7,
@ -755,7 +769,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TDN_VERIFICATION_CLICKED WPARAM wParam; LPARAM lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -766,6 +779,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdn-verification-clicked
TDN_VERIFICATION_CLICKED = 8,
@ -777,7 +791,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TDN_HELP WPARAM wParam; LPARAM lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -785,6 +798,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tdn-help
TDN_HELP = 9,
@ -796,7 +810,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TDN_EXPANDO_BUTTON_CLICKED WPARAM wParam; LPARAM lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>A <c>BOOL</c> that is <c>TRUE</c> if the dialog is expanded, or <c>FALSE</c> if not.</para>
@ -804,6 +817,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
/// <remarks>
/// The example in the Syntax section shows the cast to wParam before sending the notification. <c>LPARAM</c> is not used and
/// must be zero.

106
PInvoke/ComCtl32/CommCtrl.ToolTip.cs
View File

@ -91,7 +91,7 @@ namespace Vanara.PInvoke
[PInvokeData("Commctrl.h", MSDNShortId = "bb760542")]
public enum ToolTipMessage
{
/// <summary>Activates or deactivates a tooltip control.</summary>
/// <summary>Activates or deactivates a tooltip control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -102,10 +102,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-activate
TTM_ACTIVATE = WindowMessage.WM_USER + 1,
/// <summary>Sets the initial, pop-up, and reshow durations for a tooltip control.</summary>
/// <summary>Sets the initial, pop-up, and reshow durations for a tooltip control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Flag that specifies which time value to set. This parameter can be one of the following values</para>
@ -148,6 +149,7 @@ namespace Vanara.PInvoke
/// <para>The <c>LOWORD</c> specifies the delay time, in milliseconds. The <c>HIWORD</c> must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this message is not used.</para>
/// </summary>
/// <remarks>
/// <para>
/// The default delay times are based on the double-click time. For the default double-click time of 500 ms, the initial,
@ -161,7 +163,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-setdelaytime
TTM_SETDELAYTIME = WindowMessage.WM_USER + 3,
/// <summary>Registers a tool with a tooltip control.</summary>
/// <summary>Registers a tool with a tooltip control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -172,10 +174,11 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-addtool
TTM_ADDTOOL = WindowMessage.WM_USER + 50,
/// <summary>Removes a tool from a tooltip control.</summary>
/// <summary>Removes a tool from a tooltip control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -186,10 +189,11 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-deltool
TTM_DELTOOL = WindowMessage.WM_USER + 51,
/// <summary>Sets a new bounding rectangle for a tool.</summary>
/// <summary>Sets a new bounding rectangle for a tool.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -200,10 +204,11 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-newtoolrect
TTM_NEWTOOLRECT = WindowMessage.WM_USER + 52,
/// <summary>Passes a mouse message to a tooltip control for processing.</summary>
/// <summary>Passes a mouse message to a tooltip control for processing.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -215,6 +220,7 @@ namespace Vanara.PInvoke
/// <para>Pointer to an <c>MSG</c> structure that contains the message to relay.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// <para>A tooltip control processes only the following messages passed to it by the <c>TTM_RELAYEVENT</c> message:</para>
/// <list type="bullet">
@ -248,7 +254,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-relayevent
TTM_RELAYEVENT = WindowMessage.WM_USER + 7, // Win7: wParam = GetMessageExtraInfo() when relaying WM_MOUSEMOVE
/// <summary>Retrieves the information that a tooltip control maintains about a tool.</summary>
/// <summary>Retrieves the information that a tooltip control maintains about a tool.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -260,11 +266,12 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>If the tooltip control includes the tool, the <c>TOOLINFO</c> structure receives information about the tool.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-gettoolinfo
TTM_GETTOOLINFO = WindowMessage.WM_USER + 53,
/// <summary>Sets the information that a tooltip control maintains for a tool.</summary>
/// <summary>Sets the information that a tooltip control maintains for a tool.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -275,6 +282,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// <para>
/// Some internal properties of a tool are established when the tool is created, and are not recomputed when a
@ -294,7 +302,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Tests a point to determine whether it is within the bounding rectangle of the specified tool and, if it is, retrieves
/// information about the tool.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -307,6 +314,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if the tool occupies the specified point, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>
/// This message must be sent when the tool has the TTF_TRACK flag set. For more information on this flag, see <c>TOOLINFO</c>.
/// TTM_HITTEST will fail if TTF_TRACK is not set, regardless if the hit point is in the tools rectangle or not.
@ -314,7 +322,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-hittest
TTM_HITTEST = WindowMessage.WM_USER + 55,
/// <summary>Retrieves the information a tooltip control maintains about a tool.</summary>
/// <summary>Retrieves the information a tooltip control maintains about a tool.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>The number of **TCHARs**, including the terminating **NULL**, to copy to the buffer pointed to by **lpszText**.</para>
@ -327,10 +335,11 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-gettext
TTM_GETTEXT = WindowMessage.WM_USER + 56,
/// <summary>Sets the tooltip text for a tool.</summary>
/// <summary>Sets the tooltip text for a tool.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -342,10 +351,11 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-updatetiptext
TTM_UPDATETIPTEXT = WindowMessage.WM_USER + 57,
/// <summary>Retrieves a count of the tools maintained by a tooltip control.</summary>
/// <summary>Retrieves a count of the tools maintained by a tooltip control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -353,13 +363,13 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a count of tools.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-gettoolcount
TTM_GETTOOLCOUNT = WindowMessage.WM_USER + 13,
/// <summary>
/// Retrieves the information that a tooltip control maintains about the current tool that is, the tool for which the tooltip is
/// currently displaying text.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Zero-based index of the tool for which to retrieve information.</para>
@ -373,6 +383,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>FALSE</c> whether or not a tool was enumerated.</para>
/// </summary>
/// <remarks>
/// <c>Security Warning:</c> Using this message might compromise the security of your program. This message does not provide a
/// way for the message receiver to know the size of the buffer or to specify the size of the buffer. You should review the
@ -381,7 +392,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-enumtools
TTM_ENUMTOOLS = WindowMessage.WM_USER + 58,
/// <summary>Retrieves the information for the current tool in a tooltip control.</summary>
/// <summary>Retrieves the information for the current tool in a tooltip control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -395,12 +406,12 @@ namespace Vanara.PInvoke
/// <para>
/// Returns nonzero if successful, or zero otherwise. If lParam is <c>NULL</c>, returns nonzero if a current tool exists, or zero otherwise.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-getcurrenttool
TTM_GETCURRENTTOOL = WindowMessage.WM_USER + 59,
/// <summary>
/// Allows a subclass procedure to cause a tooltip to display text for a window other than the one beneath the mouse cursor.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -410,6 +421,7 @@ namespace Vanara.PInvoke
/// <para>
/// The return value is the handle to the window that contains the point, or <c>NULL</c> if no window exists at the specified point.
/// </para>
/// </summary>
/// <remarks>
/// This message is intended to be processed by an application that subclasses a tooltip. It is not intended to be sent by an
/// application. A tooltip sends this message to itself before displaying the text for a window. By changing the coordinates of
@ -419,7 +431,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-windowfrompoint
TTM_WINDOWFROMPOINT = WindowMessage.WM_USER + 16,
/// <summary>Activates or deactivates a tracking tooltip.</summary>
/// <summary>Activates or deactivates a tracking tooltip.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Value specifying whether tracking is being activated or deactivated. This value can be one of the following:</para>
@ -444,10 +456,11 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this message is not used.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-trackactivate
TTM_TRACKACTIVATE = WindowMessage.WM_USER + 17, // wParam = TRUE/FALSE start end lparam = LPTOOLINFO
/// <summary>Sets the position of a tracking tooltip.</summary>
/// <summary>Sets the position of a tracking tooltip.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -459,6 +472,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this message is not used.</para>
/// </summary>
/// <remarks>
/// The tooltip control chooses where to display the tooltip window based on the coordinates you provide with this message. This
/// causes the tooltip window to appear beside the tool to which it corresponds. To have tooltip windows displayed at specific
@ -467,7 +481,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-trackposition
TTM_TRACKPOSITION = WindowMessage.WM_USER + 18, // lParam = dwPos
/// <summary>Sets the background color in a tooltip window.</summary>
/// <summary>Sets the background color in a tooltip window.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>New background color.</para>
@ -475,11 +489,12 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this message is not used.</para>
/// </summary>
/// <remarks>When visual styles are enabled, this message has no effect.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-settipbkcolor
TTM_SETTIPBKCOLOR = WindowMessage.WM_USER + 19,
/// <summary>Sets the text color in a tooltip window.</summary>
/// <summary>Sets the text color in a tooltip window.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>New text color.</para>
@ -487,11 +502,12 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this message is not used.</para>
/// </summary>
/// <remarks>When visual styles are enabled, this message has no effect.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-settiptextcolor
TTM_SETTIPTEXTCOLOR = WindowMessage.WM_USER + 20,
/// <summary>Retrieves the initial, pop-up, and reshow durations currently set for a tooltip control.</summary>
/// <summary>Retrieves the initial, pop-up, and reshow durations currently set for a tooltip control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Flag that specifies which duration value will be retrieved. This parameter can have one of the following values:</para>
@ -523,10 +539,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns and INT value with the specified duration in milliseconds.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-getdelaytime
TTM_GETDELAYTIME = WindowMessage.WM_USER + 21,
/// <summary>Retrieves the background color in a tooltip window.</summary>
/// <summary>Retrieves the background color in a tooltip window.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -534,10 +551,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a <c>COLORREF</c> value that represents the background color.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-gettipbkcolor
TTM_GETTIPBKCOLOR = WindowMessage.WM_USER + 22,
/// <summary>Retrieves the text color in a tooltip window.</summary>
/// <summary>Retrieves the text color in a tooltip window.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -545,10 +563,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a <c>COLORREF</c> value that represents the text color.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-gettiptextcolor
TTM_GETTIPTEXTCOLOR = WindowMessage.WM_USER + 23,
/// <summary>Sets the maximum width for a tooltip window.</summary>
/// <summary>Sets the maximum width for a tooltip window.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -556,6 +575,7 @@ namespace Vanara.PInvoke
/// <para>Maximum tooltip window width, or -1 to allow any width.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous maximum tooltip width.</para>
/// </summary>
/// <remarks>
/// The maximum width value does not indicate a tooltip window's actual width. Rather, if a tooltip string exceeds the maximum
/// width, the control breaks the text into multiple lines, using spaces to determine line breaks. If the text cannot be
@ -564,7 +584,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-setmaxtipwidth
TTM_SETMAXTIPWIDTH = WindowMessage.WM_USER + 24,
/// <summary>Retrieves the maximum width for a tooltip window.</summary>
/// <summary>Retrieves the maximum width for a tooltip window.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -575,6 +595,7 @@ namespace Vanara.PInvoke
/// Returns an <c>INT</c> value that represents the maximum tooltip width, in pixels. If no maximum width was set previously, the
/// message returns -1.
/// </para>
/// </summary>
/// <remarks>
/// The maximum tooltip width value does not indicate a tooltip window's actual width. Rather, if a tooltip string exceeds the
/// maximum width, the control breaks the text into multiple lines, using spaces to determine line breaks. If the text cannot be
@ -586,7 +607,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets the top, left, bottom, and right margins for a tooltip window. A margin is the distance, in pixels, between the tooltip
/// window border and the text contained within the tooltip window.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -619,6 +639,7 @@ namespace Vanara.PInvoke
/// </list>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this message is not used.</para>
/// </summary>
/// <remarks>
/// This message has no effect when the application runs on Windows Vista and visual styles are enabled for the tooltip. You can
/// disable visual styles for the tooltip by using <c>SetWindowTheme</c>.
@ -629,7 +650,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the top, left, bottom, and right margins set for a tooltip window. A margin is the distance, in pixels, between the
/// tooltip window border and the text contained within the tooltip window.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -662,11 +682,12 @@ namespace Vanara.PInvoke
/// </list>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this message is not used.</para>
/// </summary>
/// <remarks>All four margins default to zero when you create the tooltip control.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-getmargin
TTM_GETMARGIN = WindowMessage.WM_USER + 27, // lParam = lprc
/// <summary>Removes a displayed tooltip window from view.</summary>
/// <summary>Removes a displayed tooltip window from view.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -674,10 +695,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this message is not used.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-pop
TTM_POP = WindowMessage.WM_USER + 28,
/// <summary>Forces the current tooltip to be redrawn.</summary>
/// <summary>Forces the current tooltip to be redrawn.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -685,10 +707,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this message is not used.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-update
TTM_UPDATE = WindowMessage.WM_USER + 29,
/// <summary>Returns the width and height of a tooltip control.</summary>
/// <summary>Returns the width and height of a tooltip control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -698,6 +721,7 @@ namespace Vanara.PInvoke
/// <para>
/// Returns the width of the tooltip in the low word and the height in the high word if successful. Otherwise, it returns <c>FALSE</c>.
/// </para>
/// </summary>
/// <remarks>
/// If the TTF_TRACK and TTF_ABSOLUTE flags are set in the <c>uFlags</c> member of the tooltip <c>TOOLINFO</c> structure, this
/// message can be used to help position the tooltip accurately.
@ -708,7 +732,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Calculates a tooltip control's text display rectangle from its window rectangle, or the tooltip window rectangle needed to
/// display a specified text display rectangle.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -720,6 +743,7 @@ namespace Vanara.PInvoke
/// <para><c>RECT</c> structure to hold either a tooltip window rectangle or a text display rectangle.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a nonzero value if the rectangle is successfully adjusted, and returns zero if an error occurs.</para>
/// </summary>
/// <remarks>
/// <para>
/// This message is particularly useful when you want to use a tooltip control to display the full text of a string that is
@ -753,7 +777,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-adjustrect
TTM_ADJUSTRECT = WindowMessage.WM_USER + 31,
/// <summary>Adds a standard icon and title string to a tooltip.</summary>
/// <summary>Adds a standard icon and title string to a tooltip.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -798,6 +822,7 @@ namespace Vanara.PInvoke
/// <para>Pointer to the title string. You must assign a value to lParam.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, <c>FALSE</c> if not.</para>
/// </summary>
/// <remarks>
/// <para>
/// The title of a tooltip appears above the text, in a different font. It is not sufficient to have a title; the tooltip must
@ -812,7 +837,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-settitle
TTM_SETTITLE = WindowMessage.WM_USER + 33, // wParam = TTI_*, lParam = wchar* szTitle
/// <summary>Causes the tooltip to display at the coordinates of the last mouse message.</summary>
/// <summary>Causes the tooltip to display at the coordinates of the last mouse message.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -820,6 +845,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is not used.</para>
/// </summary>
/// <remarks>
/// <para>Note</para>
/// <para>
@ -830,7 +856,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-popup
TTM_POPUP = WindowMessage.WM_USER + 34,
/// <summary>Retrieve information concerning the title of a tooltip control.</summary>
/// <summary>Retrieve information concerning the title of a tooltip control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -838,6 +864,7 @@ namespace Vanara.PInvoke
/// <para>Pointer to a <c>TTGETTITLE</c> structure that contains information about a tooltip title.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is not used.</para>
/// </summary>
/// <remarks>
/// <para>Note</para>
/// <para>
@ -848,7 +875,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/ttm-gettitle
TTM_GETTITLE = WindowMessage.WM_USER + 35, // wParam = 0, lParam = TTGETTITLE*
/// <summary>Sets the visual style of a tooltip control.</summary>
/// <summary>Sets the visual style of a tooltip control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -856,6 +883,7 @@ namespace Vanara.PInvoke
/// <para>Pointer to a Unicode string that contains the tooltip visual style to set.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is not used.</para>
/// </summary>
/// <remarks>
/// <para>Note</para>
/// <para>
@ -879,12 +907,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TTN_GETDISPINFO lpnmtdi = (LPNMTTDISPINFO) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>Pointer to an <c>NMTTDISPINFO</c> structure that identifies the tool that needs text and receives the requested information.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this notification is not used.</para>
/// </summary>
/// <remarks>
/// Fill the structure's appropriate members to return the requested information to the tooltip control. If your message handler
/// sets the <c>uFlags</c> member of the <c>NMTTDISPINFO</c> structure to TTF_DI_SETITEM, the tooltip control stores the
@ -901,7 +929,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TTN_SHOW pnmh = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>Pointer to an <c>NMHDR</c> structure.</para>
@ -914,6 +941,7 @@ namespace Vanara.PInvoke
/// <para>Note</para>
/// <para>For versions earlier than 4.70, there is no return value.</para>
/// </para>
/// </summary>
/// <remarks>
/// A tooltip window rectangle is somewhat larger than its text display rectangle, and its origin is offset up and to the left.
/// If you need to accurately position the text display rectangle of a tooltip, the <c>TTM_ADJUSTRECT</c> message converts a text
@ -930,12 +958,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TTN_POP pnmh = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>Pointer to an <c>NMHDR</c> structure.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/ttn-pop
TTN_POP = TTN_FIRST - 2,
@ -946,9 +974,9 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TTN_LINKCLICK</code>
/// </para>
/// </summary>
/// <para><strong>Returns</strong></para>
/// <para>Return value not used.</para>
/// </summary>
/// <remarks>
/// <para>
/// Following is an example of when this notification is sent. Assume that your balloon tooltip contains the following text,
@ -973,12 +1001,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TTN_NEEDTEXT lpnmtdi = (LPNMTTDISPINFO) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>Pointer to an <c>NMTTDISPINFO</c> structure that identifies the tool that needs text and receives the requested information.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this notification is not used.</para>
/// </summary>
/// <remarks>
/// Fill the structure's appropriate members to return the requested information to the tooltip control. If your message handler
/// sets the <c>uFlags</c> member of the <c>NMTTDISPINFO</c> structure to TTF_DI_SETITEM, the tooltip control stores the

94
PInvoke/ComCtl32/CommCtrl.Trackbar.cs
View File

@ -28,7 +28,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the current logical position of the slider in a trackbar. The logical positions are the integer values in the
/// trackbar's range of minimum to maximum slider positions.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -36,10 +35,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a 32-bit value that specifies the current logical position of the trackbar's slider.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-getpos
TBM_GETPOS = WindowMessage.WM_USER,
/// <summary>Retrieves the minimum position for the slider in a trackbar.</summary>
/// <summary>Retrieves the minimum position for the slider in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -47,10 +47,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a 32-bit value that specifies the minimum position in the trackbar's range of minimum to maximum slider positions.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-getrangemin
TBM_GETRANGEMIN = WindowMessage.WM_USER + 1,
/// <summary>Retrieves the maximum position for the slider in a trackbar.</summary>
/// <summary>Retrieves the maximum position for the slider in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -58,13 +59,13 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a 32-bit value that specifies the maximum position in the trackbar's range of minimum to maximum slider positions.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-getrangemax
TBM_GETRANGEMAX = WindowMessage.WM_USER + 2,
/// <summary>
/// Retrieves the logical position of a tick mark in a trackbar. The logical position can be any of the integer values in the
/// trackbar's range of minimum to maximum slider positions.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -75,10 +76,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the logical position of the specified tick mark, or -1 if wParam does not specify a valid index.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-gettic
TBM_GETTIC = WindowMessage.WM_USER + 3,
/// <summary>Sets a tick mark in a trackbar at the specified logical position.</summary>
/// <summary>Sets a tick mark in a trackbar at the specified logical position.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -89,13 +91,14 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if the tick mark is set, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>
/// A trackbar creates its own first and last tick marks. Do not use this message to set the first and last tick marks.
/// </remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-settic
TBM_SETTIC = WindowMessage.WM_USER + 4,
/// <summary>Sets the current logical position of the slider in a trackbar.</summary>
/// <summary>Sets the current logical position of the slider in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -111,10 +114,11 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-setpos
TBM_SETPOS = WindowMessage.WM_USER + 5,
/// <summary>Sets the range of minimum and maximum logical positions for the slider in a trackbar.</summary>
/// <summary>Sets the range of minimum and maximum logical positions for the slider in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -125,6 +129,7 @@ namespace Vanara.PInvoke
/// <para>The <c>LOWORD</c> specifies the minimum position for the slider, and the <c>HIWORD</c> specifies the maximum position.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// <para>
/// If the current slider position is outside the new range, the <c>TBM_SETRANGE</c> message sets the slider position to the new
@ -138,7 +143,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-setrange
TBM_SETRANGE = WindowMessage.WM_USER + 6,
/// <summary>Sets the minimum logical position for the slider in a trackbar.</summary>
/// <summary>Sets the minimum logical position for the slider in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -149,6 +154,7 @@ namespace Vanara.PInvoke
/// <para>Minimum position for the slider.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// If the current slider position is less than the new minimum, the <c>TBM_SETRANGEMIN</c> message sets the slider position to
/// the new minimum value.
@ -156,7 +162,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-setrangemin
TBM_SETRANGEMIN = WindowMessage.WM_USER + 7,
/// <summary>Sets the maximum logical position for the slider in a trackbar.</summary>
/// <summary>Sets the maximum logical position for the slider in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -167,6 +173,7 @@ namespace Vanara.PInvoke
/// <para>Maximum position for the slider.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// If the current slider position is greater than the new maximum, the <c>TBM_SETRANGEMAX</c> message sets the slider position
/// to the new maximum value.
@ -177,7 +184,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Removes the current tick marks from a trackbar. This message does not remove the first and last tick marks, which are created
/// automatically by the trackbar.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -188,10 +194,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-cleartics
TBM_CLEARTICS = WindowMessage.WM_USER + 9,
/// <summary>Sets the starting and ending positions for the available selection range in a trackbar.</summary>
/// <summary>Sets the starting and ending positions for the available selection range in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -205,6 +212,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// <para>This message is ignored if the trackbar does not have the <c>TBS_ENABLESELRANGE</c> style.</para>
/// <para><c>TBM_SETSEL</c> allows you to restrict the pointer to only a portion of the range available to the progress bar.</para>
@ -215,7 +223,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets the starting logical position of the current selection range in a trackbar. This message is ignored if the trackbar does
/// not have the <c>TBS_ENABLESELRANGE</c> style.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -226,13 +233,13 @@ namespace Vanara.PInvoke
/// <para>Starting position of the selection range.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-setselstart
TBM_SETSELSTART = WindowMessage.WM_USER + 11,
/// <summary>
/// Sets the ending logical position of the current selection range in a trackbar. This message is ignored if the trackbar does
/// not have the <c>TBS_ENABLESELRANGE</c> style.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -243,10 +250,11 @@ namespace Vanara.PInvoke
/// <para>Ending logical position of the selection range.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-setselend
TBM_SETSELEND = WindowMessage.WM_USER + 12,
/// <summary>Retrieves the address of an array that contains the positions of the tick marks for a trackbar.</summary>
/// <summary>Retrieves the address of an array that contains the positions of the tick marks for a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -258,6 +266,7 @@ namespace Vanara.PInvoke
/// trackbar's tick marks, not including the first and last tick marks created by the trackbar. The logical positions can be any
/// of the integer values in the trackbar's range of minimum to maximum slider positions.
/// </para>
/// </summary>
/// <remarks>
/// The number of elements in the array is two less than the tick count returned by the <c>TBM_GETNUMTICS</c> message. Note that
/// the values in the array may include duplicate positions and may not be in sequential order. The returned pointer is valid
@ -266,7 +275,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-getptics
TBM_GETPTICS = WindowMessage.WM_USER + 14,
/// <summary>Retrieves the current physical position of a tick mark in a trackbar.</summary>
/// <summary>Retrieves the current physical position of a tick mark in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -280,6 +289,7 @@ namespace Vanara.PInvoke
/// The return value is the x-coordinate of the tick mark for a horizontal trackbar or the y-coordinate for a vertical trackbar.
/// If wParam is not a valid index, the return value is -1.
/// </para>
/// </summary>
/// <remarks>
/// <para>
/// Because the first and last tick marks are not available through this message, valid indexes are offset from their tick
@ -297,7 +307,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-getticpos
TBM_GETTICPOS = WindowMessage.WM_USER + 15,
/// <summary>Retrieves the number of tick marks in a trackbar.</summary>
/// <summary>Retrieves the number of tick marks in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -308,13 +318,14 @@ namespace Vanara.PInvoke
/// If no tick flag is set, it returns 2 for the beginning and ending ticks. If <c>TBS_NOTICKS</c> is set, it returns zero.
/// Otherwise, it takes the difference between the range minimum and maximum, divides by the tick frequency, and adds 2.
/// </para>
/// </summary>
/// <remarks>
/// The <c>TBM_GETNUMTICS</c> message counts all of the tick marks, including the first and last tick marks created by the trackbar.
/// </remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-getnumtics
TBM_GETNUMTICS = WindowMessage.WM_USER + 16,
/// <summary>Retrieves the starting position of the current selection range in a trackbar.</summary>
/// <summary>Retrieves the starting position of the current selection range in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -322,13 +333,14 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a 32-bit value that specifies the starting position of the current selection range.</para>
/// </summary>
/// <remarks>
/// A trackbar can have a selection range only if you specified the <c>TBS_ENABLESELRANGE</c> style when you created it.
/// </remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-getselstart
TBM_GETSELSTART = WindowMessage.WM_USER + 17,
/// <summary>Retrieves the ending position of the current selection range in a trackbar.</summary>
/// <summary>Retrieves the ending position of the current selection range in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -336,13 +348,14 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a 32-bit value that specifies the ending position of the current selection range.</para>
/// </summary>
/// <remarks>
/// A trackbar can have a selection range only if you specified the <c>TBS_ENABLESELRANGE</c> style when you created it.
/// </remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-getselend
TBM_GETSELEND = WindowMessage.WM_USER + 18,
/// <summary>Clears the current selection range in a trackbar.</summary>
/// <summary>Clears the current selection range in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Redraw flag. If this parameter is <c>TRUE</c>, the trackbar is redrawn after the selection is cleared.</para>
@ -350,6 +363,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// A trackbar can have a selection range only if you specified the <c>TBS_ENABLESELRANGE</c> style when you created it.
/// </remarks>
@ -360,7 +374,6 @@ namespace Vanara.PInvoke
/// Sets the interval frequency for tick marks in a trackbar. For example, if the frequency is set to two, a tick mark is
/// displayed for every other increment in the trackbar's range. The default setting for the frequency is one; that is, every
/// increment in the range is associated with a tick mark.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Frequency of the tick marks.</para>
@ -368,6 +381,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>The trackbar must have the <c>TBS_AUTOTICKS</c> style to use this message.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-setticfreq
TBM_SETTICFREQ = WindowMessage.WM_USER + 20,
@ -376,7 +390,6 @@ namespace Vanara.PInvoke
/// Sets the number of logical positions the trackbar's slider moves in response to keyboard input, such as the or keys, or mouse
/// input, such as clicks in the trackbar's channel. The logical positions are the integer increments in the trackbar's range of
/// minimum to maximum slider positions.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -384,6 +397,7 @@ namespace Vanara.PInvoke
/// <para>New page size.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a 32-bit value that specifies the previous page size.</para>
/// </summary>
/// <remarks>
/// The trackbar also sends a <c>WM_HSCROLL</c> or <c>WM_VSCROLL</c> message with the TB_PAGEUP and TB_PAGEDOWN notification
/// codes to its parent window when it receives keyboard or mouse input that scrolls the page.
@ -395,7 +409,6 @@ namespace Vanara.PInvoke
/// Retrieves the number of logical positions the trackbar's slider moves in response to keyboard input, such as the or keys, or
/// mouse input, such as clicks in the trackbar's channel. The logical positions are the integer increments in the trackbar's
/// range of minimum to maximum slider positions.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -403,6 +416,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a 32-bit value that specifies the page size for the trackbar.</para>
/// </summary>
/// <remarks>
/// The trackbar also sends a <c>WM_HSCROLL</c> or <c>WM_VSCROLL</c> message with the TB_PAGEUP and TB_PAGEDOWN notification
/// codes to its parent window when it receives keyboard or mouse input that scrolls the page.
@ -413,7 +427,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets the number of logical positions the trackbar's slider moves in response to keyboard input from the arrow keys, such as
/// the or keys. The logical positions are the integer increments in the trackbar's range of minimum to maximum slider positions.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -421,6 +434,7 @@ namespace Vanara.PInvoke
/// <para>New line size.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a 32-bit value that specifies the previous line size.</para>
/// </summary>
/// <remarks>
/// <para>The default setting for the line size is 1.</para>
/// <para>
@ -434,7 +448,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the number of logical positions the trackbar's slider moves in response to keyboard input from the arrow keys, such
/// as the or keys. The logical positions are the integer increments in the trackbar's range of minimum to maximum slider positions.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -442,6 +455,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a 32-bit value that specifies the line size for the trackbar.</para>
/// </summary>
/// <remarks>
/// <para>The default setting for the line size is 1.</para>
/// <para>
@ -452,7 +466,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-getlinesize
TBM_GETLINESIZE = WindowMessage.WM_USER + 24,
/// <summary>Retrieves the size and position of the bounding rectangle for the slider in a trackbar.</summary>
/// <summary>Retrieves the size and position of the bounding rectangle for the slider in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -463,13 +477,13 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-getthumbrect
TBM_GETTHUMBRECT = WindowMessage.WM_USER + 25,
/// <summary>
/// Retrieves the size and position of the bounding rectangle for a trackbar's channel. (The channel is the area over which the
/// slider moves. It contains the highlight when a range is selected.)
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -480,12 +494,12 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-getchannelrect
TBM_GETCHANNELRECT = WindowMessage.WM_USER + 26,
/// <summary>
/// Sets the length of the slider in a trackbar. This message is ignored if the trackbar does not have the <c>TBS_FIXEDLENGTH</c> style.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Length, in pixels, of the slider.</para>
@ -493,10 +507,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-setthumblength
TBM_SETTHUMBLENGTH = WindowMessage.WM_USER + 27,
/// <summary>Retrieves the length of the slider in a trackbar.</summary>
/// <summary>Retrieves the length of the slider in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -504,10 +519,11 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the length, in pixels, of the slider.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-getthumblength
TBM_GETTHUMBLENGTH = WindowMessage.WM_USER + 28,
/// <summary>Assigns a tooltip control to a trackbar control.</summary>
/// <summary>Assigns a tooltip control to a trackbar control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Handle to an existing tooltip control.</para>
@ -515,6 +531,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this message is not used.</para>
/// </summary>
/// <remarks>
/// When a trackbar control is created with the <c>TBS_TOOLTIPS</c> style, it creates a default tooltip control that appears next
/// to the slider, displaying the slider's current position.
@ -522,7 +539,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-settooltips
TBM_SETTOOLTIPS = WindowMessage.WM_USER + 29,
/// <summary>Retrieves the handle to the tooltip control assigned to the trackbar, if any.</summary>
/// <summary>Retrieves the handle to the tooltip control assigned to the trackbar, if any.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -533,12 +550,12 @@ namespace Vanara.PInvoke
/// Returns the handle to the tooltip control assigned to the trackbar, or <c>NULL</c> if tooltips are not in use. If the
/// trackbar control does not use the <c>TBS_TOOLTIPS</c> style, the return value is <c>NULL</c>.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-gettooltips
TBM_GETTOOLTIPS = WindowMessage.WM_USER + 30,
/// <summary>
/// Positions a tooltip control used by a trackbar control. Trackbar controls that use the <c>TBS_TOOLTIPS</c> style display tooltips.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Value representing the location at which to display the tooltip control. This value can be one of the following:</para>
@ -571,13 +588,13 @@ namespace Vanara.PInvoke
/// Returns a value that represents the tooltip control's previous location. The return value equals one of the possible values
/// for wParam.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-settipside
TBM_SETTIPSIDE = WindowMessage.WM_USER + 31,
/// <summary>
/// Assigns a window as the buddy window for a trackbar control. Trackbar buddy windows are automatically displayed in a location
/// relative to the control's orientation (horizontal or vertical).
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Value specifying the location at which to display the buddy window. This value can be one of the following:</para>
@ -605,6 +622,7 @@ namespace Vanara.PInvoke
/// <para>Handle to the window that will be set as the trackbar control's buddy.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the handle to the window that was previously assigned to the control at that location.</para>
/// </summary>
/// <remarks>
/// <para>Note</para>
/// <para>
@ -617,7 +635,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the handle to a trackbar control buddy window at a given location. The specified location is relative to the
/// control's orientation (horizontal or vertical).
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Value indicating which buddy window handle will be retrieved, by relative location. This value can be one of the following:</para>
@ -647,10 +664,11 @@ namespace Vanara.PInvoke
/// <para>
/// Returns the handle to the buddy window at the location specified by wParam, or <c>NULL</c> if no buddy window exists at that location.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-getbuddy
TBM_GETBUDDY = WindowMessage.WM_USER + 33,
/// <summary>Sets the current logical position of the slider in a trackbar.</summary>
/// <summary>Sets the current logical position of the slider in a trackbar.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>wParam is unused.</para>
@ -662,6 +680,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// Calling <c>TBM_SETPOSNOTIFY</c> will set the trackbar slider location like <c>TBM_SETPOS</c> would, but it will also cause
/// the trackbar to notify its parent of a move via a <c>WM_HSCROLL</c> or <c>WM_VSCROLL</c> message.
@ -672,7 +691,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets the Unicode character format flag for the control. This message allows you to change the character set used by the
/// control at run time rather than having to re-create the control.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -683,11 +701,12 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous Unicode format flag for the control.</para>
/// </summary>
/// <remarks>See the remarks for <c>CCM_SETUNICODEFORMAT</c> for a discussion of this message.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-setunicodeformat
TBM_SETUNICODEFORMAT = CommonControlMessage.CCM_SETUNICODEFORMAT,
/// <summary>Retrieves the Unicode character format flag for the control.</summary>
/// <summary>Retrieves the Unicode character format flag for the control.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -698,6 +717,7 @@ namespace Vanara.PInvoke
/// Returns the Unicode format flag for the control. If this value is nonzero, the control is using Unicode characters. If this
/// value is zero, the control is using ANSI characters.
/// </para>
/// </summary>
/// <remarks>See the remarks for <c>CCM_GETUNICODEFORMAT</c> for a discussion of this message.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tbm-getunicodeformat
TBM_GETUNICODEFORMAT = CommonControlMessage.CCM_GETUNICODEFORMAT
@ -714,7 +734,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TRBN_THUMBPOSCHANGING lpNMTrbThumbPosChanging = (NMTRBTHUMBPOSCHANGING*) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -723,6 +742,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Return <c>TRUE</c> to prevent the thumb from moving to the specified position.</para>
/// </summary>
/// <remarks>Send this notification to clients that do not listen for <c>WM_HSCROLL</c> or <c>WM_VSCROLL</c> messages.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/trbn-thumbposchanging
TRBN_THUMBPOSCHANGING = TRBN_FIRST

137
PInvoke/ComCtl32/CommCtrl.TreeView.cs
View File

@ -337,7 +337,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Removes an item and all its children from a tree-view control. You can send this message explicitly or by using the
/// <c>TreeView_DeleteItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -348,6 +347,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>
/// <para>It is not safe to delete items in response to a notification such as TVN_SELCHANGING.</para>
/// <para>Once an item is deleted, its handle is invalid and cannot be used.</para>
@ -367,7 +367,6 @@ namespace Vanara.PInvoke
/// <summary>
/// The <c>TVM_EXPAND</c> message expands or collapses the list of child items associated with the specified parent item, if any.
/// You can send this message explicitly or by using the <c>TreeView_Expand</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Action flag. This parameter can be one or more of the following values:</para>
@ -407,6 +406,7 @@ namespace Vanara.PInvoke
/// <para>Handle to the parent item to expand or collapse.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns nonzero if the operation was successful, or zero otherwise.</para>
/// </summary>
/// <remarks>
/// <para>
/// Expanding a node that is already expanded is considered a successful operation and <c>SendMessage</c> returns a nonzero
@ -430,7 +430,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the bounding rectangle for a tree-view item and indicates whether the item is visible. You can send this message
/// explicitly or by using the <c>TreeView_GetItemRect</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -450,6 +449,7 @@ namespace Vanara.PInvoke
/// If the item is visible and the bounding rectangle was successfully retrieved, the return value is <c>TRUE</c>. Otherwise, the
/// message returns <c>FALSE</c> and does not retrieve the bounding rectangle.
/// </para>
/// </summary>
/// <remarks>
/// <para>
/// When sending this message, the lParam parameter contains the handle of the item that the rectangle is being retrieved for.
@ -465,7 +465,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves a count of the items in a tree-view control. You can send this message explicitly or by using the
/// <c>TreeView_GetCount</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -473,6 +472,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the count of items.</para>
/// </summary>
/// <remarks>
/// The node count returned by <c>TreeView_GetCount</c> is limited to integer values. If you add a node beyond 32767 the macro
/// returns a negative value. After adding 65536 nodes the count returns to zero. When this occurs, the tree-view control appears
@ -484,7 +484,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the amount, in pixels, that child items are indented relative to their parent items. You can send this message
/// explicitly or by using the <c>TreeView_GetIndent</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -492,13 +491,13 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the amount of indentation.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-getindent
TVM_GETINDENT = TV_FIRST + 6,
/// <summary>
/// Sets the width of indentation for a tree-view control and redraws the control to reflect the new width. You can send this
/// message explicitly or by using the <c>TreeView_SetIndent</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -509,6 +508,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// The system-defined minimum indent value is typically five pixels, but it is not fixed. To retrieve the exact value of the
/// minimum indent on a particular system, send a <c>TVM_SETINDENT</c> message with wParam set to zero. Then send a
@ -520,7 +520,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the handle to the normal or state image list associated with a tree-view control. You can send this message
/// explicitly or by using the <c>TreeView_GetImageList</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Type of image list to retrieve. This parameter can be one of the following values:</para>
@ -547,13 +546,13 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns an HIMAGELIST handle to the specified image list.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-getimagelist
TVM_GETIMAGELIST = TV_FIRST + 8,
/// <summary>
/// Sets the normal or state image list for a tree-view control and redraws the control using the new images. You can send this
/// message explicitly or by using the <c>TreeView_SetImageList</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Type of image list to set. This parameter can be one of the following values:</para>
@ -582,6 +581,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the handle to the previous image list, if any, or <c>NULL</c> otherwise.</para>
/// </summary>
/// <remarks>
/// The tree-view control will not destroy the image list specified with this message. Your application must destroy the image
/// list when it is no longer needed.
@ -592,7 +592,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the tree-view item that bears the specified relationship to a specified item. You can send this message explicitly,
/// by using the <c>TreeView_GetNextItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Flag specifying the item to retrieve. This parameter can be one of the following values:</para>
@ -682,6 +681,7 @@ namespace Vanara.PInvoke
/// Returns the handle to the item if successful. For most cases, the message returns a <c>NULL</c> value to indicate an error.
/// See the Remarks section for details.
/// </para>
/// </summary>
/// <remarks>
/// <para>
/// This message will return <c>NULL</c> if the item being retrieved is the root node of the tree. For example, if you use this
@ -734,7 +734,6 @@ namespace Vanara.PInvoke
/// Selects the specified tree-view item, scrolls the item into view, or redraws the item in the style used to indicate the
/// target of a drag-and-drop operation. You can send this message explicitly or by using the <c>TreeView_Select</c>,
/// <c>TreeView_SelectItem</c>, or <c>TreeView_SelectDropTarget</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Action flag. This parameter can be one of the following values:</para>
@ -774,6 +773,7 @@ namespace Vanara.PInvoke
/// <para>Handle to an item. If lParam is <c>NULL</c>, the control is set to have no selected item.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>
/// <para>
/// If the specified item is the child of a collapsed parent item, the parent's list of child items is expanded to reveal the
@ -792,7 +792,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the handle to the edit control being used to edit a tree-view item's text. You can send this message explicitly or
/// by using the <c>TreeView_GetEditControl</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -800,6 +799,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the handle to the edit control if successful, or <c>NULL</c> otherwise.</para>
/// </summary>
/// <remarks>
/// <para>
/// When label editing begins, an edit control is created, but not positioned or displayed. Before it is displayed, the tree-view
@ -817,7 +817,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Obtains the number of items that can be fully visible in the client window of a tree-view control. You can send this message
/// explicitly or by using the <c>TreeView_GetVisibleCount</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -825,6 +824,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the number of items that can be fully visible in the client window of the tree-view control.</para>
/// </summary>
/// <remarks>
/// <para>
/// The number of items that can be fully visible may be greater than the number of items in the control. The control calculates
@ -841,7 +841,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Determines the location of the specified point relative to the client area of a tree-view control. You can send this message
/// explicitly or by using the <c>TreeView_HitTest</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -856,6 +855,7 @@ namespace Vanara.PInvoke
/// <para>
/// Returns the handle to the tree-view item that occupies the specified point, or <c>NULL</c> if no item occupies the point.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-hittest
TVM_HITTEST = TV_FIRST + 17,
@ -863,7 +863,6 @@ namespace Vanara.PInvoke
/// Creates a dragging bitmap for the specified item in a tree-view control. The message also creates an image list for the
/// bitmap and adds the bitmap to the image list. An application can display the image when dragging the item by using the image
/// list functions. You can send this message explicitly or by using the <c>TreeView_CreateDragImage</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -871,6 +870,7 @@ namespace Vanara.PInvoke
/// <para>Handle to the item that receives the new dragging bitmap.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the handle to the image list to which the dragging bitmap was added if successful, or <c>NULL</c> otherwise.</para>
/// </summary>
/// <remarks>
/// <para>
/// If you create a tree-view control without an associated image list, you cannot use the <c>TVM_CREATEDRAGIMAGE</c> message to
@ -884,7 +884,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sorts the child items of the specified parent item in a tree-view control. You can send this message explicitly or by using
/// the <c>TreeView_SortChildren</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -895,6 +894,7 @@ namespace Vanara.PInvoke
/// <para>Handle to the parent item whose child items are to be sorted.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>
/// This message alphabetizes the tree items using <c>lstrcmpi</c> on the item name. You can use the <c>TVM_SORTCHILDRENCB</c>
/// message to customize the ordering behavior.
@ -905,7 +905,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Ensures that a tree-view item is visible, expanding the parent item or scrolling the tree-view control, if necessary. You can
/// send this message explicitly or by using the <c>TreeView_EnsureVisible</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -916,6 +915,7 @@ namespace Vanara.PInvoke
/// Returns nonzero if the system scrolled the items in the tree-view control and no items were expanded. Otherwise, the message
/// returns zero.
/// </para>
/// </summary>
/// <remarks>
/// If the TVM_ENSUREVISIBLE message expands the parent item, the parent window receives the TVN_ITEMEXPANDING and
/// TVN_ITEMEXPANDED notification codes.
@ -926,7 +926,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sorts tree-view items using an application-defined callback function that compares the items. You can send this message
/// explicitly or by using the <c>TreeView_SortChildrenCB</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Reserved. Must be zero.</para>
@ -938,13 +937,13 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-sortchildrencb
TVM_SORTCHILDRENCB = TV_FIRST + 21,
/// <summary>
/// Ends the editing of a tree-view item's label. You can send this message explicitly or by using the
/// <c>TreeView_EndEditLabelNow</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -955,6 +954,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>This message causes the TVN_ENDLABELEDIT notification code to be sent to the parent window of the tree-view control.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-endeditlabelnow
TVM_ENDEDITLABELNOW = TV_FIRST + 22,
@ -962,7 +962,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets a tree-view control's child tooltip control. You can send this message explicitly or by using the
/// <c>TreeView_SetToolTips</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Handle to a tooltip control.</para>
@ -973,6 +972,7 @@ namespace Vanara.PInvoke
/// Returns the handle to tooltip control previously set for the tree-view control, or <c>NULL</c> if tooltips were not
/// previously used.
/// </para>
/// </summary>
/// <remarks>
/// When created, tree-view controls automatically create a child tooltip control. To prevent a tree-view control from using
/// tooltips, create the control with the <c>TVS_NOTOOLTIPS</c> style.
@ -983,7 +983,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the handle to the child tooltip control used by a tree-view control. You can send this message explicitly or by
/// using the <c>TreeView_GetToolTips</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -991,6 +990,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the handle to the child tooltip control, or <c>NULL</c> if the control is not using tooltips.</para>
/// </summary>
/// <remarks>
/// When created, tree-view controls automatically create a child tooltip control. To cause a tree-view control not to use
/// tooltips, create the control with the <c>TVS_NOTOOLTIPS</c> style.
@ -1001,7 +1001,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets the insertion mark in a tree-view control. You can send this message explicitly or by using the
/// <c>TreeView_SetInsertMark</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -1016,6 +1015,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns nonzero if successful, or zero otherwise.</para>
/// </summary>
/// <remarks>
/// In some circumstances, the insert mark can appear in two places after a node is expanded. If you are using insertion marks,
/// it is recommended that you force a refresh of the control after expanding a node.
@ -1027,7 +1027,6 @@ namespace Vanara.PInvoke
/// Sets the Unicode character format flag for the control. This message allows you to change the character set used by the
/// control at run time rather than having to re-create the control. You can send this message explicitly or use the
/// <c>TreeView_SetUnicodeFormat</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -1038,6 +1037,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous Unicode format flag for the control.</para>
/// </summary>
/// <remarks>See the remarks for <c>CCM_SETUNICODEFORMAT</c> for a discussion of this message.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-setunicodeformat
TVM_SETUNICODEFORMAT = CommonControlMessage.CCM_SETUNICODEFORMAT,
@ -1045,7 +1045,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the Unicode character format flag for the control. You can send this message explicitly or use the
/// <c>TreeView_GetUnicodeFormat</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1056,13 +1055,13 @@ namespace Vanara.PInvoke
/// Returns the Unicode format flag for the control. If this value is nonzero, the control is using Unicode characters. If this
/// value is zero, the control is using ANSI characters.
/// </para>
/// </summary>
/// <remarks>See the remarks for <c>CCM_GETUNICODEFORMAT</c> for a discussion of this message.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-getunicodeformat
TVM_GETUNICODEFORMAT = CommonControlMessage.CCM_GETUNICODEFORMAT,
/// <summary>
/// Sets the height of the tree-view items. You can send this message explicitly or by using the <c>TreeView_SetItemHeight</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>
@ -1074,6 +1073,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous height of the items, in pixels.</para>
/// </summary>
/// <remarks>
/// The tree-view control uses this value for the height of all items. To modify the height of individual items, see the
/// description of the <c>iIntegral</c> member of the <c>TVITEMEX</c> structure.
@ -1084,7 +1084,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the current height of the each tree-view item. You can send this message explicitly or by using the
/// <c>TreeView_GetItemHeight</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1092,12 +1091,12 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the height of each item, in pixels.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-getitemheight
TVM_GETITEMHEIGHT = TV_FIRST + 28,
/// <summary>
/// Sets the background color of the control. You can send this message explicitly or by using the <c>TreeView_SetBkColor</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1111,12 +1110,12 @@ namespace Vanara.PInvoke
/// Returns a <c>COLORREF</c> value that represents the previous background color. If this value is -1, the control was using the
/// system color for the background color.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-setbkcolor
TVM_SETBKCOLOR = TV_FIRST + 29,
/// <summary>
/// Sets the text color of the control. You can send this message explicitly or by using the <c>TreeView_SetTextColor</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1130,13 +1129,13 @@ namespace Vanara.PInvoke
/// Returns a <c>COLORREF</c> value that represents the previous text color. If this value is -1, the control was using the
/// system color for the text color.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-settextcolor
TVM_SETTEXTCOLOR = TV_FIRST + 30,
/// <summary>
/// Retrieves the current background color of the control. You can send this message explicitly or by using the
/// <c>TreeView_GetBkColor</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1147,13 +1146,13 @@ namespace Vanara.PInvoke
/// Returns a <c>COLORREF</c> value that represents the current background color. If this value is -1, the control is using the
/// system color for the background color.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-getbkcolor
TVM_GETBKCOLOR = TV_FIRST + 31,
/// <summary>
/// Retrieves the current text color of the control. You can send this message explicitly or by using the
/// <c>TreeView_GetTextColor</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1164,13 +1163,13 @@ namespace Vanara.PInvoke
/// Returns a <c>COLORREF</c> value that represents the current text color. If this value is -1, the control is using the system
/// color for the text color.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-gettextcolor
TVM_GETTEXTCOLOR = TV_FIRST + 32,
/// <summary>
/// Sets the maximum scroll time for the tree-view control. You can send this message explicitly or by using the
/// <c>TreeView_SetScrollTime</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>New maximum scroll time, in milliseconds.</para>
@ -1178,6 +1177,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous maximum scroll time, in milliseconds.</para>
/// </summary>
/// <remarks>
/// The maximum scroll time is the longest amount of time that a scroll operation can take. Scrolling will be adjusted so that
/// the scroll will take place within the maximum scroll time. A scroll operation may take less time than the maximum.
@ -1188,7 +1188,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the maximum scroll time for the tree-view control. You can send this message explicitly or by using the
/// <c>TreeView_GetScrollTime</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1196,6 +1195,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the maximum scroll time, in milliseconds.</para>
/// </summary>
/// <remarks>
/// The maximum scroll time is the longest amount of time that a scroll operation can take. The scrolling will be adjusted so
/// that the scroll will take place within the maximum scroll time. A scroll operation may take less time than the maximum.
@ -1206,7 +1206,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Sets the color used to draw the insertion mark for the tree view. You can send this message explicitly or by using the
/// <c>TreeView_SetInsertMarkColor</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1214,13 +1213,13 @@ namespace Vanara.PInvoke
/// <para><c>COLORREF</c> value that contains the new insertion mark color.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a <c>COLORREF</c> value that contains the previous insertion mark color.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-setinsertmarkcolor
TVM_SETINSERTMARKCOLOR = TV_FIRST + 37,
/// <summary>
/// Retrieves the color used to draw the insertion mark for the tree view. You can send this message explicitly or by using the
/// <c>TreeView_GetInsertMarkColor</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1228,6 +1227,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns a <c>COLORREF</c> value that contains the current insertion mark color.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-getinsertmarkcolor
TVM_GETINSERTMARKCOLOR = TV_FIRST + 38,
@ -1237,7 +1237,6 @@ namespace Vanara.PInvoke
/// Sets the size of the border for the items in a tree-view control. You can send the message explicitly or by using the
/// <c>TreeView_SetBorder</c> macro.
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Action flags. This parameter can be one or more of the following values:</para>
@ -1265,6 +1264,7 @@ namespace Vanara.PInvoke
/// Returns a <c>LONG</c> value that contains the previous border size, in pixels. The <c>LOWORD</c> contains the previous size
/// of the horizontal border, and the <c>HIWORD</c> contains the previous size of the vertical border.
/// </para>
/// </summary>
/// <remarks>
/// <para><c>Security Warning:</c> Using this message might compromise the security of your program.</para>
/// <para>The item border is set just for spacing purposes. A successful setting triggers a recalculation of the scroll bars.</para>
@ -1282,7 +1282,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves some or all of a tree-view item's state attributes. You can send this message explicitly or by using the
/// <c>TreeView_GetItemState</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Handle to the item.</para>
@ -1293,10 +1292,11 @@ namespace Vanara.PInvoke
/// Returns a <c>UINT</c> value with the appropriate state bits set to <c>TRUE</c>. Only those bits that are specified by lParam
/// and that are <c>TRUE</c> will be set. This value is equivalent to the <c>state</c> member of <c>TVITEMEX</c>.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-getitemstate
TVM_GETITEMSTATE = TV_FIRST + 39,
/// <summary>The <c>TVM_SETLINECOLOR</c> message sets the current line color.</summary>
/// <summary>The <c>TVM_SETLINECOLOR</c> message sets the current line color.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1304,6 +1304,7 @@ namespace Vanara.PInvoke
/// <para>New line color. Use the CLR_DEFAULT value to restore the system default colors.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the previous line color.</para>
/// </summary>
/// <remarks>
/// This message only changes line colors. To change the colors of the '+' and '-' inside the buttons, use the
/// <c>TVM_SETTEXTCOLOR</c> message.
@ -1311,7 +1312,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-setlinecolor
TVM_SETLINECOLOR = TV_FIRST + 40,
/// <summary>The <c>TVM_GETLINECOLOR</c> message gets the current line color.</summary>
/// <summary>The <c>TVM_GETLINECOLOR</c> message gets the current line color.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1319,6 +1320,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the current line color, or the CLR_DEFAULT value if none has been specified.</para>
/// </summary>
/// <remarks>
/// This message only retrieves line colors. To retrieve the colors of the '+' and '-' inside the buttons, use the
/// <c>TVM_GETTEXTCOLOR</c> message.
@ -1326,7 +1328,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-getlinecolor
TVM_GETLINECOLOR = TV_FIRST + 41,
/// <summary>Maps an accessibility ID to an <c>HTREEITEM</c>.</summary>
/// <summary>Maps an accessibility ID to an <c>HTREEITEM</c>.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>**UINT** that contains the accessibility ID to map to an **HTREEITEM**.</para>
@ -1334,6 +1336,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the <c>HTREEITEM</c> that the specified accessibility ID is mapped to.</para>
/// </summary>
/// <remarks>
/// <para>When you add an item to a tree-view control an <c>HTREEITEM</c> returns, which uniquely identifies the item.</para>
/// <para>
@ -1347,7 +1350,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-mapaccidtohtreeitem
TVM_MAPACCIDTOHTREEITEM = TV_FIRST + 42,
/// <summary>Maps an <c>HTREEITEM</c> to an accessibility ID.</summary>
/// <summary>Maps an <c>HTREEITEM</c> to an accessibility ID.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>**HTREEITEM** that is mapped to an accessibility ID.</para>
@ -1355,6 +1358,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns an accessibility ID.</para>
/// </summary>
/// <remarks>
/// <para>When you add an item to a tree-view control an <c>HTREEITEM</c> handle is returned that uniquely identifies the item.</para>
/// <para>
@ -1368,7 +1372,7 @@ namespace Vanara.PInvoke
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-maphtreeitemtoaccid
TVM_MAPHTREEITEMTOACCID = TV_FIRST + 43,
/// <summary>Informs the tree-view control to set extended styles. Send this message or use the macro <c>TreeView_SetExtendedStyle</c>.</summary>
/// <summary>Informs the tree-view control to set extended styles. Send this message or use the macro <c>TreeView_SetExtendedStyle</c>.
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Mask used to select the styles to be set.</para>
@ -1376,6 +1380,7 @@ namespace Vanara.PInvoke
/// <para>Value that indicates the extended style. For more information on styles, see Tree-View Control Extended Styles.</para>
/// <para><strong>Returns</strong></para>
/// <para>If this message succeeds, it returns <c>S_OK</c>. Otherwise, it returns an <c>HRESULT</c> error code.</para>
/// </summary>
/// <remarks>
/// The extended styles for a tree-view control have nothing to do with the extended styles used with function
/// <c>CreateWindowEx</c> or function <c>SetWindowLong</c>.
@ -1386,7 +1391,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves the extended style for a tree-view control. Send this message explicitly or by using the
/// <c>TreeView_GetExtendedStyle</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1394,6 +1398,7 @@ namespace Vanara.PInvoke
/// <para>Must be zero.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the value of extended style.For more information on styles, see Tree-View Control Extended Styles.</para>
/// </summary>
/// <remarks>
/// The extended styles for a tree-view control have nothing to do with the extended styles used with function
/// <c>CreateWindowEx</c> or function <c>SetWindowLong</c>.
@ -1403,7 +1408,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Inserts a new item in a tree-view control. You can send this message explicitly or by using the <c>TreeView_InsertItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1411,13 +1415,13 @@ namespace Vanara.PInvoke
/// <para>Pointer to a <c>TVINSERTSTRUCT</c> structure that specifies the attributes of the tree-view item.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the <c>HTREEITEM</c> handle to the new item if successful, or <c>NULL</c> otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvm-insertitem
TVM_INSERTITEM = TV_FIRST + 50,
/// <summary>
/// Sets information used to determine auto-scroll characteristics. You can send this message explicitly or by using the
/// <c>TreeView_SetAutoScrollInfo</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Specifies pixels per second. The offset to scroll is divided by the wParam to determine the total duration of the auto-scroll.</para>
@ -1428,6 +1432,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c>.</para>
/// </summary>
/// <remarks>
/// Autoscroll information is used to scroll a nonvisible item into view. The control must have the <c>TVS_EX_AUTOHSCROLL</c>
/// extended style. For information on extended styles, see Tree-View Control Extended Styles.
@ -1442,7 +1447,6 @@ namespace Vanara.PInvoke
/// <para>
/// Sets the hot item for a tree-view control. You can send this message explicitly or by using the <c>TreeView_SetHot</c> macro.
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1450,6 +1454,7 @@ namespace Vanara.PInvoke
/// <para>Handle to the new hot item. If this value is <c>NULL</c>, the tree-view control will be set to have no hot item.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>
/// <para>
/// The hot item is the item that the mouse is hovering over. This message makes an item look like it is the hot item even if the
@ -1465,7 +1470,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Retrieves some or all of a tree-view item's attributes. You can send this message explicitly or by using the
/// <c>TreeView_GetItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1476,6 +1480,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>
/// <para>
/// When the message is sent, the <c>hItem</c> member of the <c>TVITEM</c> or <c>TVITEMEX</c> structure identifies the item to
@ -1492,7 +1497,6 @@ namespace Vanara.PInvoke
/// <summary>
/// The <c>TVM_SETITEM</c> message sets some or all of a tree-view item's attributes. You can send this message explicitly or by
/// using the <c>TreeView_SetItem</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1503,6 +1507,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
/// <remarks>
/// The <c>hItem</c> member of the <c>TVITEM</c> or <c>TVITEMEX</c> structure identifies the item, and the <c>mask</c> member
/// specifies which attributes to set.
@ -1514,7 +1519,6 @@ namespace Vanara.PInvoke
/// Retrieves the incremental search string for a tree-view control. The tree-view control uses the incremental search string to
/// select an item based on characters typed by the user. You can send this message explicitly or by using the
/// <c>TreeView_GetISearchString</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1522,6 +1526,7 @@ namespace Vanara.PInvoke
/// <para>Pointer to the buffer that receives the incremental search string.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the number of characters in the incremental search string.</para>
/// </summary>
/// <remarks>
/// <para>
/// <c>Security Warning:</c> Using this message incorrectly might compromise the security of your program. You must allocate a
@ -1538,7 +1543,6 @@ namespace Vanara.PInvoke
/// Begins in-place editing of the specified item's text, replacing the text of the item with a single-line edit control
/// containing the text. This message implicitly selects and focuses the specified item. You can send this message explicitly or
/// by using the <c>TreeView_EditLabel</c> macro.
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1546,6 +1550,7 @@ namespace Vanara.PInvoke
/// <para>Handle to the item to edit.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns the handle to the edit control used to edit the item text if successful, or <c>NULL</c> otherwise.</para>
/// </summary>
/// <remarks>
/// <para>This message sends a TVN_BEGINLABELEDIT notification code to the parent of the tree-view control.</para>
/// <para>
@ -1566,7 +1571,6 @@ namespace Vanara.PInvoke
/// <summary>
/// Shows the infotip for a specified item in a tree-view control. You can send this message explicitly or by using the
/// <c>TreeView_ShowInfoTip</c> macro..
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>wParam</em></para>
/// <para>Must be zero.</para>
@ -1574,6 +1578,7 @@ namespace Vanara.PInvoke
/// <para>Handle to the item.</para>
/// <para><strong>Returns</strong></para>
/// <para>Returns zero.</para>
/// </summary>
/// <remarks>
/// Most applications do not use this message. Infotips are shown automatically. For more information, see Using Tree-view
/// Infotips in the About Tree-View Controls overview.
@ -1598,12 +1603,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_ASYNCDRAW pnmTVAsynchDraw = (NMTVASYNCDRAW *) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>Pointer to an <c>NMTVASYNCDRAW</c> structure. The <c>NMTVASYNCDRAW</c> structure contains the reason the draw failed.</para>
/// <para><strong>Returns</strong></para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>
/// <para>
/// The tree-view control must have the <c>TVS_EX_DRAWIMAGEASYNC</c> extended style. Note that this is equivalent to list-view's
@ -1650,7 +1655,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_BEGINDRAG pnmtv = (LPNMTREEVIEW) lParam</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1660,6 +1664,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
/// <remarks>A tree-view control that has the <c>TVS_DISABLEDRAGDROP</c> style does not send this notification code.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvn-begindrag
TVN_BEGINDRAG = TVN_FIRST - 56,
@ -1672,7 +1677,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_BEGINLABELEDIT ptvdi = (LPNMTVDISPINFO) lParam</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1681,6 +1685,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> to cancel label editing.</para>
/// </summary>
/// <remarks>
/// <para>
/// When label editing begins, an edit control is created but not positioned or displayed. Before it is displayed, the tree-view
@ -1704,7 +1709,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_BEGINRDRAG pnmtv = (LPNMTREEVIEW) lParam</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1714,6 +1718,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvn-beginrdrag
TVN_BEGINRDRAG = TVN_FIRST - 57,
@ -1725,7 +1730,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_DELETEITEM pnmtv = (LPNMTREEVIEW) lParam</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1734,6 +1738,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
/// <remarks>
/// If the <c>lParam</c> member of the <c>TVITEM</c> structure points to memory allocated by your application, you can free it
/// when you receive the TVN_DELETEITEM notification code.
@ -1749,7 +1754,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_ENDLABELEDIT ptvdi = (LPNMTVDISPINFO) lParam</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1763,6 +1767,7 @@ namespace Vanara.PInvoke
/// If the <c>pszText</c> member is non- <c>NULL</c>, return <c>TRUE</c> to set the item's label to the edited text. Return
/// <c>FALSE</c> to reject the edited text and revert to the original label.
/// </para>
/// </summary>
/// <remarks>
/// <para>If the <c>pszText</c> member is <c>NULL</c>, the return value is ignored.</para>
/// <para>
@ -1781,7 +1786,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_GETDISPINFO lptvdi = (LPNMTVDISPINFO) lParam</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1791,6 +1795,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
/// <remarks>
/// <para>This notification code is sent under the following circumstances:</para>
/// <list type="bullet">
@ -1829,12 +1834,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_GETINFOTIP lpGetInfoTip = (LPNMTVGETINFOTIP)lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>Pointer to an <c>NMTVGETINFOTIP</c> structure that contains information about this notification code.</para>
/// <para><strong>Returns</strong></para>
/// <para>The control ignores the return value for this notification code.</para>
/// </summary>
/// <remarks>This notification code is only sent by tree-view controls that have the <c>TVS_INFOTIP</c> style.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvn-getinfotip
TVN_GETINFOTIP = TVN_FIRST - 14,
@ -1847,7 +1852,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_ITEMCHANGED pnm = (NMTVITEMCHANGE *) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1855,6 +1859,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>FALSE</c> to accept the change, or <c>TRUE</c> to prevent the change.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvn-itemchanged
TVN_ITEMCHANGED = TVN_FIRST - 19,
@ -1866,7 +1871,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_ITEMCHANGING pnm = (NMTVITEMCHANGE *) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1874,6 +1878,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>FALSE</c> to accept the change, or <c>TRUE</c> to prevent the change.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvn-itemchanging
TVN_ITEMCHANGING = TVN_FIRST - 17,
@ -1885,7 +1890,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_ITEMEXPANDED pnmtv = (LPNMTREEVIEW) lParam</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1895,6 +1899,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvn-itemexpanded
TVN_ITEMEXPANDED = TVN_FIRST - 55,
@ -1906,7 +1911,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_ITEMEXPANDING pnmtv = (LPNMTREEVIEW) lParam</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1917,6 +1921,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> to prevent the list from expanding or collapsing.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvn-itemexpanding
TVN_ITEMEXPANDING = TVN_FIRST - 54,
@ -1928,7 +1933,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_KEYDOWN ptvkd = (LPNMTVKEYDOWN) lParam</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>Pointer to an <c>NMTVKEYDOWN</c> structure. The <c>wVKey</c> member specifies the virtual key code.</para>
@ -1938,6 +1942,7 @@ namespace Vanara.PInvoke
/// Return nonzero to exclude the character from the incremental search, or zero to include the character in the search. For all
/// other keys, the return value is ignored.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvn-keydown
TVN_KEYDOWN = TVN_FIRST - 12,
@ -1949,7 +1954,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_SELCHANGED pnmtv = (LPNMTREEVIEW) lParam</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -1980,6 +1984,7 @@ namespace Vanara.PInvoke
/// </list>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/tvn-selchanged
TVN_SELCHANGED = TVN_FIRST - 51,
@ -1991,7 +1996,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_SELCHANGING pnmtv = (LPNMTREEVIEW) lParam</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -2001,6 +2005,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Returns <c>TRUE</c> to prevent the selection from changing.</para>
/// </summary>
/// <remarks>
/// When responding to this notification code, applications should not delete the items that are gaining or losing the selection.
/// </remarks>
@ -2015,7 +2020,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_SETDISPINFO lptvdi = (LPNMTVDISPINFO) lParam</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -2025,6 +2029,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored.</para>
/// </summary>
/// <remarks>
/// <para>
/// If the <c>pszText</c> member of the item's <c>TVITEM</c> structure is the LPSTR_TEXTCALLBACK value, the control sends this
@ -2047,7 +2052,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>TVN_SINGLEEXPAND lpnmtv = (LPNMTREEVIEW)lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>Pointer to an <c>NMTREEVIEW</c> structure that contains information about this notification code.</para>
@ -2067,6 +2071,7 @@ namespace Vanara.PInvoke
/// <term>Skip default processing of the item being selected.</term>
/// </item>
/// </list>
/// </summary>
/// <remarks>
/// <para>
/// To skip default processing of selected and unselected items, return both TVNRET_SKIPOLD and TVNRET_SKIPNEW by combining them

52
PInvoke/ComCtl32/CommCtrl.UpDown.cs
View File

@ -20,7 +20,7 @@ namespace Vanara.PInvoke
/// <summary>Window messages for the up-down control.</summary>
public enum UpDownMessage : uint
{
/// <summary>Retrieves acceleration information for an up-down control.</summary>
/// <summary>Retrieves acceleration information for an up-down control.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -32,10 +32,11 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>The return value is the number of accelerators currently set for the control.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-getaccel
UDM_GETACCEL = WindowMessage.WM_USER + 108,
/// <summary>Retrieves the current radix base (that is, either base 10 or 16) for an up-down control.</summary>
/// <summary>Retrieves the current radix base (that is, either base 10 or 16) for an up-down control.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -47,10 +48,11 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>The return value is the current base value.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-getbase
UDM_GETBASE = WindowMessage.WM_USER + 110,
/// <summary>Retrieves the handle to the current buddy window.</summary>
/// <summary>Retrieves the handle to the current buddy window.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -62,10 +64,11 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>The return value is the handle to the current buddy window.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-getbuddy
UDM_GETBUDDY = WindowMessage.WM_USER + 106,
/// <summary>Returns the 32-bit position of an up-down control.</summary>
/// <summary>Returns the 32-bit position of an up-down control.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -78,11 +81,12 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>Returns the position of an up-down control with 32-bit precision. Applications must check the lParam value to determine whether the return value is valid.</para>
/// </summary>
/// <remarks>When it processes this message, the up-down control updates its current position based on the caption of the buddy window. It returns an error if there is no buddy window or if the caption specifies an invalid or out-of-range value.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-getpos32
UDM_GETPOS = WindowMessage.WM_USER + 104,
/// <summary>Returns the 32-bit position of an up-down control.</summary>
/// <summary>Returns the 32-bit position of an up-down control.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -95,11 +99,12 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>Returns the position of an up-down control with 32-bit precision. Applications must check the lParam value to determine whether the return value is valid.</para>
/// </summary>
/// <remarks>When it processes this message, the up-down control updates its current position based on the caption of the buddy window. It returns an error if there is no buddy window or if the caption specifies an invalid or out-of-range value.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-getpos32
UDM_GETPOS32 = WindowMessage.WM_USER + 114,
/// <summary>Retrieves the minimum and maximum positions (range) for an up-down control.</summary>
/// <summary>Retrieves the minimum and maximum positions (range) for an up-down control.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -111,10 +116,11 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>The return value is a 32-bit value that contains the minimum and maximum positions. The <c>LOWORD</c> is the maximum position for the control, and the <c>HIWORD</c> is the minimum position.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-getrange
UDM_GETRANGE = WindowMessage.WM_USER + 102,
/// <summary>Retrieves the 32-bit range of an up-down control.</summary>
/// <summary>Retrieves the 32-bit range of an up-down control.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -126,10 +132,11 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>The return value for this message is not used.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-getrange32
UDM_GETRANGE32 = WindowMessage.WM_USER + 112,
/// <summary>Retrieves the Unicode character format flag for the control.</summary>
/// <summary>Retrieves the Unicode character format flag for the control.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -141,11 +148,12 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>Returns the Unicode format flag for the control. If this value is nonzero, the control is using Unicode characters. If this value is zero, the control is using ANSI characters.</para>
/// </summary>
/// <remarks>See the remarks for <c>CCM_GETUNICODEFORMAT</c> for a discussion of this message.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-getunicodeformat
UDM_GETUNICODEFORMAT = CommonControlMessage.CCM_GETUNICODEFORMAT,
/// <summary>Sets the acceleration for an up-down control.</summary>
/// <summary>Sets the acceleration for an up-down control.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -157,10 +165,11 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>Returns <c>TRUE</c> if successful, or <c>FALSE</c> otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-setaccel
UDM_SETACCEL = WindowMessage.WM_USER + 107,
/// <summary>Sets the radix base for an up-down control. The base value determines whether the buddy window displays numbers in decimal or hexadecimal digits. Hexadecimal numbers are always unsigned, and decimal numbers are signed.</summary>
/// <summary>Sets the radix base for an up-down control. The base value determines whether the buddy window displays numbers in decimal or hexadecimal digits. Hexadecimal numbers are always unsigned, and decimal numbers are signed.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -172,10 +181,11 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>The return value is the previous base value. If an invalid base is given, the return value is zero.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-setbase
UDM_SETBASE = WindowMessage.WM_USER + 109,
/// <summary>Sets the buddy window for an up-down control.</summary>
/// <summary>Sets the buddy window for an up-down control.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -187,10 +197,11 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>The return value is the handle to the previous buddy window.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-setbuddy
UDM_SETBUDDY = WindowMessage.WM_USER + 105,
/// <summary>Sets the current position for an up-down control with 16-bit precision.</summary>
/// <summary>Sets the current position for an up-down control with 16-bit precision.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -202,11 +213,12 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>The return value is the previous position.</para>
/// </summary>
/// <remarks>This message only supports 16-bit positions. If 32-bit values have been enabled for an up-down control with <c>UDM_SETRANGE32</c>, use <c>UDM_SETPOS32</c>.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-setpos
UDM_SETPOS = WindowMessage.WM_USER + 103,
/// <summary>Sets the position of an up-down control with 32-bit precision.</summary>
/// <summary>Sets the position of an up-down control with 32-bit precision.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -218,10 +230,11 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>Returns the previous position.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-setpos32
UDM_SETPOS32 = WindowMessage.WM_USER + 113,
/// <summary>Sets the minimum and maximum positions (range) for an up-down control.</summary>
/// <summary>Sets the minimum and maximum positions (range) for an up-down control.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -233,11 +246,12 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>No return value.</para>
/// </summary>
/// <remarks>The maximum position can be less than the minimum position. Clicking the up arrow button moves the current position closer to the maximum position, and clicking the down arrow button moves toward the minimum position.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-setrange
UDM_SETRANGE = WindowMessage.WM_USER + 101,
/// <summary>Sets the 32-bit range of an up-down control.</summary>
/// <summary>Sets the 32-bit range of an up-down control.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -249,10 +263,11 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>The return value for this message is not used.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-setrange32
UDM_SETRANGE32 = WindowMessage.WM_USER + 111,
/// <summary>Sets the Unicode character format flag for the control. This message allows you to change the character set used by the control at run time rather than having to re-create the control.</summary>
/// <summary>Sets the Unicode character format flag for the control. This message allows you to change the character set used by the control at run time rather than having to re-create the control.
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -264,6 +279,7 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>Returns the previous Unicode format flag for the control.</para>
/// </summary>
/// <remarks>See the remarks for <c>CCM_SETUNICODEFORMAT</c> for a discussion of this message.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/udm-setunicodeformat
UDM_SETUNICODEFORMAT = CommonControlMessage.CCM_SETUNICODEFORMAT,
@ -275,7 +291,6 @@ namespace Vanara.PInvoke
/// <summary>
/// <para>Notifies a control's parent window that the control is releasing mouse capture. This notification code is sent in the form of a <c>WM_NOTIFY</c> message.</para>
/// <para><code>NM_RELEASEDCAPTURE lpnmh = (LPNMHDR) lParam; </code></para>
/// </summary>
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -285,13 +300,13 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>Unless otherwise specified, the control ignores the return value from this notification code.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-releasedcapture
NM_RELEASEDCAPTURE = UDN_FIRST - 1,
/// <summary>
/// <para>Sent by the operating system to the parent window of an up-down control when the position of the control is about to change. This happens when the user requests a change in the value by pressing the control's up or down arrow. This notification code is sent in the form of a <c>WM_NOTIFY</c> message.</para>
/// <para><code>UDN_DELTAPOS lpnmud = (LPNMUPDOWN) lParam; </code></para>
/// </summary>
/// <para>
/// <strong>Parameters</strong>
/// </para>
@ -301,6 +316,7 @@ namespace Vanara.PInvoke
/// <strong>Returns</strong>
/// </para>
/// <para>Return nonzero to prevent the change in the control's position, or zero to allow the change.</para>
/// </summary>
/// <remarks>The UDN_DELTAPOS notification code is sent before the <c>WM_VSCROLL</c> or <c>WM_HSCROLL</c> message, which actually changes the control's position. This lets you examine, allow, modify, or disallow the change.</remarks>
// https://docs.microsoft.com/en-us/windows/win32/controls/udn-deltapos
UDN_DELTAPOS = UDN_FIRST

42
PInvoke/ComCtl32/CommCtrl.cs
View File

@ -149,12 +149,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_OUTOFMEMORY lpnmh = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHDR</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored by the control.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-outofmemory
NM_OUTOFMEMORY = NM_FIRST - 1,
@ -166,7 +166,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_CLICK lpnmitem = (LPNMITEMACTIVATE) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -175,6 +174,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this notification is not used.</para>
/// </summary>
/// <remarks>
/// The <c>iItem</c> member of lParam is only valid if the icon or first-column label has been clicked. To determine which item
/// is selected when a click takes place elsewhere in a row, send an <c>LVM_SUBITEMHITTEST</c> message.
@ -190,7 +190,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_DBLCLK lpnmitem = (LPNMITEMACTIVATE) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -199,6 +198,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value for this notification is not used.</para>
/// </summary>
/// <remarks>
/// The <c>iItem</c> member of lParam is only valid if the icon or first-column label has been clicked. To determine which item
/// is selected when a click takes place elsewhere in a row, send an <c>LVM_SUBITEMHITTEST</c> message.
@ -214,12 +214,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_RETURN lpnmh = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHDR</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored by the control.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-return
NM_RETURN = NM_FIRST - 4,
@ -231,12 +231,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_RCLICK lpnmh = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>Pointer to an <c>NMHDR</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>Return nonzero to prevent the default processing, or zero to allow the default processing.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-rclick-tree-view
NM_RCLICK = NM_FIRST - 5,
@ -248,12 +248,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_RDBLCLK lpnmh = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>Pointer to an <c>NMHDR</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>Return nonzero to prevent the default processing, or zero to allow the default processing.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-rdblclk-tree-view
NM_RDBLCLK = NM_FIRST - 6,
@ -265,12 +265,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_SETFOCUS lpnmh = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHDR</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored by the control.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-setfocus
NM_SETFOCUS = NM_FIRST - 7,
@ -282,12 +282,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_KILLFOCUS lpnmh = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHDR</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored by the control.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-killfocus
NM_KILLFOCUS = NM_FIRST - 8,
@ -299,7 +299,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_CUSTOMDRAW #ifdef LIST_VIEW_CUSTOM_DRAW lpNMCustomDraw = (LPNMLVCUSTOMDRAW) lParam; #elif TOOL_TIPS_CUSTOM_DRAW lpNMCustomDraw = (LPNMTTCUSTOMDRAW) lParam; #elif TREE_VIEW_CUSTOM_DRAW lpNMCustomDraw = (LPNMTVCUSTOMDRAW) lParam; #elif TOOL_BAR_CUSTOM_DRAW lpNMCustomDraw = (LPNMTBCUSTOMDRAW) lParam; #else lpNMCustomDraw = (LPNMCUSTOMDRAW) lParam; #endif</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -397,6 +396,7 @@ namespace Vanara.PInvoke
/// <term>The control will not draw the focus rectangle around an item.</term>
/// </item>
/// </list>
/// </summary>
/// <remarks>
/// <para>
/// Currently, the following controls support custom draw functionality: header, list view, rebar, toolbar, tooltip, trackbar,
@ -418,7 +418,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_HOVER lpnmh = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHDR</c> structure that contains additional information about this notification.</para>
@ -427,6 +426,7 @@ namespace Vanara.PInvoke
/// Unless otherwise specified, return zero to allow the control to process the hover normally, or nonzero to prevent the hover
/// from being processed.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-hover
NM_HOVER = NM_FIRST - 13,
@ -438,7 +438,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_NCHITTEST lpnmmouse = (LPNMMOUSE) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -450,6 +449,7 @@ namespace Vanara.PInvoke
/// Unless otherwise specified, return zero to allow the control to perform default processing of the hit test message, or return
/// one of the HT* values documented under <c>WM_NCHITTEST</c> to override the default hit test processing.
/// </para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-nchittest
NM_NCHITTEST = NM_FIRST - 14,
@ -461,7 +461,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_KEYDOWN lpnmk = (LPNMKEY) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -469,6 +468,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>Return nonzero to prevent the control from processing the key, or zero otherwise.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-keydown
NM_KEYDOWN = NM_FIRST - 15,
@ -480,12 +480,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_RELEASEDCAPTURE lpnmh = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHDR</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>Unless otherwise specified, the control ignores the return value from this notification code.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-releasedcapture
NM_RELEASEDCAPTURE = NM_FIRST - 16,
@ -497,12 +497,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_SETCURSOR lpnmm = (LPNMMOUSE) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMMOUSE</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>Return zero to enable the control to set the cursor or nonzero to prevent the control from setting the cursor.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-setcursor
NM_SETCURSOR = NM_FIRST - 17,
@ -514,7 +514,6 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_CHAR lpnmc = (LPNMCHAR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>
@ -522,6 +521,7 @@ namespace Vanara.PInvoke
/// </para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored by most controls. For more information, see the documentation for the individual controls.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-char
NM_CHAR = NM_FIRST - 18,
@ -533,12 +533,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_TOOLTIPSCREATED lpnmttc = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMTOOLTIPSCREATED</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>Unless otherwise specified, the control ignores the return value from this notification code.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-tooltipscreated
NM_TOOLTIPSCREATED = NM_FIRST - 19,
@ -550,12 +550,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_LDOWN lpnmhdr = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHDR</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored by the control.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-ldown
NM_LDOWN = NM_FIRST - 20,
@ -570,12 +570,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_THEMECHANGED lpnmhdr = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHDR</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored by the control.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-themechanged
NM_THEMECHANGED = NM_FIRST - 22,
@ -587,12 +587,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_FONTCHANGED lpnmh = (LPNMHDR) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMHDR</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored by the control.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-fontchanged
NM_FONTCHANGED = NM_FIRST - 23,
@ -604,12 +604,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_CUSTOMTEXT lpnmct = (NMCUSTOMTEXT) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMCUSTOMTEXT</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored by the control.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-customtext
NM_CUSTOMTEXT = NM_FIRST - 24,
@ -621,12 +621,12 @@ namespace Vanara.PInvoke
/// <para>
/// <code>NM_TVSTATEIMAGECHANGING lpnmtsic = (LPNMTVSTATEIMAGECHANGING) lParam;</code>
/// </para>
/// </summary>
/// <para><strong>Parameters</strong></para>
/// <para><em>lParam</em></para>
/// <para>A pointer to an <c>NMTVSTATEIMAGECHANGING</c> structure that contains additional information about this notification.</para>
/// <para><strong>Returns</strong></para>
/// <para>The return value is ignored by the control.</para>
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/controls/nm-tvstateimagechanging
NM_TVSTATEIMAGECHANGING = NM_FIRST - 24,
}