Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

RtfSection

OfficeIMO.Rtf

Namespace
OfficeIMO.Rtf
Assembly
OfficeIMO.Rtf
Source revision
ba882f6b0d07 with working tree changes
Implements
IRtfCloneable
Modifiers
sealed

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

Inheritance

  • object
  • RtfSection

Usage

Explore 7 API references to this type

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

Accepted by parameters 2

Methods

public RtfSectionColumn AddColumn(int? widthTwips = null, int? spaceAfterTwips = null) #

Adds an unequal section column definition.

Parameters

widthTwips int? = null optional
spaceAfterTwips int? = null optional
public RtfHeaderFooter AddFooter(RtfHeaderFooterKind kind = Footer) #

Adds a footer to this section.

Parameters

kind OfficeIMO.Rtf.RtfHeaderFooterKind = Footer optional
public RtfHeaderFooter AddHeader(RtfHeaderFooterKind kind = Header) #

Adds a header to this section.

Parameters

kind OfficeIMO.Rtf.RtfHeaderFooterKind = Header optional
public RtfHeaderFooter AddHeaderFooter(RtfHeaderFooterKind kind) #

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

Parameters

kind OfficeIMO.Rtf.RtfHeaderFooterKind required
public RtfImage AddImage(RtfImageFormat format, byte[] data) #

Adds a picture block to the section.

Parameters

format OfficeIMO.Rtf.RtfImageFormat required
data byte[] required

Returns

RtfImage
public RtfParagraph AddParagraph(string? text = null) #

Adds a paragraph to the section.

Parameters

text string? = null optional
public RtfTable AddTable(int rows, int columns) #

Adds a table block to the section.

Parameters

rows int required
columns int required

Returns

RtfTable
public RtfSection ClearColumns() #

Clears unequal section column definitions.

Returns

RtfSection
public RtfSection SetDirection(RtfTextDirection? direction) #

Sets the section text direction.

Parameters

direction OfficeIMO.Rtf.RtfTextDirection? required

Returns

RtfSection
public RtfSection SetVerticalAlignment(RtfSectionVerticalAlignment? alignment) #

Sets vertical text alignment for pages in the section.

Parameters

alignment OfficeIMO.Rtf.RtfSectionVerticalAlignment? required

Returns

RtfSection

Properties

public IReadOnlyList<IRtfBlock> Blocks { get; } #

Ordered blocks contained by the section.

public RtfPageSetup PageSetup { get; private set; } #

Section page size, margins, and orientation.

public RtfNoteSettings NoteSettings { get; private set; } #

Section-level footnote and endnote numbering settings.

public RtfSectionBreakKind BreakKind { get; set; } #

Section break behavior.

public int? ColumnCount { get; set; } #

Number of text columns in the section.

public int? ColumnSpaceTwips { get; set; } #

Space between section columns in twips.

public bool 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; private set; } #

Section line-numbering settings.

public RtfSectionVerticalAlignment? VerticalAlignment { get; set; } #

Vertical text alignment for pages in the section.

public 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.