Technical Reference > Graphics Builder Automation Interface > Object Drawing and Property Functions > AttributeGradientOnColour


Sets or retrieves the "On" portion of the gradient color on the General | Appearance tab of the Object Properties dialog for the current object.

This function is only supported on rectangle objects.




On portion of the gradient color.

Return Value

If retrieving the gradient color, an RGB encoded color. If applying a gradient color, 0 (zero) if successful. In both cases, an error is returned if unsuccessful. If values are out of range on writing to the attribute, the function will exit and report the error E_INVALIDARG. If there is no active object, they will exit and report a return value of E_HANDLE.