API Reference
Class
RtfPageBorders
Page border settings for a document or section.
Inheritance
- Object
- RtfPageBorders
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method RtfPageBorders.SetDisplayOptions
- Property RtfPageSetup.PageBorders
Constructors
public RtfPageBorders() #Methods
public RtfPageBorder GetBorder(RtfPageBorderSide side) #Returns:
RtfPageBorderReturns the page border for the requested side.
Parameters
- side OfficeIMO.Rtf.RtfPageBorderSide
public RtfPageBorders SetDisplayOptions(Nullable<RtfPageBorderScope> scope = null, Nullable<Boolean> displayBehindText = null, Nullable<RtfPageBorderOffset> offsetFrom = null) #Returns:
RtfPageBordersSets page-border display options encoded by RTF \pgbrdropt.
Parameters
- scope System.Nullable{OfficeIMO.Rtf.RtfPageBorderScope} = null
- displayBehindText System.Nullable{System.Boolean} = null
- offsetFrom System.Nullable{OfficeIMO.Rtf.RtfPageBorderOffset} = null
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public RtfPageBorder Top { get; set; } #Top page border.
public RtfPageBorder Bottom { get; set; } #Bottom page border.
public RtfPageBorder Left { get; set; } #Left page border.
public RtfPageBorder Right { get; set; } #Right page border.
public Boolean IncludeHeader { get; set; } #Whether the page border surrounds the header area.
public Boolean SnapToPageBorder { get; set; } #Whether page border edges should snap to page-border alignment.
public Nullable<RtfPageBorderScope> Scope { get; set; } #Page range to which the border applies.
public Nullable<Boolean> DisplayBehindText { get; set; } #Whether the page border is displayed behind document contents.
public Nullable<RtfPageBorderOffset> OffsetFrom { get; set; } #Source edge used for border spacing.
public Boolean HasAnyValue { get; } #Whether any page-border setting is present.