Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

RtfPageBorders

OfficeIMO.Rtf

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

Page border settings for a document or section.

Inheritance

  • object
  • RtfPageBorders

Usage

Explore 2 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.

Returned or exposed by 2

Constructors

public RtfPageBorders() #

Methods

public RtfPageBorder GetBorder(RtfPageBorderSide side) #

Returns the page border for the requested side.

Parameters

side OfficeIMO.Rtf.RtfPageBorderSide required
public RtfPageBorders SetDisplayOptions(RtfPageBorderScope? scope = null, bool? displayBehindText = null, RtfPageBorderOffset? offsetFrom = null) #

Sets page-border display options encoded by RTF \pgbrdropt.

Parameters

scope OfficeIMO.Rtf.RtfPageBorderScope? = null optional
displayBehindText bool? = null optional
offsetFrom OfficeIMO.Rtf.RtfPageBorderOffset? = null optional

Properties

public RtfPageBorder Top { get; private set; } #

Top page border.

public RtfPageBorder Bottom { get; private set; } #

Bottom page border.

public RtfPageBorder Left { get; private set; } #

Left page border.

public RtfPageBorder Right { get; private set; } #

Right page border.

public bool IncludeHeader { get; set; } #

Whether the page border surrounds the header area.

public bool IncludeFooter { get; set; } #

Whether the page border surrounds the footer area.

public bool SnapToPageBorder { get; set; } #

Whether page border edges should snap to page-border alignment.

public RtfPageBorderScope? Scope { get; set; } #

Page range to which the border applies.

public bool? DisplayBehindText { get; set; } #

Whether the page border is displayed behind document contents.

public RtfPageBorderOffset? OffsetFrom { get; set; } #

Source edge used for border spacing.

public bool HasAnyValue { get; } #

Whether any page-border setting is present.