Edit

Share via

IInkOverlay::get_MarginX method (msinkaut.h)

  • Article

Gets or sets the x-axis margin around the window rectangle, in screen coordinates.

This margin provides a buffer around the edge of the ink window.

This property is read/write.

Syntax

HRESULT get_MarginX(
  long *MarginX
);

Parameters

MarginX

Return value

None

Remarks

This property is most commonly used with nonintegrated tablet devices?the buffer gives users a margin of error when writing on a device that may not map 1 to 1 with the screen.

The margin is specified in screen coordinates. A positive margin extends outside the context, a negative margin extends inside the context, and a value of zero produces no margin. Ink is collected if the stroke starts within the margin. This behavior does not clip the ink. The context of the object or control is either the window input rectangle from the GetWindowInputRectangle method or the client rectangle for the window.

The margin is effective only within the application's window. If the pen is applied outside the application's window, then the application loses focus and cannot collect ink.

Note  The InkCollector object, the InkOverlay object, or the InkPicture control must be disabled before setting this property. To disable the InkCollector or InkOverlay object, set the Enabled property to FALSE. To disable inking in the InkOverlay control, set the InkEnabled property to FALSE. You can then set the MarginX property, and re-enable the object or control by setting the Enabled property (or InkEnabled property) to TRUE.
 

Requirements

Requirement Value
Minimum supported client Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header msinkaut.h
Library InkObj.dll

See also

Enabled Property

IInkOverlay

InkEnabled Property

InkOverlay Class

MarginY Property