Table of Contents

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

points IReadOnlyList<ReportShapePoint>

The points, relative to the owning item's top-left corner; copied.

closed bool

Whether the last point joins back to the first.

fill ColorRgb?

The fill colour, or null for none.

stroke ColorRgb?

The stroke colour, or null for none.

strokeWidth Twips

The stroke's width.

Exceptions

ArgumentNullException

points is 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

points IReadOnlyList<ReportShapePoint>

The points, relative to the owning item's top-left corner; copied.

closed bool

Whether the last point joins back to the first.

fill ColorRgb?

The fill colour, or null for none.

fillAlpha byte

The fill's opacity.

stroke ColorRgb?

The stroke colour, or null for none.

strokeAlpha byte

The stroke's opacity.

strokeWidth Twips

The stroke's width.

Exceptions

ArgumentNullException

points is 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

points IReadOnlyList<ReportShapePoint>

The points, relative to the owning item's top-left corner; copied.

closed bool

Whether the last point joins back to the first.

fill ColorRgb?

The fill colour, or null for none.

fillAlpha byte

The fill's opacity.

stroke ColorRgb?

The stroke colour, or null for none.

strokeAlpha byte

The stroke's opacity.

strokeWidth Twips

The stroke's width.

dashPattern IReadOnlyList<Twips>

Alternating dash and gap lengths, starting with a dash; null or empty for a solid stroke. Copied.

lineCap ReportShapeLineCap

The shape of each end of the stroke, and of each dash.

lineJoin ReportShapeLineJoin

The shape of the stroke where two segments meet.

Exceptions

ArgumentNullException

points is 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

points IReadOnlyList<ReportShapePoint>

The points, relative to the owning item's top-left corner; copied.

closed bool

Whether the last point joins back to the first.

fill ColorRgb?

The fill colour, or null for none; with a gradient, the flat colour a consumer that cannot paint one falls back to.

fillAlpha byte

The fill's opacity, the gradient's included.

stroke ColorRgb?

The stroke colour, or null for none.

strokeAlpha byte

The stroke's opacity.

strokeWidth Twips

The stroke's width.

dashPattern IReadOnlyList<Twips>

Alternating dash and gap lengths, starting with a dash; null or empty for a solid stroke. Copied.

lineCap ReportShapeLineCap

The shape of each end of the stroke, and of each dash.

lineJoin ReportShapeLineJoin

The shape of the stroke where two segments meet.

gradient ReportShapeGradient

The gradient the path is filled with, or null for the flat fill.

Exceptions

ArgumentNullException

points is null.

ArgumentException

gradient is set and fill is 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

points IReadOnlyList<ReportShapePoint>

The points, relative to the owning item's top-left corner; copied.

closed bool

Whether the last point joins back to the first.

fill ColorRgb?

The fill colour, or null for none; with a gradient or a hatch, the flat colour a consumer that cannot paint one falls back to.

fillAlpha byte

The fill's opacity, the gradient's or the hatch's included.

stroke ColorRgb?

The stroke colour, or null for none.

strokeAlpha byte

The stroke's opacity.

strokeWidth Twips

The stroke's width.

dashPattern IReadOnlyList<Twips>

Alternating dash and gap lengths, starting with a dash; null or empty for a solid stroke. Copied.

lineCap ReportShapeLineCap

The shape of each end of the stroke, and of each dash.

lineJoin ReportShapeLineJoin

The shape of the stroke where two segments meet.

gradient ReportShapeGradient

The gradient the path is filled with, or null; ignored by a consumer when a hatch is set.

hatch ReportShapeHatch

The hatch the path is filled with, or null.

Exceptions

ArgumentNullException

points is null.

ArgumentException

A gradient or a hatch is set and fill is null.

ArgumentOutOfRangeException

A dash or gap is negative, or every one of them is zero.