SectionColumns.CreateUniformColumns(SectionPage, Single, Int32) Method

Creates a uniform column layout using the current page settings.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v20.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

SectionColumnCollection CreateUniformColumns(
    SectionPage page,
    float columnSpacing,
    int columnCount
)

VB.NET

Function CreateUniformColumns(
    page As SectionPage,
    columnSpacing As Single,
    columnCount As Integer
) As SectionColumnCollection

Parameters

Name	Type	Description
page	SectionPage	A SectionPage object representing a current page.
columnSpacing	Single	A Single value specifying the spacing between adjacent columns, measured in Document.Unit.
columnCount	Int32	An Int32 value specifying the number of columns on a page. Must be greater than zero.

Returns

Type	Description
SectionColumnCollection	A SectionColumnCollection object representing a collection of columns.

Remarks

Use the CreateUniformColumns method to create a layout with the specified number of columns on a page. To apply the layout to a section, use the SectionColumns.SetColumns method, as illustrated below:

C#

using DevExpress.XtraRichEdit.API.Native;
// ...
richEditControl1.Document.Unit = DocumentUnit.Inch;

Section sectionDoc = richEditControl1.Document.Sections[0];
SectionColumnCollection sectionColumnsLayout = sectionDoc.Columns.CreateUniformColumns(sectionDoc.Page, 0.25f, 3);
sectionDoc.Columns.SetColumns(sectionColumnsLayout);

VB.NET

Imports DevExpress.XtraRichEdit.API.Native
' ...
richEditControl1.Document.Unit = DocumentUnit.Inch

Private sectionDoc As Section = richEditControl1.Document.Sections(0)
Private sectionColumnsLayout As SectionColumnCollection = sectionDoc.Columns.CreateUniformColumns(sectionDoc.Page, 0.25f, 3)
sectionDoc.Columns.SetColumns(sectionColumnsLayout)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CreateUniformColumns(SectionPage, Single, Int32) method.

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#

page-layout-simple-example-t553072/CS/PageLayout/Form1.cs#L70

// Create equal width column layout:
SectionColumnCollection sectionColumnsLayout = section.Columns.CreateUniformColumns(section.Page, Units.InchesToDocumentsF(0.2f), 3);

word-document-api-examples/CS/CodeExamples/PageLayoutActions.cs#L37

SectionColumnCollection sectionColumnsLayout =
    firstSection.Columns.CreateUniformColumns(firstSection.Page, 0.2f, 3);
firstSection.Columns.SetColumns(sectionColumnsLayout);

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/PageLayoutActions.cs#L34

SectionColumnCollection sectionColumnsLayout =
    firstSection.Columns.CreateUniformColumns(firstSection.Page, 0.2f, 3);
firstSection.Columns.SetColumns(sectionColumnsLayout);

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/PageLayout.cs#L34

SectionColumnCollection sectionColumnsLayout =
    firstSection.Columns.CreateUniformColumns(firstSection.Page, 0.2f, 3);
// Set different column width.

VB.NET

page-layout-simple-example-t553072/VB/PageLayout/Form1.vb#L66

' Create equal width column layout:
Dim sectionColumnsLayout As SectionColumnCollection = section.Columns.CreateUniformColumns(section.Page, Units.InchesToDocumentsF(0.2F), 3)

word-document-api-examples/VB/CodeExamples/PageLayoutActions.vb#L34

' Create columns and apply them to the document
Dim sectionColumnsLayout As DevExpress.XtraRichEdit.API.Native.SectionColumnCollection = firstSection.Columns.CreateUniformColumns(firstSection.Page, 0.2F, 3)
firstSection.Columns.SetColumns(sectionColumnsLayout)

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/PageLayoutActions.vb#L29

' Create columns and apply them to the document
Dim sectionColumnsLayout As SectionColumnCollection = firstSection.Columns.CreateUniformColumns(firstSection.Page, 0.2F, 3)
firstSection.Columns.SetColumns(sectionColumnsLayout)

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/PageLayout.vb#L31

' Create equal width column layout.
Dim sectionColumnsLayout As DevExpress.XtraRichEdit.API.Native.SectionColumnCollection = firstSection.Columns.CreateUniformColumns(firstSection.Page, 0.2F, 3)
' Set different column width.