FlowDocument.ColumnRuleWidth Property

Reference

Definition

Namespace:: System.Windows.Documents

Assembly:: PresentationFramework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the column rule width.

public:
 property double ColumnRuleWidth { double get(); void set(double value); };

[System.ComponentModel.TypeConverter(typeof(System.Windows.LengthConverter))]
[System.Windows.Localizability(System.Windows.LocalizationCategory.None, Readability=System.Windows.Readability.Unreadable)]
public double ColumnRuleWidth { get; set; }

[<System.ComponentModel.TypeConverter(typeof(System.Windows.LengthConverter))>]
[<System.Windows.Localizability(System.Windows.LocalizationCategory.None, Readability=System.Windows.Readability.Unreadable)>]
member this.ColumnRuleWidth : double with get, set

Public Property ColumnRuleWidth As Double

Property Value

Double

The column rule width, in device independent pixels. The default is 0.0.

Attributes: TypeConverterAttribute LocalizabilityAttribute

Examples

The following example shows how to set the ColumnRuleWidth property programmatically.

FlowDocument flowDoc = new FlowDocument(new Paragraph(new Run("A bit of text content...")));
// Set a column rule two pixels wide colored Dodger blue.
flowDoc.ColumnRuleWidth = 2.0;
flowDoc.ColumnRuleBrush = Brushes.DodgerBlue;

Dim flowDocColRule As New FlowDocument(New Paragraph(New Run("A bit of text content...")))
    ' Set a column rule two pixels wide colored Dodger blue.
flowDocColRule.ColumnRuleWidth = 2.0
flowDocColRule.ColumnRuleBrush = Brushes.DodgerBlue

Remarks

The column rule is a line that is drawn between columns, and is used to visually separate columns of content.

This property has no effect if the ColumnRuleBrush property is null.

Column rules are only displayed when there are two or more columns. The column rule width is constrained to be less than or equal to the ColumnGap.

XAML Attribute Usage

<object ColumnRuleWidth="double"/>
- or -
<object ColumnRuleWidth="qualifiedDouble"/>

XAML Values

double Double

String representation of a Double value equal to or greater than 0.0 but smaller than Double.PositiveInfinity. An unqualified value is measured in device independent pixels. Strings need not explicitly include decimal points.

qualifiedDouble A double value as described above, followed by one of the following unit specifiers: px, in, cm, pt.

px (default) is device-independent units (1/96th inch per unit)

in is inches; 1in==96px

cm is centimeters; 1cm==(96/2.54) px

pt is points; 1pt==(96/72) px

Dependency Property Information

Item	Value
Identifier field	ColumnRuleWidthProperty
Metadata properties set to `true`	AffectsRender

Applies to

Product	Versions
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via