Table of Contents

Constructor ReportShapeLabel

Namespace
DocWright.Reporting.Pagination
Assembly
DocWright.Reporting.dll

ReportShapeLabel(string, Twips, Twips, Twips, ReportShapeLabelAlignment, string, Twips, bool, bool, ColorRgb)

Initializes a run of text placed by an anchor and a baseline.

public ReportShapeLabel(string text, Twips left, Twips baseline, Twips width, ReportShapeLabelAlignment alignment, string fontFamily, Twips fontSize, bool bold, bool italic, ColorRgb color)

Parameters

text string

The text.

left Twips

The anchor's horizontal position, which alignment interprets.

baseline Twips

The baseline, relative to the owning item's top edge.

width Twips

The text's measured width.

alignment ReportShapeLabelAlignment

How the text sits against its anchor.

fontFamily string

The font family.

fontSize Twips

The font size.

bold bool

Whether the text is bold.

italic bool

Whether the text is italic.

color ColorRgb

The text's colour.

Exceptions

ArgumentNullException

text or fontFamily is null.

ReportShapeLabel(string, Twips, Twips, Twips, ReportShapeLabelAlignment, string, Twips, bool, bool, ColorRgb, IReadOnlyList<Twips>?)

Initializes a run of text whose characters each advance by their own measured width.

public ReportShapeLabel(string text, Twips left, Twips baseline, Twips width, ReportShapeLabelAlignment alignment, string fontFamily, Twips fontSize, bool bold, bool italic, ColorRgb color, IReadOnlyList<Twips>? advances)

Parameters

text string

The text.

left Twips

The anchor's horizontal position, which alignment interprets.

baseline Twips

The baseline, relative to the owning item's top edge.

width Twips

The text's measured width.

alignment ReportShapeLabelAlignment

How the text sits against its anchor.

fontFamily string

The font family.

fontSize Twips

The font size.

bold bool

Whether the text is bold.

italic bool

Whether the text is italic.

color ColorRgb

The text's colour.

advances IReadOnlyList<Twips>

One advance per code point of text, in order; null or empty to share width evenly between them. Copied.

Exceptions

ArgumentNullException

text or fontFamily is null.

ArgumentException

advances does not hold one advance per code point.

ReportShapeLabel(string, Twips, Twips, Twips, ReportShapeLabelAlignment, string, Twips, bool, bool, ColorRgb, IReadOnlyList<Twips>?, GlyphOrientation)

Initializes a run of text turned a quarter turn, such as a chart's value-axis title.

public ReportShapeLabel(string text, Twips left, Twips baseline, Twips width, ReportShapeLabelAlignment alignment, string fontFamily, Twips fontSize, bool bold, bool italic, ColorRgb color, IReadOnlyList<Twips>? advances, GlyphOrientation orientation)

Parameters

text string

The text.

left Twips

For upright text, the anchor's horizontal position, which alignment interprets; for turned text, the horizontal position of the run's origin — the start of its baseline, where its first glyph begins.

baseline Twips

For upright text, the baseline, relative to the owning item's top edge; for turned text, the vertical position of the run's origin.

width Twips

The text's measured advance, along its baseline.

alignment ReportShapeLabelAlignment

How upright text sits against its anchor; turned text is placed by its origin and ignores it.

fontFamily string

The font family.

fontSize Twips

The font size.

bold bool

Whether the text is bold.

italic bool

Whether the text is italic.

color ColorRgb

The text's colour.

advances IReadOnlyList<Twips>

One advance per code point of text, in order; null or empty to share width evenly between them. Copied.

orientation GlyphOrientation

Which way the text is turned: CounterClockwise90 reads bottom to top, as a value axis's title does; Clockwise90 top to bottom.

Exceptions

ArgumentNullException

text or fontFamily is null.

ArgumentException

advances does not hold one advance per code point.

ReportShapeLabel(string, Twips, Twips, Twips, string, Twips, bool, bool, ColorRgb, IReadOnlyList<Twips>?, double)

Initializes a run of text turned to any angle about its origin, such as a gauge's scale label that follows the scale round (Phase 94).

public ReportShapeLabel(string text, Twips left, Twips baseline, Twips width, string fontFamily, Twips fontSize, bool bold, bool italic, ColorRgb color, IReadOnlyList<Twips>? advances, double angle)

Parameters

text string

The text.

left Twips

The horizontal position of the run's origin — the start of its baseline, where its first glyph begins.

baseline Twips

The vertical position of the run's origin, relative to the owning item's top edge.

width Twips

The text's measured advance, along its baseline.

fontFamily string

The font family.

fontSize Twips

The font size.

bold bool

Whether the text is bold.

italic bool

Whether the text is italic.

color ColorRgb

The text's colour.

advances IReadOnlyList<Twips>

One advance per code point of text, in order; null or empty to share width evenly between them. Copied.

angle double

How far the baseline is turned, in degrees clockwise from level about the origin; brought into (−180, 180], and 0 when it is not a finite number.

Exceptions

ArgumentNullException

text or fontFamily is null.

ArgumentException

advances does not hold one advance per code point.