Export (0) Print
Expand All
Expand Minimize

InkOverlay.MarginY property

Applies to: desktop apps only

Gets or sets the y-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 put_MarginY(
  [in]           long MarginY
);

HRESULT get_MarginY(
  [out, retval]  long *MarginY
);

Property value

The y-axis margin around the window rectangle, in screen coordinates.

Error codes

NameMeaning
S_OK

Success.

E_POINTER

The MarginY parameter is an invalid pointer.

E_INK_COLLECTOR_ENABLED

Cannot change modes while the collector is enabled.

E_INK_EXCEPTION

An exception occurred while processing.

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 MarginY property, and re-enable the object or control by setting the Enabled property (or InkEnabled property) to TRUE.

Requirements

Minimum supported client

Windows XP Tablet PC Edition

Minimum supported server

None supported

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

InkOverlay Class
Enabled Property
InkEnabled Property
MarginX Property

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Community Additions

ADD
Show:
© 2014 Microsoft