InkOverlay.SetWindowInputRectangle Method

InkOverlay.SetWindowInputRectangle Method

Sets the window rectangle, in pixels, within which ink is drawn.

Definition

Visual Basic .NET	Public Sub SetWindowInputRectangle( _ ByVal windowInputRectangle As Rectangle _ )
C#	public void SetWindowInputRectangle( Rectangle windowInputRectangle );
Managed C++	public: void SetWindowInputRectangle( Rectangle *windowInputRectangle );

Parameters

windowInputRectangle

System.Drawing.Rectangle. input rectangle in window coordinates

Exceptions

COMException :
InvalidOperationException : Cannot update the window input rectangle while collecting ink CollectingInk
ObjectDisposedException :

Remarks

By default, the window input rectangle is set to {0,0,0,0}. This default rectangle maps to the size of the entire window.

To reset the window input rectangle to an empty rectangle with the default coordinates, pass {0,0,0,0} in the call to the SetWindowInputRectangle method, rather than null (Nothing in Microsoft® Visual Basic® .NET).

You cannot pass in a rectangle where the value of the Right property is less than the value of the Left property; or where the value of the Bottom property is less than the value of the Top property. For example, a rectangle with parameters of {500, 500, 400, 400} is not valid.

A rectangle in negative coordinate space can be specified but is meaningless, because it always results in a window that cannot be inked upon.

Caution: If you set the window input rectangle to overlap a Splitter control or the borders of the window, unpredictable results may occur when the window is resized.

Examples

[C#]

This C# example calls the SetWindowInputRectangle method to set the ink input area to the size of the entire window of the InkOverlay object, theInkOverlay, to which it is attached.

using Microsoft.Ink;
//...
InkOverlay theInkCollector;
public Form1()
{
    // Initialization
    theInkCollector = new InkOverlay(Handle);
    Rectangle theRect = new Rectangle(0,0,0,0);
    theInkOverlay.SetWindowInputRectangle(theRect);
    //...
}
                

[VB.NET]

This Visual Basic .NET example calls the SetWindowInputRectangle method to set the ink input area to the size of the entire window of the InkOverlay object, theInkOverlay, to which it is attached.

Imports Microsoft.Ink
Dim theInkOverlay As InkOverlay
Public Sub Form1()
    'Initialization
    Dim theRect As Rectangle
    theInkOverlay = New InkOverlay(Handle)
    theRect = New Rectangle(0,0,0,0)
    theInkOverlay.SetWindowInputRectangle(theRect)
    '...
End Sub
                

See Also

• InkOverlay.GetWindowInputRectangle Method