IInkStrokeContainer IInkStrokeContainer IInkStrokeContainer IInkStrokeContainer Interface

Represents a manager for the collection of InkStroke objects rendered by the InkPresenter.

Modifications made to any of the ink strokes in the stroke container are immediately rendered to the drawing surface associated with the InkPresenter.

Syntax

Declaration

public interface IInkStrokeContainerpublic interface IInkStrokeContainerPublic Interface IInkStrokeContainerpublic interface IInkStrokeContainer

Remarks

For ink recognition, use an IInkRecognizerContainer object.

Properties summary

Gets the bounding rectangle of the InkStroke collection managed by the InkStrokeContainer.

Methods summary

Adds an InkStroke object to the collection managed by the InkStrokeContainer.

Identifies whether content on the clipboard can be added to the InkStroke collection managed by the InkStrokeContainer.

Note

Clipboard content must be in Ink Serialized Format (ISF).

Copies the selected InkStroke objects (from the InkStroke collection managed by the InkStrokeContainer ) to the clipboard in Ink Serialized Format (ISF) format.

Deletes the selected InkStroke objects from the InkStroke collection managed by the InkStrokeContainer.

Gets the collection of recognition matches previously processed by an InkRecognizer and stored in an InkRecognizerContainer.

Recognition is not supported by InkStrokeContainer, you must use an InkRecognizerContainer object.

Retrieves all ink strokes in the collection managed by the InkStrokeContainer.

Asynchronously loads all InkStroke objects from the specified stream to the InkStroke collection that is managed by the InkStrokeContainer.

Moves the selected strokes. All affected strokes are re-rendered.

Adds the InkStroke content from the clipboard to the InkStroke collection that is managed by the InkStrokeContainer and renders the new strokes.

Asynchronously saves all InkStroke objects in the InkStroke collection that is managed by the InkStrokeContainer to the specified stream.

Selects all strokes intersected by the new stroke.

Note

The Selected flag is reset for all other strokes in the collection.

Selects all strokes contained entirely within the polyline.

Note

The Selected flag is reset for all other strokes in the collection.

.

Updates the collection of recognition matches previously processed by an InkRecognizer and stored in an InkRecognizerContainer.

Recognition is not supported by InkStrokeContainer, you must use an InkRecognizerContainer object.

Properties

  • BoundingRect
    BoundingRect
    BoundingRect
    BoundingRect

    Gets the bounding rectangle of the InkStroke collection managed by the InkStrokeContainer.

    public Rect BoundingRect { get; }public Rect BoundingRect { get; }Public ReadOnly Property BoundingRect As Rectpublic Rect BoundingRect { get; }

    Property Value

Methods

  • AddStroke(InkStroke)
    AddStroke(InkStroke)
    AddStroke(InkStroke)
    AddStroke(InkStroke)

    Adds an InkStroke object to the collection managed by the InkStrokeContainer.

    public void AddStroke(InkStroke stroke)public void AddStroke(InkStroke stroke)Public Function AddStroke(stroke As InkStroke) As voidpublic void AddStroke(InkStroke stroke)

    Parameters

    Remarks

    The StrokesCollected event is fired when ink strokes are processed ("wet" to "dry") on the UI thread.

  • CanPasteFromClipboard()
    CanPasteFromClipboard()
    CanPasteFromClipboard()
    CanPasteFromClipboard()

    Identifies whether content on the clipboard can be added to the InkStroke collection managed by the InkStrokeContainer.

    Note

    Clipboard content must be in Ink Serialized Format (ISF).

    public bool CanPasteFromClipboard()public bool CanPasteFromClipboard()Public Function CanPasteFromClipboard() As boolpublic bool CanPasteFromClipboard()

    Returns

    • bool
      bool
      bool
      bool

      True if content can be pasted from the clipboard; otherwise, false.

  • CopySelectedToClipboard()
    CopySelectedToClipboard()
    CopySelectedToClipboard()
    CopySelectedToClipboard()

    Copies the selected InkStroke objects (from the InkStroke collection managed by the InkStrokeContainer ) to the clipboard in Ink Serialized Format (ISF) format.

    public void CopySelectedToClipboard()public void CopySelectedToClipboard()Public Function CopySelectedToClipboard() As voidpublic void CopySelectedToClipboard()
  • DeleteSelected()
    DeleteSelected()
    DeleteSelected()
    DeleteSelected()

    Deletes the selected InkStroke objects from the InkStroke collection managed by the InkStrokeContainer.

    public Rect DeleteSelected()public Rect DeleteSelected()Public Function DeleteSelected() As Rectpublic Rect DeleteSelected()

    Returns

    • The bounding rectangle of the selected ink strokes, or the invalidated rectangle (0, 0, 0, 0) if no strokes were removed (no selected strokes).

    Remarks

    This method does not cause the StrokesErased event to fire.

  • GetRecognitionResults()
    GetRecognitionResults()
    GetRecognitionResults()
    GetRecognitionResults()

    Gets the collection of recognition matches previously processed by an InkRecognizer and stored in an InkRecognizerContainer.

    Recognition is not supported by InkStrokeContainer, you must use an InkRecognizerContainer object.

    public IVectorView<InkRecognitionResult> GetRecognitionResults()public IVectorView<InkRecognitionResult> GetRecognitionResults()Public Function GetRecognitionResults() As IVectorView( Of InkRecognitionResult )public IVectorView<InkRecognitionResult> GetRecognitionResults()

    Returns

  • GetStrokes()
    GetStrokes()
    GetStrokes()
    GetStrokes()

    Retrieves all ink strokes in the collection managed by the InkStrokeContainer.

    public IVectorView<InkStroke> GetStrokes()public IVectorView<InkStroke> GetStrokes()Public Function GetStrokes() As IVectorView( Of InkStroke )public IVectorView<InkStroke> GetStrokes()

    Returns

  • LoadAsync(IInputStream)
    LoadAsync(IInputStream)
    LoadAsync(IInputStream)
    LoadAsync(IInputStream)

    Asynchronously loads all InkStroke objects from the specified stream to the InkStroke collection that is managed by the InkStrokeContainer.

    public IAsyncActionWithProgress<ulong> LoadAsync(IInputStream inputStream)public IAsyncActionWithProgress<ulong> LoadAsync(IInputStream inputStream)Public Function LoadAsync(inputStream As IInputStream) As IAsyncActionWithProgress( Of ulong )public IAsyncActionWithProgress<ulong> LoadAsync(IInputStream inputStream)

    Parameters

    Returns

    • The status of the asynchronous operation as the number of bytes fetched. For more information, see ReadAsync method.

  • MoveSelected(Point)
    MoveSelected(Point)
    MoveSelected(Point)
    MoveSelected(Point)

    Moves the selected strokes. All affected strokes are re-rendered.

    public Rect MoveSelected(Point translation)public Rect MoveSelected(Point translation)Public Function MoveSelected(translation As Point) As Rectpublic Rect MoveSelected(Point translation)

    Parameters

    • translation

      The destination screen coordinates for the upper-left corner of the bounding rectangle of the selected strokes.

    Returns

    Remarks

    The following can result from a call to MoveSelected(Point):

    • Moving one or more strokes that make up part of a word results in the reprocessing of existing ink recognition results.
    • Moving all strokes that make up a word results in the recalculation of the BoundingRect of the InkRecognitionResult. Ink recognition is not reprocessed.
    • Moving one or more strokes results in the recalculation of the BoundingRect for each stroke.
    • Moving one or more strokes results in the recalculation of the BoundingRect of the InkStrokeContainer.
  • PasteFromClipboard(Point)
    PasteFromClipboard(Point)
    PasteFromClipboard(Point)
    PasteFromClipboard(Point)

    Adds the InkStroke content from the clipboard to the InkStroke collection that is managed by the InkStrokeContainer and renders the new strokes.

    public Rect PasteFromClipboard(Point position)public Rect PasteFromClipboard(Point position)Public Function PasteFromClipboard(position As Point) As Rectpublic Rect PasteFromClipboard(Point position)

    Parameters

    • position

      The screen coordinates for the upper-left corner of the bounding rectangle of the clipboard content.

    Returns

    Remarks

    The content of the clipboard must be in Ink Serialized Format (ISF) format.

  • SaveAsync(IOutputStream)
    SaveAsync(IOutputStream)
    SaveAsync(IOutputStream)
    SaveAsync(IOutputStream)

    Asynchronously saves all InkStroke objects in the InkStroke collection that is managed by the InkStrokeContainer to the specified stream.

    public IAsyncOperationWithProgress<uint, uint> SaveAsync(IOutputStream outputStream)public IAsyncOperationWithProgress<uint, uint> SaveAsync(IOutputStream outputStream)Public Function SaveAsync(outputStream As IOutputStream) As IAsyncOperationWithProgress( Of uint, uint )public IAsyncOperationWithProgress<uint, uint> SaveAsync(IOutputStream outputStream)

    Parameters

    Returns

    • The size of the saved stream and the status of the asynchronous operation as the number of bytes sent. For more information, see WriteAsync method.

  • SelectWithLine(Point, Point)
    SelectWithLine(Point, Point)
    SelectWithLine(Point, Point)
    SelectWithLine(Point, Point)

    Selects all strokes intersected by the new stroke.

    Note

    The Selected flag is reset for all other strokes in the collection.

    public Rect SelectWithLine(Point from, Point to)public Rect SelectWithLine(Point from, Point to)Public Function SelectWithLine(from As Point, to As Point) As Rectpublic Rect SelectWithLine(Point from, Point to)

    Parameters

    Returns

  • SelectWithPolyLine(IIterable<Point>)
    SelectWithPolyLine(IIterable<Point>)
    SelectWithPolyLine(IIterable<Point>)
    SelectWithPolyLine(IIterable<Point>)

    Selects all strokes contained entirely within the polyline.

    Note

    The Selected flag is reset for all other strokes in the collection.

    .

    public Rect SelectWithPolyLine(IIterable<Point> polyline)public Rect SelectWithPolyLine(IIterable<Point> polyline)Public Function SelectWithPolyLine(polyline As IIterable<Point>) As Rectpublic Rect SelectWithPolyLine(IIterable<Point> polyline)

    Parameters

    • polyline

      The points of the polyline.

    Returns

  • UpdateRecognitionResults(IVectorView<InkRecognitionResult>)
    UpdateRecognitionResults(IVectorView<InkRecognitionResult>)
    UpdateRecognitionResults(IVectorView<InkRecognitionResult>)
    UpdateRecognitionResults(IVectorView<InkRecognitionResult>)

    Updates the collection of recognition matches previously processed by an InkRecognizer and stored in an InkRecognizerContainer.

    Recognition is not supported by InkStrokeContainer, you must use an InkRecognizerContainer object.

    public void UpdateRecognitionResults(IVectorView<InkRecognitionResult> recognitionResults)public void UpdateRecognitionResults(IVectorView<InkRecognitionResult> recognitionResults)Public Function UpdateRecognitionResults(recognitionResults As IVectorView<InkRecognitionResult>) As voidpublic void UpdateRecognitionResults(IVectorView<InkRecognitionResult> recognitionResults)

    Parameters

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.GuidAttribute

Details

Assembly

Windows.UI.Input.Inking.dll