API Reference
OfficeInkStroke
A dependency-free, format-neutral ink stroke.
Inheritance
- Object
- OfficeInkStroke
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property OfficeInkDocument.Strokes
- Method OfficeInkStroke.AddPoint
- Method OfficeInkStroke.AddPoint
- Method OfficeInkStroke.Clone
Accepted by parameters
- Method OfficeInkDocument.Add
- Method OfficeInkDocument.Remove
- Method OfficeInkRenderer.GetEffectiveOpacity
Constructors
Methods
public OfficeInkStroke AddPoint(OfficeInkPoint point) #OfficeInkStrokeAdds a sampled point and returns this stroke.
Parameters
- point OfficeIMO.Drawing.OfficeInkPoint
public OfficeInkStroke AddPoint(Double x, Double y, Nullable<Double> pressure = null) #OfficeInkStrokeAdds a sampled point and returns this stroke.
Parameters
- x System.Double
- y System.Double
- pressure System.Nullable{System.Double} = null
public OfficeInkBounds GetBounds() #OfficeInkBoundsReturns axis-aligned bounds including nominal pen-tip dimensions.
public ValueTuple<Double, Double> GetTransformedTipDimensions() #ValueTuple<Double, Double>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.
public Double GetTransformedTipExtent(Double axisX, Double axisY) #DoubleReturns 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 System.Double
- axisY System.Double
public OfficePoint GetTransformedTipSupport(Double axisX, Double axisY) #OfficePointReturns 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 System.Double
- axisY System.Double
public Boolean IsTransformedTipAxisAligned() #BooleanReturns 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.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public IReadOnlyList<OfficeInkPoint> Points { get; } #Stroke samples in capture order.
public OfficeColor Color { get; set; } #Base stroke color.
public Double Width { get; set; } #Nominal pen-tip width in canvas units.
public Double Height { get; set; } #Nominal pen-tip height in canvas units.
public Double Opacity { get; set; } #Additional stroke opacity from 0 through 1.
public OfficeInkTipShape TipShape { get; set; } #Pen tip shape.
public OfficeInkBias Bias { get; set; } #Handwriting/drawing interpretation bias.
public Boolean FitToCurve { get; set; } #Whether a renderer should smooth the captured samples.
public Boolean IgnorePressure { get; set; } #Whether pressure samples should be ignored.
public Boolean IsHighlighter { get; set; } #Whether the stroke represents translucent highlighting.
public Nullable<OfficeTransform> Transform { get; set; } #Optional affine transform applied to captured samples.
public Nullable<UInt32> 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.