GridOptionsPrint.AllowMultilineHeaders Property

Gets or sets whether text is wrapped in the print/export output if it contains newline characters.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(false)]
[XtraSerializableProperty]
public virtual bool AllowMultilineHeaders { get; set; }

VB.NET

<DefaultValue(False)>
<XtraSerializableProperty>
Public Overridable Property AllowMultilineHeaders As Boolean

Property Value

Type	Default	Description
Boolean	false	true if text is wrapped in the print/export output if it contains newline characters; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to AllowMultilineHeaders
GridView	.OptionsPrint .AllowMultilineHeaders

Remarks

You can include newline characters in column headers and band headers using the “\n” escape sequence in C#, and the VbCrLf constant in Visual Basic. By default, the AllowMultilineHeaders property is set to false and as a result, newline characters are ignored when the grid is printed/exported. For newlines to be in effect in the print/export output, set the AllowMultilineHeaders property to true.

Note

By default, column and band headers are not auto enlarged to fit multi-line text. You can make the header panels bigger using the GridView.ColumnPanelRowHeight and BandedGridView.BandPanelRowHeight properties, respectively.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AllowMultilineHeaders property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-grid-custom-print-cells-headers-in-print-preview/CS/GridBeforePrint/MyGridViewPrintInfo.cs#L61

var gview = View.OptionsPrint as GridOptionsPrint;
if (gview != null && !gview.AllowMultilineHeaders) return column.GetTextCaption();
return (View as MyGridView).GoAndGetNonFormattedCaption(column.GetCaption());

VB.NET

winforms-grid-custom-print-cells-headers-in-print-preview/VB/GridBeforePrint/MyGridViewPrintInfo.vb#L64

Dim gview = TryCast(View.OptionsPrint, GridOptionsPrint)
If gview IsNot Nothing AndAlso (Not gview.AllowMultilineHeaders) Then
    Return column.GetTextCaption()