IPXV_Inst::SetupMeasureEditFilter Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
(8 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_Inst::SetupMeasureEditFilter Method}} | {{#customTitle:IPXV_Inst::SetupMeasureEditFilter Method}} | ||
+ | {{#parentPage:PXV:IPXV_Inst#Methods|SetupMeasureEditFilter|method}} | ||
+ | {{ToReview}} | ||
− | + | Initializes the [[PXV:IUIX_NumEditFilter|IUIX_NumEditFilter]] object by specified options for measurement. After that this object can be used by edit-control (by [[PXV:IUIX_Edit_Filter|IUIX_Edit::Filter]]) to support the converting on-the-fly of the entered values between different units of measurement. | |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT SetupMeasureEditFilter([in] IUIX_NumEditFilter* pEditFilter, [in] MeasureUnit nCurUnit, [in] double nMin, [in] double nMax, [in, defaultvalue(1.0)] double nAdvDispCoef, [in, defaultvalue(0.0)] double nStep, [in, defaultvalue(0)] VARIANT_BOOL bNegative);</pre> | + | <pre class="brush:cpp;gutter:false">HRESULT SetupMeasureEditFilter([in] IUIX_NumEditFilter* pEditFilter, |
+ | [in] MeasureUnit nCurUnit, | ||
+ | [in] double nMin, | ||
+ | [in] double nMax, | ||
+ | [in, defaultvalue(1.0)] double nAdvDispCoef, | ||
+ | [in, defaultvalue(0.0)] double nStep, | ||
+ | [in, defaultvalue(0)] VARIANT_BOOL bNegative);</pre> | ||
== Parameters == | == Parameters == | ||
− | ; | + | ;pEditFilter |
− | :[in] Pointer to [[PXV:IUIX_NumEditFilter|IUIX_NumEditFilter]]. | + | :[in] Pointer to [[PXV:IUIX_NumEditFilter|IUIX_NumEditFilter]] that will be initialized. |
− | ; | + | ;nCurUnit |
− | :[in] | + | :[in] The value of [[PXV:MeasureUnit|MeasureUnit]] enumeration that indicates the currently selected unit. |
− | ; | + | ;nMin |
− | :[in] | + | :[in] The minimum value in points (1/72 in). |
− | ; | + | ;nMax |
− | :[in] | + | :[in] The maximum value in points (1/72 in). |
− | ; | + | ;nAdvDispCoef |
− | :[in, defaultvalue(1.0)] | + | :[in, defaultvalue(1.0)] The advanced coefficient for displaying the values. |
− | ; | + | ;nStep |
− | :[in, defaultvalue(0.0)] | + | :[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. |
− | ; | + | ;bNegative |
− | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] The flag that may allow the negative values entering by user, is related to value of <tt>nMin</tt> option. |
== Return Value == | == Return Value == | ||
Line 27: | Line 36: | ||
== See Also == | == See Also == | ||
− | + | [[PXV:IPXV_Inst|IPXV_Inst]] |
Latest revision as of 03:57, 15 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* pEditFilter, [in] MeasureUnit nCurUnit, [in] double nMin, [in] double nMax, [in, defaultvalue(1.0)] double nAdvDispCoef, [in, defaultvalue(0.0)] double nStep, [in, defaultvalue(0)] VARIANT_BOOL bNegative);
Parameters
- pEditFilter
- [in] Pointer to IUIX_NumEditFilter that will be initialized.
- nCurUnit
- [in] The value of MeasureUnit enumeration that indicates the currently selected unit.
- nMin
- [in] The minimum value in points (1/72 in).
- nMax
- [in] The maximum value in points (1/72 in).
- nAdvDispCoef
- [in, defaultvalue(1.0)] The advanced coefficient for displaying the values.
- nStep
- [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.
- bNegative
- [in, defaultvalue(0)] The flag that may allow the negative values entering by user, is related to value of nMin option.
Return Value
Returns S_OK if operation was successful or error code in other cases.