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

SetEditorParam method at control level provides a mechanism to globally set attributes of the value editors across properties. As against this, if the parameter value is set through SetEditorParam method of a CProperty object, the parameter setting will apply to the corresponding value editor only while editing that property.

An internal value editor will read these parameters when its Reset method is called.

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