API Reference
RtfPageSetup
Page size and margin settings for an RTF document.
Inheritance
- Object
- RtfPageSetup
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 RtfDocument.GetEffectivePageSetup
- Property RtfDocument.PageSetup
- Method RtfPageSetup.SetDifferentFirstPageHeaderFooter
- Method RtfPageSetup.SetGutter
- Method RtfPageSetup.SetHeaderFooterDistance
- Method RtfPageSetup.SetLandscape
- Method RtfPageSetup.SetMargins
- Method RtfPageSetup.SetPageNumbering
- Method RtfPageSetup.SetPaperSize
- Method RtfPageSetup.SetPrinterPaper
- Property RtfSection.PageSetup
Constructors
public RtfPageSetup() #Methods
public RtfPageSetup SetGutter(Nullable<Int32> gutterWidthTwips = null, Boolean rtlGutter = false) #RtfPageSetupSets gutter width in twips.
Parameters
- gutterWidthTwips System.Nullable{System.Int32} = null
- rtlGutter System.Boolean = false
public RtfPageSetup SetLandscape(Boolean landscape = true) #RtfPageSetupSets whether landscape orientation should be emitted.
Parameters
- landscape System.Boolean = true
public RtfPageSetup SetMargins(Nullable<Int32> leftTwips = null, Nullable<Int32> rightTwips = null, Nullable<Int32> topTwips = null, Nullable<Int32> bottomTwips = null) #RtfPageSetupSets document margins in twips.
Parameters
- leftTwips System.Nullable{System.Int32} = null
- rightTwips System.Nullable{System.Int32} = null
- topTwips System.Nullable{System.Int32} = null
- bottomTwips System.Nullable{System.Int32} = null
public RtfPageSetup SetPageNumbering(Nullable<Int32> start = null, Nullable<Boolean> restart = null, Nullable<RtfPageNumberFormat> format = null, Nullable<Int32> positionXTwips = null, Nullable<Int32> positionYTwips = null) #RtfPageSetupSets page numbering controls.
Parameters
- start System.Nullable{System.Int32} = null
- restart System.Nullable{System.Boolean} = null
- format System.Nullable{OfficeIMO.Rtf.RtfPageNumberFormat} = null
- positionXTwips System.Nullable{System.Int32} = null
- positionYTwips System.Nullable{System.Int32} = null
public RtfPageSetup SetPaperSize(Int32 widthTwips, Int32 heightTwips) #RtfPageSetupSets paper size in twips.
Parameters
- widthTwips System.Int32
- heightTwips System.Int32
public RtfPageSetup SetPrinterPaper(Nullable<Int32> paperSize = null, Nullable<Int32> firstPageSource = null, Nullable<Int32> otherPagesSource = null) #RtfPageSetupSets printer-specific paper metadata.
Parameters
- paperSize System.Nullable{System.Int32} = null
- firstPageSource System.Nullable{System.Int32} = null
- otherPagesSource System.Nullable{System.Int32} = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public Nullable<Int32> PaperWidthTwips { get; set; } #Paper width in twips.
public Nullable<Int32> PaperHeightTwips { get; set; } #Paper height in twips.
public Nullable<Int32> PrinterPaperSize { get; set; } #Printer paper size code represented by \psz.
public Nullable<Int32> FirstPagePaperSource { get; set; } #Printer bin source for the first page represented by \binfsxn.
public Nullable<Int32> OtherPagesPaperSource { get; set; } #Printer bin source for subsequent pages represented by \binsxn.
public Nullable<Int32> MarginLeftTwips { get; set; } #Left margin in twips.
public Nullable<Int32> MarginRightTwips { get; set; } #Right margin in twips.
public Nullable<Int32> MarginTopTwips { get; set; } #Top margin in twips.
public Nullable<Int32> MarginBottomTwips { get; set; } #Bottom margin in twips.
public Nullable<Int32> GutterWidthTwips { get; set; } #Gutter width in twips.
public Nullable<Int32> HeaderDistanceTwips { get; set; } #Header distance from the top edge of the page in twips.
public Nullable<Int32> PageNumberStart { get; set; } #Beginning page number.
public Nullable<Boolean> PageNumberRestart { get; set; } #Whether page numbering restarts in this page setup. false represents continuous numbering.
public Nullable<Int32> PageNumberPositionXTwips { get; set; } #Horizontal page-number position in twips from the right margin.
public Nullable<Int32> PageNumberPositionYTwips { get; set; } #Vertical page-number position in twips from the top margin.
public Nullable<RtfPageNumberFormat> PageNumberFormat { get; set; } #Page-number display format.
public RtfPageBorders PageBorders { get; set; } #Page border settings.
public Boolean Landscape { get; set; } #Whether the document declares landscape orientation.
public Nullable<Boolean> DirectLandscape { get; set; } #Authored orientation. Null inherits the document's orientation; false explicitly selects portrait.
public Boolean RtlGutter { get; set; } #Whether the gutter should be positioned on the right side.
public Nullable<Boolean> DirectRtlGutter { get; set; } #Authored gutter direction. Null inherits the document setting.