FlowDocument.ColumnGap 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 gap value, which indicates the spacing between columns in a FlowDocument.

public:
 property double ColumnGap { 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 ColumnGap { get; set; }

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

Public Property ColumnGap As Double

Property Value

Double

The column gap, in device independent pixels. A value of NaN (equivalent to an attribute value of "Auto") indicates that the column gap is equal to the LineHeight property. The default is NaN.

Attributes: TypeConverterAttribute LocalizabilityAttribute

Examples

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

FlowDocument flowDoc = new FlowDocument(new Paragraph(new Run("A bit of text content...")));
// Set the desired column gap to 10 device independend pixels.
flowDoc.ColumnGap = 10.0;

Dim flowDocColGap As New FlowDocument(New Paragraph(New Run("A bit of text content...")))
    ' Set the desired column gap to 10 device independend pixels.
flowDocColGap.ColumnGap = 10.0

Remarks

Getting this property returns the current column gap. Setting this value changes the currently effective column gap, and may cause content to reflow.

The column gap cannot exceed the current PageWidth minus any PagePadding. If the value of the ColumnGap property exceeds this limit, the effective column gap is reduced to observe this limit.

This property has no effect if ColumnWidth is null.

XAML Attribute Usage

<object ColumnGap="double"/>
- or -
<object ColumnGap="qualifiedDouble"/>
- or -
<object ColumnGap="Auto"/>

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 (excepting Auto), 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

Auto Causes the effective spacing between columns to be set to the current value of the LineHeight property. Equivalent to a property value of NaN.

Dependency Property Information

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

Applies to

Share via