Edit

Share via

IMathInputControl::SetPosition method (micaut.h)

  • Article

Modifies the location and size of the control.

Syntax

HRESULT SetPosition(
  [in] LONG Left,
  [in] LONG Top,
  [in] LONG Right,
  [in] LONG Bottom
);

Parameters

[in] Left

The leftmost position of the control.

[in] Top

The highest position of the control.

[in] Right

The rightmost position of the control.

[in] Bottom

The lowest position of the control.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
 The method succeeded.
S_FALSE
 The control was resized but the resulting width, height, or both are not equal to the input parameters.
E_FAIL
 An unspecified error occurred.

Remarks

This method can be called regardless of the control visibility state.

This method will succeed even if parameters are not valid. If the rectangle is larger than the maximum allowed size of the control (desktop window), the maximum possible size is used instead. If the rectangle is smaller than the minimal size of the control, or too small to keep the ink and result preview intact, the minimal possible size is used instead.

If the method returns S_FALSE, the GetPosition method will return the actual size characteristics of the control.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header micaut.h (include Micaut.h)

See also

GetPosition

IMathInputControl