Constructor ReportShapePath
- Namespace
- DocWright.Reporting.Pagination
- Assembly
- DocWright.Reporting.dll
ReportShapePath(IReadOnlyList<ReportShapePoint>, bool, ColorRgb?, ColorRgb?, Twips)
Initializes an opaque path of straight segments through its points, in order.
public ReportShapePath(IReadOnlyList<ReportShapePoint> points, bool closed, ColorRgb? fill, ColorRgb? stroke, Twips strokeWidth)
Parameters
pointsIReadOnlyList<ReportShapePoint>The points, relative to the owning item's top-left corner; copied.
closedboolWhether the last point joins back to the first.
fillColorRgb?The fill colour, or null for none.
strokeColorRgb?The stroke colour, or null for none.
strokeWidthTwipsThe stroke's width.
Exceptions
- ArgumentNullException
pointsis null.
ReportShapePath(IReadOnlyList<ReportShapePoint>, bool, ColorRgb?, byte, ColorRgb?, byte, Twips)
Initializes a path whose fill and stroke have opacities from 0 (transparent) to 255 (opaque).
public ReportShapePath(IReadOnlyList<ReportShapePoint> points, bool closed, ColorRgb? fill, byte fillAlpha, ColorRgb? stroke, byte strokeAlpha, Twips strokeWidth)
Parameters
pointsIReadOnlyList<ReportShapePoint>The points, relative to the owning item's top-left corner; copied.
closedboolWhether the last point joins back to the first.
fillColorRgb?The fill colour, or null for none.
fillAlphabyteThe fill's opacity.
strokeColorRgb?The stroke colour, or null for none.
strokeAlphabyteThe stroke's opacity.
strokeWidthTwipsThe stroke's width.
Exceptions
- ArgumentNullException
pointsis null.
ReportShapePath(IReadOnlyList<ReportShapePoint>, bool, ColorRgb?, byte, ColorRgb?, byte, Twips, IReadOnlyList<Twips>?, ReportShapeLineCap, ReportShapeLineJoin)
Initializes a path with a dashed stroke and the shape of its stroke's ends and corners.
public ReportShapePath(IReadOnlyList<ReportShapePoint> points, bool closed, ColorRgb? fill, byte fillAlpha, ColorRgb? stroke, byte strokeAlpha, Twips strokeWidth, IReadOnlyList<Twips>? dashPattern, ReportShapeLineCap lineCap, ReportShapeLineJoin lineJoin)
Parameters
pointsIReadOnlyList<ReportShapePoint>The points, relative to the owning item's top-left corner; copied.
closedboolWhether the last point joins back to the first.
fillColorRgb?The fill colour, or null for none.
fillAlphabyteThe fill's opacity.
strokeColorRgb?The stroke colour, or null for none.
strokeAlphabyteThe stroke's opacity.
strokeWidthTwipsThe stroke's width.
dashPatternIReadOnlyList<Twips>Alternating dash and gap lengths, starting with a dash; null or empty for a solid stroke. Copied.
lineCapReportShapeLineCapThe shape of each end of the stroke, and of each dash.
lineJoinReportShapeLineJoinThe shape of the stroke where two segments meet.
Exceptions
- ArgumentNullException
pointsis null.- ArgumentOutOfRangeException
A dash or gap is negative, or every one of them is zero.
ReportShapePath(IReadOnlyList<ReportShapePoint>, bool, ColorRgb?, byte, ColorRgb?, byte, Twips, IReadOnlyList<Twips>?, ReportShapeLineCap, ReportShapeLineJoin, ReportShapeGradient?)
Initializes a path that may be filled with a gradient rather than a flat colour.
public ReportShapePath(IReadOnlyList<ReportShapePoint> points, bool closed, ColorRgb? fill, byte fillAlpha, ColorRgb? stroke, byte strokeAlpha, Twips strokeWidth, IReadOnlyList<Twips>? dashPattern, ReportShapeLineCap lineCap, ReportShapeLineJoin lineJoin, ReportShapeGradient? gradient)
Parameters
pointsIReadOnlyList<ReportShapePoint>The points, relative to the owning item's top-left corner; copied.
closedboolWhether the last point joins back to the first.
fillColorRgb?The fill colour, or null for none; with a
gradient, the flat colour a consumer that cannot paint one falls back to.fillAlphabyteThe fill's opacity, the gradient's included.
strokeColorRgb?The stroke colour, or null for none.
strokeAlphabyteThe stroke's opacity.
strokeWidthTwipsThe stroke's width.
dashPatternIReadOnlyList<Twips>Alternating dash and gap lengths, starting with a dash; null or empty for a solid stroke. Copied.
lineCapReportShapeLineCapThe shape of each end of the stroke, and of each dash.
lineJoinReportShapeLineJoinThe shape of the stroke where two segments meet.
gradientReportShapeGradientThe gradient the path is filled with, or null for the flat
fill.
Exceptions
- ArgumentNullException
pointsis null.- ArgumentException
gradientis set andfillis null.- ArgumentOutOfRangeException
A dash or gap is negative, or every one of them is zero.
ReportShapePath(IReadOnlyList<ReportShapePoint>, bool, ColorRgb?, byte, ColorRgb?, byte, Twips, IReadOnlyList<Twips>?, ReportShapeLineCap, ReportShapeLineJoin, ReportShapeGradient?, ReportShapeHatch?)
Initializes a path that may be filled with a hatch (Phase 96) or a gradient rather than a flat colour.
public ReportShapePath(IReadOnlyList<ReportShapePoint> points, bool closed, ColorRgb? fill, byte fillAlpha, ColorRgb? stroke, byte strokeAlpha, Twips strokeWidth, IReadOnlyList<Twips>? dashPattern, ReportShapeLineCap lineCap, ReportShapeLineJoin lineJoin, ReportShapeGradient? gradient, ReportShapeHatch? hatch)
Parameters
pointsIReadOnlyList<ReportShapePoint>The points, relative to the owning item's top-left corner; copied.
closedboolWhether the last point joins back to the first.
fillColorRgb?The fill colour, or null for none; with a
gradientor ahatch, the flat colour a consumer that cannot paint one falls back to.fillAlphabyteThe fill's opacity, the gradient's or the hatch's included.
strokeColorRgb?The stroke colour, or null for none.
strokeAlphabyteThe stroke's opacity.
strokeWidthTwipsThe stroke's width.
dashPatternIReadOnlyList<Twips>Alternating dash and gap lengths, starting with a dash; null or empty for a solid stroke. Copied.
lineCapReportShapeLineCapThe shape of each end of the stroke, and of each dash.
lineJoinReportShapeLineJoinThe shape of the stroke where two segments meet.
gradientReportShapeGradientThe gradient the path is filled with, or null; ignored by a consumer when a hatch is set.
hatchReportShapeHatchThe hatch the path is filled with, or null.
Exceptions
- ArgumentNullException
pointsis null.- ArgumentException
A gradient or a hatch is set and
fillis null.- ArgumentOutOfRangeException
A dash or gap is negative, or every one of them is zero.