# OfficeInkDocument

A reusable collection of ink strokes in one canvas coordinate system.

Class 

`OfficeIMO.Drawing`

**Namespace**

`OfficeIMO.Drawing`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeInkModel.cs:410](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Ink/OfficeInkModel.cs#L410)

**Modifiers**

sealed

A reusable collection of ink strokes in one canvas coordinate system.

## Inheritance

- object
- OfficeInkDocument

## Usage

Explore 4 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 2

- Method [OfficeInkDocument.Add](/api/core/officeimo-drawing-officeinkdocument/#method-add-officeimo-drawing-officeinkstroke)
- Method [OfficeInkDocument.Clone](/api/core/officeimo-drawing-officeinkdocument/#method-clone)

### Accepted by parameters 2

- Method [OfficeInkRenderer.AddToDrawing](/api/core/officeimo-drawing-officeinkrenderer/#method-addtodrawing-officeimo-drawing-officedrawing-officeimo-drawing-officeinkdocument-double-double-officeimo-drawing-officeinkrenderoptions) parameter `ink`
- Method [OfficeInkRenderer.Render](/api/core/officeimo-drawing-officeinkrenderer/#method-render-officeimo-drawing-officeinkdocument-double-double-officeimo-drawing-officeinkrenderoptions) parameter `ink`

Filter members 

Show inherited

## Constructors

`public OfficeInkDocument()` [#](#constructor-ctor)

[OfficeInkModel.cs:410](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Ink/OfficeInkModel.cs#L410)

Creates an empty ink document.

## Methods

`public OfficeInkDocument Add(OfficeInkStroke stroke)` [#](#method-add-officeimo-drawing-officeinkstroke)

[OfficeInkModel.cs:423](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Ink/OfficeInkModel.cs#L423)

Adds a stroke and returns this document.

Parameters

**stroke OfficeIMO.Drawing.OfficeInkStroke required**

Returns

`OfficeInkDocument`

`public OfficeInkDocument Clone()` [#](#method-clone)

[OfficeInkModel.cs:444](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Ink/OfficeInkModel.cs#L444)

Creates a detached copy of this ink document.

Returns

`OfficeInkDocument`

`public OfficeInkBounds GetBounds()` [#](#method-getbounds)

[OfficeInkModel.cs:437](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Ink/OfficeInkModel.cs#L437)

Returns bounds covering every stroke.

Returns

`OfficeInkBounds`

`public bool Remove(OfficeInkStroke stroke)` [#](#method-remove-officeimo-drawing-officeinkstroke)

[OfficeInkModel.cs:431](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Ink/OfficeInkModel.cs#L431)

Removes the first matching stroke.

Parameters

**stroke OfficeIMO.Drawing.OfficeInkStroke required**

Returns

`bool` True when the stroke was present.

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public IReadOnlyList<OfficeInkStroke> Strokes { get; }` [#](#property-strokes)

[OfficeInkModel.cs:419](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Ink/OfficeInkModel.cs#L419)

Ink strokes in paint order.

<!-- PowerForge markdown artifact sha256:2F2C463C04DE3B8768482C18FF0630538289BE91103C12D6C6C6313F3E457E56 -->
