Share via

StrokeDashArray Property

  • Article

Gets or sets a string of double values that indicates the pattern of dashes and gaps that is used to outline shapes.

XAML
<object StrokeDashArray="strokeDashString" .../>
Scripting
object.StrokeDashArray = "strokeDashString"

Property Value

string

A string composed of delimited double values that specify the pattern of dashes and gaps. See strokeDashString Grammar section.

This property is write-only.

strokeDashString Grammar

S[,G][,S*,G**]*

S A double value that defines the length of the first stroke in the sequence.
G A double value that defines the length of the first gap between strokes in the sequence. If G is omitted, the gap length is identical to the preceding stroke length.
S* A double value that defines the length of the additional strokes in the sequence.
G* A double value that defines the length of additional gaps between strokes in the sequence. If G* is omitted, the gap length is identical to the preceding stroke length.
  • The [] characters are not literals, they are indicators of optional values. The * indicates that any number of stroke-dash pairs beyond the initial S,G is permitted.
  • The separator in this grammar can be either a space or a comma. You can use a mixture of space and comma as separators.
  • Each double value in the string specifies the length of a stroke or gap relative to the thickness of the pen. For example, a value of 1 creates a dash or gap that has the same length as the thickness of the pen (a square).
  • If an odd-numbered total of entries is in the string, then the missing even-numbered entry of a pair will use the gap value specified by the last valid (even-numbered entry) gap value.

Remarks

More than one pair of entries can be included in the string, and will repeat in a pattern. Even-numbered entries specify dashes; odd-numbered entries specify gaps.

A set of dashes is defined through a string syntax, enabled by an underlying type converter. There is no object available in the object model for accessing the set of dashes as a collection. In either script or XAML, StrokeDashArray is write-only; attempting to get a value through scripting will result in a runtime GetValue error. You set the value by specifying a string.

Applies To

Ellipse, Line, Path, Polygon, Polyline, Rectangle, Shape

See Also

Shapes and Drawing in Silverlight Overview