VLPropertyList Reference

MethodSetEditorParam

See Also See Also Applies To Applies To

Stores editor specific parameters for a CProperty.

 

Syntax

object.SetEditorParam(ByVal sParam As String, ByVal sValue As String)

 

The SetEditorParam method syntax has these parts:

PartDescription
object An object expression that evaluates to an object of CProperty type.
sParam A unique string identifying an editor specific parameter. For parameters supported by various internal editor see Editor parameter table
sValue A String expression specifying the value corresponding to the specified parameter (see remarks).

 

Remark

Typically an editor will read these parameters from the CProperty object when its Reset method is called.

If you want an editor specific parameter to be applied to all properties using a particular editor type, you should set the editor parameter at control level using SetEditorParam method of VLPropertyList control.

This mechanism can also be used for storing parameters for custom editor. It is the responsibility of the editor author to read the appropriate param value from the property and assume appropriate default value when parameter is not specified.

An editor parameter can be reset using RemoveEditorParam method