OfficeInkStroke
OfficeIMO.Drawing
A dependency-free, format-neutral ink stroke.
Inheritance
- object
- OfficeInkStroke
Usage
Explore 6 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 3
- Property OfficeInkDocument.Strokes
- Method OfficeInkStroke.AddPoint
- Method OfficeInkStroke.Clone
Accepted by parameters 3
- Method OfficeInkDocument.Add
- Method OfficeInkDocument.Remove
- Method OfficeInkRenderer.GetEffectiveOpacity
Constructors
public OfficeInkStroke(IEnumerable<OfficeInkPoint> points) #Creates a stroke from sampled points.
Parameters
- points System.Collections.Generic.IEnumerable<OfficeIMO.Drawing.OfficeInkPoint>
Methods
public OfficeInkStroke AddPoint(OfficeInkPoint point) #Adds a sampled point and returns this stroke.
Parameters
- point OfficeIMO.Drawing.OfficeInkPoint
Returns
OfficeInkStrokepublic OfficeInkStroke AddPoint(double x, double y, double? pressure = null) #Adds a sampled point and returns this stroke.
Parameters
- x double
- y double
- pressure double? = null
Returns
OfficeInkStrokepublic OfficeInkBounds GetBounds() #Returns axis-aligned bounds including nominal pen-tip dimensions.
Returns
OfficeInkBoundspublic ValueTuple<double, double> GetTransformedTipDimensions() #Returns the axis-aligned pen-tip width and height after applying the linear portion of the optional affine transform. Translation does not affect the returned dimensions. Elliptical and rectangular tips retain their distinct geometry.
Returns
ValueTuple<double, double>public double GetTransformedTipExtent(double axisX, double axisY) #Returns the full transformed pen-tip extent projected onto a canvas-space axis. The axis does not need to be normalized. Translation does not affect the returned extent.
Parameters
- axisX double
- axisY double
Returns
doublepublic OfficePoint GetTransformedTipSupport(double axisX, double axisY) #Returns the transformed pen-tip support offset from its center in a canvas-space direction. This is the reusable tangent point used to sweep affine elliptical and rectangular tips along a path.
Parameters
- axisX double
- axisY double
Returns
OfficePointpublic bool IsTransformedTipAxisAligned() #Returns whether the transformed pen tip remains an axis-aligned, non-degenerate ellipse or rectangle. Formats that store only tip width and height can use this to reject affine geometry they cannot represent losslessly.
Returns
boolInherited Methods
Properties
public IReadOnlyList<OfficeInkPoint> Points { get; } #Stroke samples in capture order.
public double Opacity { get; set; } #Additional stroke opacity from 0 through 1.
public OfficeInkBias Bias { get; set; } #Handwriting/drawing interpretation bias.
public bool FitToCurve { get; set; } #Whether a renderer should smooth the captured samples.
public bool IgnorePressure { get; set; } #Whether pressure samples should be ignored.
public bool IsHighlighter { get; set; } #Whether the stroke represents translucent highlighting.
public OfficeTransform? Transform { get; set; } #Optional affine transform applied to captured samples.
public uint? LanguageId { get; set; } #Optional handwriting language identifier.
public string? RecognizedText { get; set; } #Best recognized text associated with the stroke.
public IList<string> RecognitionAlternatives { get; } #Alternative handwriting-recognition candidates, best first.