IPXV_Inst::SetupMeasureEditFilter Method

Revision as of 07:33, 12 June 2015

Initializes the IUIX_NumEditFilter object by specified options for measurement. After that this object can be used by edit-control (by IUIX_Edit::Filter) to support the converting on-the-fly of the entered values between different units of measurement.

Syntax

HRESULT SetupMeasureEditFilter([in]                     IUIX_NumEditFilter*  EditFilter,
                               [in]                     MeasureUnit          CurUnit,
                               [in]                     double               Min,
                               [in]                     double               Max,
                               [in, defaultvalue(1.0)]  double               AdvDispCoef,
                               [in, defaultvalue(0.0)]  double               Step,
                               [in, defaultvalue(0)]    VARIANT_BOOL         Negative);

Parameters

EditFilter

[in] Pointer to IUIX_NumEditFilter that will be initialized.

CurUnit

[in] The value of MeasureUnit enumeration that indicates the currently selected unit.

Min

[in] The minimum value in points (1/72 in).

Max

[in] The maximum value in points (1/72 in).

AdvDispCoef

[in, defaultvalue(1.0)] The advanced coefficient for displaying the values.

Step

[in, defaultvalue(0.0)] The step-value for auto- increasing/decreasing of value by end-user in edit-control, for example, by mouse-wheel events, or by Up/Down buttons inside contol.

Negative

[in, defaultvalue(0)] The flag that may allow the negative values entering by user, is related to value of Min option.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXV_Inst