HOWTO: Update Property Values in a Property Page

Last reviewed: February 17, 1998
Article ID: Q148222
The information in this article applies to:
  • The Microsoft Foundation Classes (MFC) included with:

        - Microsoft Visual C++, 32-bit Edition, version 4.0. 5.0
        - Microsoft OLE Control Developer's Kit (CDK) versions 2.0, 2.1, 2.2
    
    -----------------------------------------------------------------------

SUMMARY

To modify a property of an OLE control, you would normally change the properties value in the control's property page. However, it is possible for a property to be modifiable from more than one property page especially in development environments such as Visual Basic. In this case, when you change the property in the control's property page, you should synchronize the value in Visual Basic's Property Form. This article shows by example how to do it.

MORE INFORMATION

For example, in Visual Basic, place the Circ3 sample control on the Form page. Then click the right mouse button to select properties for the control. You will notice that the same properties can be seen in Visual Basic's Properties window. For example, one of the properties of Circ3 is the CircleOffset property. If you change this value in the Control's property page and click Apply, you will notice that the value has not been updated in Visual Basic's Properties window. To synchronize the value in both, you need to call BoundPropertyChanged(dispid) for each property you want to update.

Note that the dispid is the id of the property to update. It is usually found in the header file of the COleControl-derived class. The dispids for the Circ3 control follow:

// Dispatch and event IDs
public:
       enum {
       //{{AFX_DISP_ID(CCirc3Ctrl)
       dispidCircleShape = 2L,
       dispidCircleOffset = 3L,
       dispidFlashColor = 1L,
       dispidNote = 4L,
       eventidClickIn = 1L,
       eventidClickOut = 2L,
       //}}AFX_DISP_ID
       };

The following sample code shows how to modify the Circ3 sample to synchronize the CircleShape and CircleOffset properties given the dispids above.

Sample Code

/* Compile options needed: none
*/

void CCirc3Ctrl::OnCircleShapeChanged()
{
   SetModifiedFlag();

   // force the control to redraw itself
   InvalidateControl();

   // reset the circle offset, if necessary
   if (m_circleShape)
      SetCircleOffset(0);

   BoundPropertyChanged(dispidCircleShape);      // *ADD THIS LINE*
}

void CCirc3Ctrl::SetCircleOffset(short nNewValue)
{
   // Validate the specified offset value
   if ((m_circleOffset != nNewValue) && m_circleShape&&
       InBounds(nNewValue))
   {
      m_circleOffset = nNewValue;
      SetModifiedFlag();
      BoundPropertyChanged(dispidCircleOffset); // *ADD THIS LINE*
      InvalidateControl();
   }
}


Additional query words: Property Page Form Browser
Keywords : CDKIss MfcOLE
Technology : kbole kbMfc
Version : Winnet:2.0,2.1,2.2,4.0,5.0
Platform : NT WINDOWS
Issue type : kbhowto


THE INFORMATION PROVIDED IN THE MICROSOFT KNOWLEDGE BASE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. MICROSOFT DISCLAIMS ALL WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING THE WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL MICROSOFT CORPORATION OR ITS SUPPLIERS BE LIABLE FOR ANY DAMAGES WHATSOEVER INCLUDING DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, LOSS OF BUSINESS PROFITS OR SPECIAL DAMAGES, EVEN IF MICROSOFT CORPORATION OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES SO THE FOREGOING LIMITATION MAY NOT APPLY.

Last reviewed: February 17, 1998
© 1998 Microsoft Corporation. All rights reserved. Terms of Use.