InkOverlay.Ink Property

Article
10/19/2012

Gets or sets the Ink object that is associated with the InkOverlay object.

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

Syntax

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

value = instance.Ink

instance.Ink = value

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

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

public function get Ink () : Ink 
public function set Ink (value : Ink)

Property Value

Type: Microsoft.Ink.Ink
The Ink object that is associated with the InkOverlay object.

Remarks

Note

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

An InkOverlay object creates an Ink object by default. If two or more Ink objects exist on a known application window, they can be switched out to enable collection into any one of them (such as after deserializing one of the Ink objects).

Examples

In this example, an InkOverlay object works with multiple virtual pages by maintaining multiple Ink objects.

Before pages can be switched, an array of Ink objects is initialized.

mInkArrayOverlay = New Ink(MAX_PAGE - 1) {}
For k As Integer = 0 To MAX_PAGE - 1
    mInkArrayOverlay(k) = New Ink()
Next

mInkArrayOverlay = new Ink[MAX_PAGE];
for (int k = 0; k < MAX_PAGE; k++)
{
    mInkArrayOverlay[k] = new Ink();
}

Then, in response to a user action (such as picking from a menu or list), the Ink object of the InkOverlay object is reassigned, and the control to which the InkOverlay object is attached is redrawn.

Private Sub ChangeInkOverlayPage(ByVal PageNum As Integer)
    mInkOverlay.Enabled = False
    mInkOverlay.Ink = mInkArrayOverlay(PageNum)
    mInkOverlay.Enabled = True 
    ' Note: mInkOverlay was instantiated via: new InkOverlay(control) 
    ' not via: new InkOverlay(control.Handle) - this .ctor does not set AttachedControl
    mInkOverlay.AttachedControl.Invalidate()
End Sub

private void ChangeInkOverlayPage(int PageNum)
{
    mInkOverlay.Enabled = false;
    mInkOverlay.Ink = mInkArrayOverlay[PageNum];
    mInkOverlay.Enabled = true;
    // Note: mInkOverlay was instantiated via: new InkOverlay(control) 
    // not via: new InkOverlay(control.Handle) - this .ctor does not set AttachedControl
    mInkOverlay.AttachedControl.Invalidate();
}

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