InkOverlay.SetWindowInputRectangle Method

Artikel
12/12/2007

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

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

Syntax

'Declaration
Public Sub SetWindowInputRectangle ( _
    windowInputRectangle As Rectangle _
)
'Usage
Dim instance As InkOverlay
Dim windowInputRectangle As Rectangle

instance.SetWindowInputRectangle(windowInputRectangle)

public void SetWindowInputRectangle (
    Rectangle windowInputRectangle
)

public:
void SetWindowInputRectangle (
    Rectangle windowInputRectangle
)

public void SetWindowInputRectangle (
    Rectangle windowInputRectangle
)

public function SetWindowInputRectangle (
    windowInputRectangle : Rectangle
)

Not applicable.

Parameters

windowInputRectangle
The rectangle for input.

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 a null reference (Nothing in Visual Basic) (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.

Warning

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.

Example

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);
    //...
}

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

Platforms

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0

Freigeben über