Share via


InkOverlay.Ink Property

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
Public Property Ink As Ink
'Usage
Dim instance As InkOverlay
Dim value As Ink

value = instance.Ink

instance.Ink = value
public Ink Ink { get; set; }
public:
property Ink^ Ink {
    Ink^ get ();
    void set (Ink^ value);
}
/** @property */
public Ink get_Ink ()

/** @property */
public void set_Ink (Ink value)
public function get Ink () : Ink

public function set Ink (value : Ink)
Not applicable.

Property Value

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).

Example

This C# example returns the associated Ink object for an InkOverlay, theInkOverlay.

Ink theInk = theInkOverlay.Ink;

This Microsoft Visual Basic .NET example returns the associated Ink object for an InkOverlay, theInkOverlay.

Dim theInk as Ink = theInkOverlay.Ink

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

See Also

Reference

InkOverlay Class
InkOverlay Members
Microsoft.Ink Namespace
InkOverlay.Enabled
Ink