Skip to main content
A newer version of this page is available. .

Sections

  • 4 minutes to read

The RichEditControl provides the following ways to manage document sections:

Sections in the User Interface

You can insert section breaks and set the page layout options using the Page Layout ribbon tab. Refer to the How to: Create a Simple Word Processor with a Ribbon UI topic for information on how to add a Ribbon UI to the RichEditControl.

XtraRichEdit_PageLayout_UI_Ribbon

The RichEditControl ships with the Page Setup Dialog. This dialog allows end-users to define a page’s formatting options of a whole document or a particular section.

Tip

Set the DocumentCapabilitiesOptions.Sections property to Hidden or Disabled to restrict end-users from managing certain document sections.

Divide a Document into Sections in Code

The Document.Sections property provides access to the document’s section collection. Use the following methods to insert a section in code:

Specify the Section.StartType property to define the section break’s type.

Note

The RichEditControl does not support column and continuous section breaks.

Execute one of the following commands to insert the specified section break:

Command Description
InsertSectionBreakEvenPageCommand Inserts a section break and starts a new section on the next even-numbered page.
InsertSectionBreakNextPageCommand Inserts a section break and starts a new section on the next page.
InsertSectionBreakOddPageCommand Inserts a section break and starts a new section on the next odd-numbered page.

Define Page Formatting Options

The RichEditControl provides the following commands to modify page formatting settings:

Command Description
SetModerateSectionPageMarginsCommand Sets the top and bottom margins at one inch and the lateral margins at .75 inches.
SetNarrowSectionPageMarginsCommand Sets all margins at half-an-inch.
SetNormalSectionPageMarginsCommand Sets all margins at one inch.
SetWideSectionPageMarginsCommand Sets vertical margins at one inch and side margins at two inches.
SetSectionOneColumnCommand Sets the section to have only one column.
SetSectionTwoColumnsCommand Sets the section to have two columns.
SetSectionThreeColumnsCommand Sets the section to have three columns.

Each section has page formatting options. You can use the SectionPage class properties to specify the page’s paper type, orientation, margins, etc. Use the Section.Page property to access theSectionPage object .

The code sample below specifies the first section’s page formatting options, sets the portrait orientation and the A3 Extra paper size.


Section firstSection =  richEditControl1.Document.Sections[0];
firstSection.Page.Landscape = false;
firstSection.Page.PaperKind = System.Drawing.Printing.PaperKind.A3Extra;

Line Numbering and Columns

Set the Section.LineNumbering property to a non-zero value to enable line numbering. Refer to the Line Numbering topic for more information.

Call the SectionColumns.CreateUniformColumns method to create a multi-column layout. Refer to the How to: Create a Three-Column Layout with Uniform Columns topic for more information.

Page Numbering

Each document section has its own page numbering settings (page number format, initial number, etc.). Use the Section.PageNumbering property to access the SectionPageNumbering class properties and specify section’s page numbering options. You should reset the numbering options by setting the SectionPageNumbering.ContinueNumbering property to false before you apply new options. The PAGE field represents a document’s page number. To apply new settings to existing page numbers, call the FieldCollection.Update method to update all fields.

The code sample below specifies the initial number and the NumberingFormat.CardinalText numbering format.


richEditControl1.Document.Sections[0].PageNumbering.ContinueNumbering = false;
 richEditControl1.Document.Sections[0].PageNumbering.FirstPageNumber = 3;
 richEditControl1.Document.Sections[0].PageNumbering.NumberingFormat = NumberingFormat.CardinalText;
 richEditControl1.Document.Fields.Update();

Headers and Footers

Each section Headers and footers in the document belong to a particular section. You can use the Section.BeginUpdateHeader - Section.EndUpdateHeader and the Section.BeginUpdateFooter - Section.EndUpdateHeader method pairs to edit header or footer content. Refer to the Headers and Footers topic for more information.

See Also