Share via

InkOverlay.MarginY Property

  • Article

InkOverlay.MarginY Property

Gets or sets the margins along the y-axis, in pixels.

Definition

Visual Basic .NET Public Property MarginY As Integer
C# public int MarginY { get; set; }
Managed C++ public: __property int* get_MarginY();
public: __property void set_MarginY(int*);

Property Value

System.Int32. The margins along the y-axis, in pixels.

This property is read/write.

DefaultMargin property Default. The DefaultMargin field of the InkOverlay control.
Int32 The application-defined margins along the y-axis.

Exceptions

COMException Leave Site:
InvalidOperationException Leave Site: Margins cannot be changed while the InkCollector is enabled
ObjectDisposedException Leave Site:

Remarks

This margin provides a buffer around the edge of the ink window. The DefaultMargin field specifies the default margin that the MarginY property uses.

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 directly to the size of the display screen.

A positive margin extends outside the bounds of the InkOverlay object, a negative margin extends inside the bounds of the control, 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 bounds of the control are either the GetWindowInputRectangle property 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: Ink collection on the InkOverlay object must be disabled before setting this property. To disable ink collection on the InkOverlay object, set the Enabled property to false. You can then set the MarginY property, and re-enable ink collection on the control by setting the Enabled property to true.

Examples

[C#]

This C# example sets the y-axis margin of a window rectangle for an InkOverlay, theInkoverlay, to 5 pixels.

theInkOverlay.MarginY = 5;

[VB.NET]

This Microsoft® Visual Basic® .NET example sets the y-axis margin of a window rectangle for an InkOverlay, theInkoverlay, to 5 pixels.

theInkOverlay.MarginY = 5

See Also