FlowDocument.ColumnRuleBrush 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 Brush used to draw the rule between columns.

public:
 property System::Windows::Media::Brush ^ ColumnRuleBrush { System::Windows::Media::Brush ^ get(); void set(System::Windows::Media::Brush ^ value); };

public System.Windows.Media.Brush ColumnRuleBrush { get; set; }

member this.ColumnRuleBrush : System.Windows.Media.Brush with get, set

Public Property ColumnRuleBrush As Brush

Property Value

Brush

A Brush to use when drawing the rule line between columns, or null to not use a background brush. The default is null.

Examples

The following example shows how to set the ColumnRuleBrush 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.

For a table of swatches that show the available predefined brush colors, see Brushes.

This property has no effect if the ColumnRuleWidth property is 0 or null.

Column rules are displayed only when there are two or more columns.

Dependency Property Information

Item	Value
Identifier field	ColumnRuleBrushProperty
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