Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

RtfSection

Namespace OfficeIMO.Rtf
Assembly OfficeIMO.Rtf
Implements
IRtfCloneable
Modifiers sealed

Semantic RTF section containing ordered document blocks and section-level page layout.

Inheritance

  • Object
  • RtfSection

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 RtfSectionColumn AddColumn(Nullable<Int32> widthTwips = null, Nullable<Int32> spaceAfterTwips = null) #
Returns: RtfSectionColumn

Adds an unequal section column definition.

Parameters

widthTwips System.Nullable{System.Int32} = null optionalposition: 0
spaceAfterTwips System.Nullable{System.Int32} = null optionalposition: 1
public RtfHeaderFooter AddFooter(RtfHeaderFooterKind kind = Footer) #
Returns: RtfHeaderFooter

Adds a footer to this section.

Parameters

kind OfficeIMO.Rtf.RtfHeaderFooterKind = Footer optionalposition: 0
public RtfHeaderFooter AddHeader(RtfHeaderFooterKind kind = Header) #
Returns: RtfHeaderFooter

Adds a header to this section.

Parameters

kind OfficeIMO.Rtf.RtfHeaderFooterKind = Header optionalposition: 0
public RtfHeaderFooter AddHeaderFooter(RtfHeaderFooterKind kind) #
Returns: RtfHeaderFooter

Adds an explicit section header or footer. An empty destination clears inherited content for that kind.

Parameters

kind OfficeIMO.Rtf.RtfHeaderFooterKind requiredposition: 0
public RtfImage AddImage(RtfImageFormat format, Byte[] data) #
Returns: RtfImage

Adds a picture block to the section.

Parameters

format OfficeIMO.Rtf.RtfImageFormat requiredposition: 0
data System.Byte[] requiredposition: 1
public RtfParagraph AddParagraph(String text = null) #
Returns: RtfParagraph

Adds a paragraph to the section.

Parameters

text System.String = null optionalposition: 0
public RtfTable AddTable(Int32 rows, Int32 columns) #
Returns: RtfTable

Adds a table block to the section.

Parameters

rows System.Int32 requiredposition: 0
columns System.Int32 requiredposition: 1
public RtfSection ClearColumns() #
Returns: RtfSection

Clears unequal section column definitions.

public RtfSection SetDirection(Nullable<RtfTextDirection> direction) #
Returns: RtfSection

Sets the section text direction.

Parameters

direction System.Nullable{OfficeIMO.Rtf.RtfTextDirection} requiredposition: 0
public RtfSection SetVerticalAlignment(Nullable<RtfSectionVerticalAlignment> alignment) #
Returns: RtfSection

Sets vertical text alignment for pages in the section.

Parameters

alignment System.Nullable{OfficeIMO.Rtf.RtfSectionVerticalAlignment} requiredposition: 0

Properties

public IReadOnlyList<IRtfBlock> Blocks { get; } #

Ordered blocks contained by the section.

public RtfPageSetup PageSetup { get; set; } #

Section page size, margins, and orientation.

public RtfNoteSettings NoteSettings { get; set; } #

Section-level footnote and endnote numbering settings.

public RtfSectionBreakKind BreakKind { get; set; } #

Section break behavior.

public Nullable<Int32> ColumnCount { get; set; } #

Number of text columns in the section.

public Nullable<Int32> ColumnSpaceTwips { get; set; } #

Space between section columns in twips.

public Boolean ColumnSeparator { get; set; } #

Whether a vertical separator line is shown between columns.

public IReadOnlyList<RtfSectionColumn> Columns { get; } #

Unequal section column definitions in section order.

public RtfLineNumbering LineNumbering { get; set; } #

Section line-numbering settings.

public Nullable<RtfSectionVerticalAlignment> VerticalAlignment { get; set; } #

Vertical text alignment for pages in the section.

public Nullable<RtfTextDirection> Direction { get; set; } #

Section text direction represented by \ltrsect or \rtlsect.

public IReadOnlyList<RtfHeaderFooter> HeaderFooters { get; } #

Headers and footers explicitly declared by this section. Missing kinds inherit from preceding sections.