InkOverlay.Handle Property

Article
10/19/2012

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

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

Syntax

'Declaration
<BrowsableAttribute(False)> _
Public Property Handle As IntPtr
'Usage
Dim instance As InkOverlay 
Dim value As IntPtr 

value = instance.Handle

instance.Handle = value

[BrowsableAttribute(false)]
public IntPtr Handle { get; set; }

[BrowsableAttribute(false)]
public:
property IntPtr Handle {
    IntPtr get ();
    void set (IntPtr value);
}

public function get Handle () : IntPtr 
public function set Handle (value : IntPtr)

Property Value

Type: System.IntPtr
The handle of the window to which the InkOverlay object is attached.

Value	Meaning
nulla null reference (Nothing in Visual Basic)	The InkOverlay object is not attached to a window (if AttachedControl is also nulla null reference (Nothing in Visual Basic)).
System.Windows.Forms.Control.Handle	The handle of the window to which the InkOverlay object is attached.

Remarks

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

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

Note

The InkOverlay must be disabled before setting this property. To disable the InkOverlay, 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.UnmanagedCode permission in addition to the permissions required by InkOverlay. See Security And Trust for more information.

Examples

The following example shows a method that can be used to direct either an InkCollector object, or an InkOverlay object to collect ink on a new control.

Private Sub SwitchInkObjectHandle(ByVal collectingControl As Control)
    ' mInkObject can be InkCollector or InkOverlay
    mInkObject.Enabled = False 
    ' setting the Handle property sets the AttachedControl property to null
    mInkObject.Handle = collectingControl.Handle
    mInkObject.Enabled = True 
End Sub

private void SwitchInkObjectHandle(Control collectingControl)
{
    // mInkObject can be InkCollector or InkOverlay
    mInkObject.Enabled = false;
    // setting the Handle property sets the AttachedControl property to null
    mInkObject.Handle = collectingControl.Handle;
    mInkObject.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