Developer

API Reference

IForm_SetProperty()

Brew Release
Brew MP 1.0.2
See Also
IForm IForm_GetProperty() Widget Events
Description
This function sets the value of a specific property for the given form. Forms may possess any number of form properties, as defined in AEEIForm.h, and may additionally support widget properties defined in AEEWidgetProperties.h. Form properties include visual characteristics of the form such as the current activation state, theme, and background image.
Parameters
  • pif
    []:
    [in] Pointer to the IForm interface object.
  • propId
    []:
    [in] Identifies the property whose value is to be set.
  • val
    []:
    [in] The new value for the widget's or form's 'propId' property, expressed as a 32-bit unsigned integer.
Interface
Prototype
   int IForm_SetProperty(IForm *pif, uint16 propId, uint32 val); 
Return
AEE_SUCCESS : If the form is able to set the requested property. AEE_EFAILED : If the property could not be set.
Side Effect
None
Comment
Calling IForm_SetProperty() has the same effect as processing an EVT_WDG_SETPROPERTY event.
Not all properties set a stored value in the specified form. Several form properties (FID_TEXT, FID_PROGRESS, etc) are used as triggers to invoke a specific form behavior and do NOT store any retrievable value in the indicated property.
  • Follow