Export (0) Print
Expand All

FlowDocument.ColumnGap Property

Gets or sets the column gap value, which indicates the spacing between columns in a FlowDocument.

Namespace:  System.Windows.Documents
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

[LocalizabilityAttribute(LocalizationCategory.None, Readability = Readability.Unreadable)]
[TypeConverterAttribute(typeof(LengthConverter))]
public double ColumnGap { get; set; }
<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.

Property Value

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

Identifier field

ColumnGapProperty

Metadata properties set to true

AffectsRender

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.

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;

More Code

How to: Use FlowDocument Column-Separating AttributesThis example shows how to use the column-separating features of a FlowDocument.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft