Represents the sequence of dashes and gaps that will be applied by a Pen.
Assembly: PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
The Dashes property of this class describes the length of alternating dashes and gaps. The values in the collection are in terms of multiples of the Thickness of the Pen. For example, an array of 1,2 specifies a dash of length (1 * Thickness) followed by a gap of length (2 * Thickness).
The actual length of the dash that is drawn depends on the style of DashCap that is added to each end of the dash. The default DashCap value for a Pen is Square. This causes an end cap that is one half the thickness of the line to be added onto each end of the pen stroke. (See PenLinecap for an example.) Therefore, if you specify an array of 0, 2 and a square DashCap, the actual dash length will be (0 * Thickness) + (2 * DashCap).
If there are an odd number of values in the collection, the values are interpreted as if they had been repeated once to produce an even number of values. For example, a collection containing 2,3,5 is interpreted the same as a collection containing 2,3,5,2,3,5.
Negative values in the array are interpreted as their absolute value.
The following example shows how to use the property of a Pen to create a dashed line under text.
<Page xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" > <StackPanel Margin="20"> <TextBlock FontSize="36"> the lazy brown dog. <TextBlock.TextDecorations> <TextDecoration Location="Underline" PenThicknessUnit="FontRecommended"> <TextDecoration.Pen> <Pen Thickness="1.5" Brush="Red" > <!-- For the underline, create a dashed line with each dash twice the thickness of the Pen and each gap 8 times the thickness of the Pen. --> <Pen.DashStyle> <DashStyle Dashes="2,8"/> </Pen.DashStyle> </Pen> </TextDecoration.Pen> </TextDecoration> </TextBlock.TextDecorations> </TextBlock> </StackPanel> </Page>
The following illustration shows what the preceding example produces.
The following illustration shows examples of different dash styles applied to an underline.
Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.