API Reference

Class

SectionBuilder

Namespace OfficeIMO.Word.Fluent
Assembly OfficeIMO.Word

Builder for sections.

Inheritance

  • Object
  • SectionBuilder

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Methods

public SectionBuilder Background(String hex) #
Returns: SectionBuilder

Sets the document background color using a hex value.

Parameters

hex System.String requiredposition: 0
Hex color value.
public SectionBuilder Columns(Int32 count) #
Returns: SectionBuilder

Sets the number of columns for the section.

Parameters

count System.Int32 requiredposition: 0
Column count.
public SectionBuilder Margins(WordMargin margins) #
Returns: SectionBuilder

Sets the margins for the section.

Parameters

margins OfficeIMO.Word.WordMargin requiredposition: 0
Margin values.
New 2 overloads
public SectionBuilder New() #
Returns: SectionBuilder

Starts a new section on the next page.

public SectionBuilder New(WordSectionBreakType breakType) #
Returns: SectionBuilder

Starts a new section using the specified OfficeIMO break type.

Parameters

breakType OfficeIMO.Word.WordSectionBreakType requiredposition: 0
Section break type.
public SectionBuilder Orientation(OfficePageOrientation orientation) #
Returns: SectionBuilder

Sets the page orientation for the section.

Parameters

orientation OfficeIMO.OfficePageOrientation requiredposition: 0
Orientation value.
PageNumbering 2 overloads
public SectionBuilder PageNumbering(Boolean restart = false) #
Returns: SectionBuilder

Enables page numbering for the section.

Parameters

restart System.Boolean = false optionalposition: 0
Restart numbering at 1.
public SectionBuilder PageNumbering(WordNumberFormat format, Boolean restart = false) #
Returns: SectionBuilder

Enables page numbering with a specific number format.

Parameters

format OfficeIMO.Word.WordNumberFormat requiredposition: 0
Number format.
restart System.Boolean = false optionalposition: 1
Restart numbering at 1.
public SectionBuilder Paragraph(Action<WordParagraphBuilder> action) #
Returns: SectionBuilder

Adds a paragraph to the section.

Parameters

action System.Action{OfficeIMO.Word.Fluent.WordParagraphBuilder} requiredposition: 0
Configuration action for the paragraph.
public SectionBuilder Size(WordPageSize pageSize) #
Returns: SectionBuilder

Sets the page size for the section.

Parameters

pageSize OfficeIMO.Word.WordPageSize requiredposition: 0
Page size definition.
public SectionBuilder Table(Action<WordTableBuilder> action) #
Returns: SectionBuilder

Adds a table to the section.

Parameters

action System.Action{OfficeIMO.Word.Fluent.WordTableBuilder} requiredposition: 0
Configuration action for the table.

Properties

public WordSection Section { get; } #

Gets the section being configured.