InkCollector.Handle Property

Article
12/12/2007

Gets or sets the handle of the window to which the InkCollector object is attached.

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

Syntax

'Declaration
Public Property Handle As IntPtr
'Usage
Dim instance As InkCollector
Dim value As IntPtr

value = instance.Handle

instance.Handle = value

public IntPtr Handle { get; set; }

public:
property IntPtr Handle {
    IntPtr get ();
    void set (IntPtr value);
}

/** @property */
public IntPtr get_Handle ()

/** @property */
public void set_Handle (IntPtr value)

public function get Handle () : IntPtr

public function set Handle (value : IntPtr)

Not applicable.

Property Value

The handle of the window to which the InkCollector object is attached.

Value	Meaning
a null reference (Nothing in Visual Basic)	The InkCollector object is not attached to a window.
System.Windows.Forms.Control	The handle of the window to which the InkCollector object is attached.

Remarks

The AttachedControl or Handle property must be set before the InkCollector object can be enabled.

If the InkCollector object is attached to a control, setting this property attaches the InkCollector object to a window and clears the AttachedControl property.

Note

The InkCollector must be disabled before setting this property. To disable the InkCollector, set the Enabled property to false. You can then set this property and re-enable the object by setting the Enabled property to true.

If you use the AttachedControl property and the Handle property in your application, you will get a security exception when you run the application in the Internet zone. This is because the Handle property is not valid in the partial trust environment of the Internet zone, so the Tablet PC operating system reverts to the AttachedControl property.

Security Note:
If using under partial trust, this property requires SecurityPermissionFlag.UnmanagedCodeSecurityPermissionFlag.UnmanagedCode permission in addition to the permissions required by InkCollector. See Security And Trust for more information.

Example

This C# example is a method that redirects an InkCollector, theInkCollector, to collect ink on a new control.

private void SwitchCollector(Control collectingControl)
{
     theInkCollector.Enabled = false;
     theInkCollector.Handle = collectingControl.Handle;
     theInkCollector.Enabled = true;
}

This Microsoft Visual Basic .NET example is a subroutine that redirects an InkCollector, theInkCollector, to collect ink on a new control.

Private Sub SwitchCollector(ByVal collectingControl As Control)
    theInkCollector.Enabled = False
    theInkCollector.Handle = collectingControl.Handle
    theInkCollector.Enabled = True
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

Share via