Share via


COleControl::OnGetPredefinedStrings

Called by the framework to obtain a set of predefined strings representing the possible values for a property.

virtual BOOL OnGetPredefinedStrings(
   DISPID dispid,
   CStringArray* pStringArray,
   CDWordArray* pCookieArray 
);

Parameters

  • dispid
    The dispatch ID of a property of the control.

  • pStringArray
    A string array to be filled in with return values.

  • pCookieArray
    A DWORD array to be filled in with return values.

Return Value

Nonzero if elements have been added to pStringArray and pCookieArray.

Remarks

Override this function if your control has a property with a set of possible values that can be represented by strings. For each element added to pStringArray, you should add a corresponding "cookie" element to pCookieArray. These "cookie" values may later be passed by the framework to the COleControl::OnGetPredefinedValue function.

Requirements

Header: afxctl.h

See Also

Reference

COleControl Class

Hierarchy Chart

COleControl::OnGetPredefinedValue

COleControl::OnGetDisplayString

Other Resources

COleControl Members