Ink class

Office 2013 and later

Ink. When the object is serialized out as xml, its qualified name is o:ink.

Namespace:  DocumentFormat.OpenXml.Vml.Office
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

public class Ink : OpenXmlLeafElement

[ISO/IEC 29500-1 1st Edition]

ink (Ink)

This element specifies the presence of an ink object. An ink object is a VML object which allows applications to store data for ink annotations. [Note: Applications are encouraged to use an open-ink format, such as the Ink Markup Language (InkML). end note]


<v:shape … >
  <o:ink i="…" annotation="t" contentType="application/inkml+xml"/>
<v:shape … >
  <o:ink i="AMgFHQSWC+YFASAAaAwAAAAAAMA…" annotation="t"    contentType="application/x-ms-ink"/>

end example]

Parent Elements

background (Part 1, §17.2.1); hdrShapeDefaults (§; object (Part 1, §; pict (§; pict (§9.5.1); polyline (§; shape (§; shapeDefaults (§



annotation (Annotation Flag)

Specifies whether the ink object was created as an annotation rather than through pen input. Default is false. [Rationale This allows an application to treat annotation ink objects as any other annotation. For example, if annotations are hidden, the application can hide the ink object. An ink object that represents primary user input through a pen can be left visible. end rationale]


<o:ink … annotation="true">

end example]

The possible values for this attribute are defined by the ST_TrueFalse simple type (§

contentType (Content Type)

Specifies the format of the ink content stored in the i attribute. The syntax is a content type as defined in IETF RFC 2616.

If this attribute is omitted, the application should attempt to determine the content type by reading the contents of the i element.

The possible values for this attribute are defined by the ST_ContentType simple type (§

i (Ink Data)

Specifies additional ink object information which shall be associated with the parent VML shape. The VML shape specifies the information necessary to render the ink, and this attribute can be used to store additional data about the VML shape(s) representing ink. This attribute's contents are formatted as specified by the contentType attribute, but are optional and can be ignored if not recognized.


<o:ink … i="…">

end example]

The possible values for this attribute are defined by the W3C XML Schema string datatype.

[Note: The W3C XML Schema definition of this element’s content model (CT_Ink) is located in §A.6.2. end note]

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.