Codejock Developer Community : OnReportColumnOrderChanged documentation error!

OnReportColumnOrderChanged documentation error! : Right - it was somebody old comment...

Thu, 16 Jul 2009 17:14:42 +0000

Author: mdoubson
Subject: 14756
Posted: 16 July 2009 at 5:14pm

Right - it was somebody old comment formaly good to make Doc-O-Matic happy. Thanks for your catch - I will change source comment right now:

//-----------------------------------------------------------------------

// Summary:

// Defines message for column changed event.

// Parameters:

// id - Resource ID for the control.

// memberFxn - Name of member function to handle the message.

// Remarks:

// The XTP_NM_REPORT_COLUMNORDERCHANGED notification message is sent to inform

// the owner window that the user change the order of columns of report control.

// The owner window of the report control receives this notification

// threw the WM_COMMAND message.

// Example:

// Here is an example of how an application would handle this message.

// BEGIN_MESSAGE_MAP(CReportSampleView, CXTPReportView)

// ON_NOTIFY(XTP_NM_REPORT_COLUMNORDERCHANGED, XTP_ID_REPORT_CONTROL, OnReportColumnOrderChanged)

// END_MESSAGE_MAP()

//

// void CReportSampleView::OnReportColumnOrderChanged(NMHDR* pNotifyStruct, LRESULT* /*result*/)

// {

// XTP_NM_REPORTCOLUMNORDERCHANGED* pItemNotify = (XTP_NM_REPORTCOLUMNORDERCHANGED*) pNotifyStruct;

// ASSERT(pItemNotify != NULL);

//

// // TODO: Handle command.

// }

//

OnReportColumnOrderChanged documentation error! : But in source it's documented...

Thu, 16 Jul 2009 17:06:47 +0000

Author: mgampi
Subject: 14756
Posted: 16 July 2009 at 5:06pm

But in source it's documented in the same wrong way and I don't have the time to study tons of foreign source code. So I first consult documentation.

OnReportColumnOrderChanged documentation error! : Sure - this is why good to have...

Thu, 16 Jul 2009 15:47:17 +0000

Author: mdoubson
Subject: 14756
Posted: 16 July 2009 at 3:47pm

Sure - this is why good to have fresh source!

OnReportColumnOrderChanged documentation error! : BEGIN_MESSAGE_MAP(CReportSampleView,...

Thu, 16 Jul 2009 08:26:09 +0000

Author: mgampi
Subject: 14756
Posted: 16 July 2009 at 8:26am

BEGIN_MESSAGE_MAP(CReportSampleView, CXTPReportView)
    ON_NOTIFY(XTP_NM_REPORT_COLUMNORDERCHANGED, XTP_ID_REPORT_CONTROL, OnReportColumnOrderChanged)
END_MESSAGE_MAP()

void CReportSampleView::OnReportColumnOrderChanged(NMHDR*  pNotifyStruct, LRESULT* /*result*/)
{
    XTP_NM_REPORTRECORDITEM* pItemNotify = (XTP_NM_REPORTRECORDITEM*) pNotifyStruct;
    ASSERT(pItemNotify != NULL);

    // TODO: Handle command.
}

should be changed to :

XTP_NM_REPORTCOLUMNORDERCHANGED