InkCollector.MarginX Property

Article
10/19/2012

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

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)

Syntax

'Declaration
Public Property MarginX As Integer
'Usage
Dim instance As InkCollector 
Dim value As Integer 

value = instance.MarginX

instance.MarginX = value

public int MarginX { get; set; }

public:
property int MarginX {
    int get ();
    void set (int value);
}

public function get MarginX () : int 
public function set MarginX (value : int)

Property Value

Type: System.Int32
The margins along the x-axis, in pixels.

Value	Meaning
DefaultMargin property	The DefaultMargin field of the InkCollector control.
Int32	The application-defined margins along the x-axis.

Remarks

This margin provides a buffer around the edge of the ink window. The DefaultMargin field specifies the default margin that the MarginX 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 InkCollector 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 InkCollector object must be disabled before setting this property. To disable ink collection on the InkCollector object, set the Enabled property to false. You can then set the MarginX property, and re-enable ink collection on the control by setting the Enabled property to true. Alternatively, use SetWindowInputRectangle to change the input area while the InkCollector is enabled.

Examples

The following example sets the x-axis margin of a window rectangle for an InkCollector to five pixels.

mInkCollector.Enabled = False
mInkCollector.MarginX = 5
mInkCollector.Enabled = True

mInkCollector.Enabled = false;
mInkCollector.MarginX = 5;
mInkCollector.Enabled = true;

Platforms

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.0

Share via