Table of Contents

Class XlsPageSetupBase

Namespace
Spire.Xls.Core.Spreadsheet
Assembly
Spire.XLS.dll
public class XlsPageSetupBase : XlsObject, IDisposable, IPageSetupBase, IExcelApplication
Inheritance
XlsPageSetupBase
Implements
Derived
Inherited Members

Fields

DEFAULT_BOTTOM_MARGIN 

public const double DEFAULT_BOTTOM_MARGIN = 1

Field Value

double

DEFAULT_LEFT_MARGIN 

public const double DEFAULT_LEFT_MARGIN = 0.75

Field Value

double

DEFAULT_RIGHT_MARGIN 

public const double DEFAULT_RIGHT_MARGIN = 0.75

Field Value

double

DEFAULT_TOP_MARGIN 

public const double DEFAULT_TOP_MARGIN = 1

Field Value

double

Properties

AlignWithMargins

Indicates whether align header footer margins with page margins.default is 1

public byte AlignWithMargins { get; set; }

Property Value

byte

AutoFirstPageNumber 

public bool AutoFirstPageNumber { get; set; }

Property Value

bool

BackgoundImage 

public SKBitmap BackgoundImage { get; set; }

Property Value

SKBitmap

BlackAndWhite 

public bool BlackAndWhite { get; set; }

Property Value

bool

BottomMargin 

public double BottomMargin { get; set; }

Property Value

double

CenterFooter 

public string CenterFooter { get; set; }

Property Value

string

CenterFooterImage 

public SKBitmap CenterFooterImage { get; set; }

Property Value

SKBitmap

CenterFooterPictureCropBottom

Gets or set crop bottom height of picture for center part of the footer,in unit of centimeters.

public double CenterFooterPictureCropBottom { get; set; }

Property Value

double

CenterFooterPictureCropLeft

Gets or set crop left width of picture for center part of the footer,in unit of centimeters.

public double CenterFooterPictureCropLeft { get; set; }

Property Value

double

CenterFooterPictureCropRight

Gets or set crop right width of picture for center part of the footer,in unit of centimeters.

public double CenterFooterPictureCropRight { get; set; }

Property Value

double

CenterFooterPictureCropTop

Gets or set crop top height of picture for center part of the footer,in unit of centimeters.

public double CenterFooterPictureCropTop { get; set; }

Property Value

double

CenterFooterPictureHeight

Gets or set height of picture for center part of the footer.

public int CenterFooterPictureHeight { get; set; }

Property Value

int

CenterFooterPictureWidth

Gets or set width of picture for center part of the footer.

public int CenterFooterPictureWidth { get; set; }

Property Value

int

CenterHeader 

public string CenterHeader { get; set; }

Property Value

string

CenterHeaderImage 

public SKBitmap CenterHeaderImage { get; set; }

Property Value

SKBitmap

CenterHeaderPictureCropBottom

Gets or set crop bottom height of picture for center part of the header,in unit of centimeters.

public double CenterHeaderPictureCropBottom { get; set; }

Property Value

double

CenterHeaderPictureCropLeft

Gets or set crop left width of picture for center part of the header,in unit of centimeters.

public double CenterHeaderPictureCropLeft { get; set; }

Property Value

double

CenterHeaderPictureCropRight

Gets or set crop right width of picture for center part of the header,in unit of centimeters.

public double CenterHeaderPictureCropRight { get; set; }

Property Value

double

CenterHeaderPictureCropTop

Gets or set crop top height of picture for center part of the header,in unit of centimeters.

public double CenterHeaderPictureCropTop { get; set; }

Property Value

double

CenterHeaderPictureHeight

Gets or set height of picture for center part of the header.

public int CenterHeaderPictureHeight { get; set; }

Property Value

int

CenterHeaderPictureWidth

Gets or set width of picture for center part of the header.

public int CenterHeaderPictureWidth { get; set; }

Property Value

int

CenterHorizontally 

public bool CenterHorizontally { get; set; }

Property Value

bool

CenterVertically 

public bool CenterVertically { get; set; }

Property Value

bool

Copies 

public int Copies { get; set; }

Property Value

int

DifferentFirst

Indicates whether different first page header and footer.default is 0

public byte DifferentFirst { get; set; }

Property Value

byte

DifferentOddEven

Indicates whether different odd and even page headers and footers.default is 0

public byte DifferentOddEven { get; set; }

Property Value

byte

Draft 

public bool Draft { get; set; }

Property Value

bool

EvenFooterString

Gets OddEven page footer string. Read only.

public string EvenFooterString { get; set; }

Property Value

string

EvenHeaderString

Gets Even page header string. Read only.

public string EvenHeaderString { get; set; }

Property Value

string

FirstFooterString

Gets first page footer string. Read only.

public string FirstFooterString { get; set; }

Property Value

string

FirstHeaderString

Represents first page header string. Read only.

public string FirstHeaderString { get; set; }

Property Value

string

FirstPageNumber 

public int FirstPageNumber { get; set; }

Property Value

int

FitToPagesTall 

public int FitToPagesTall { get; set; }

Property Value

int

FitToPagesWide 

public int FitToPagesWide { get; set; }

Property Value

int

FooterMarginInch 

public double FooterMarginInch { get; set; }

Property Value

double

FullFooterString

Gets footer full string. Read only.

public string FullFooterString { get; set; }

Property Value

string

FullHeaderString

Represents full header string. Read only.

public string FullHeaderString { get; set; }

Property Value

string

HResolution

Gets or sets horizontal resolution in dpi.

public int HResolution { get; set; }

Property Value

int

HeaderMarginInch 

public double HeaderMarginInch { get; set; }

Property Value

double

IsAutoPaperSize

Returns whether paper size is automatic. Read only.

public bool IsAutoPaperSize { get; }

Property Value

bool

IsSettingsNotValid 

public bool IsSettingsNotValid { get; set; }

Property Value

bool

LeftFooter 

public string LeftFooter { get; set; }

Property Value

string

LeftFooterImage 

public SKBitmap LeftFooterImage { get; set; }

Property Value

SKBitmap

LeftFooterPictureCropBottom

Gets or set crop bottom height of picture for left part of the footer,in unit of centimeters.

public double LeftFooterPictureCropBottom { get; set; }

Property Value

double

LeftFooterPictureCropLeft

Gets or set crop left width of picture for left part of the footer,in unit of centimeters.

public double LeftFooterPictureCropLeft { get; set; }

Property Value

double

LeftFooterPictureCropRight

Gets or set crop right width of picture for left part of the footer,in unit of centimeters.

public double LeftFooterPictureCropRight { get; set; }

Property Value

double

LeftFooterPictureCropTop

Gets or set crop top height of picture for left part of the footer,in unit of centimeters.

public double LeftFooterPictureCropTop { get; set; }

Property Value

double

LeftFooterPictureHeight

Gets or set height of picture for left part of the footer.

public int LeftFooterPictureHeight { get; set; }

Property Value

int

LeftFooterPictureWidth 

public int LeftFooterPictureWidth { get; set; }

Property Value

int

LeftHeader 

public string LeftHeader { get; set; }

Property Value

string

LeftHeaderImage 

public SKBitmap LeftHeaderImage { get; set; }

Property Value

SKBitmap

LeftHeaderPictureCropBottom

Gets or set crop bottom height of picture for left part of the header,in unit of centimeters.

public double LeftHeaderPictureCropBottom { get; set; }

Property Value

double

LeftHeaderPictureCropLeft

Gets or set crop left width of picture for left part of the header,in unit of centimeters.

public double LeftHeaderPictureCropLeft { get; set; }

Property Value

double

LeftHeaderPictureCropRight

Gets or set crop right width of picture for left part of the header,in unit of centimeters.

public double LeftHeaderPictureCropRight { get; set; }

Property Value

double

LeftHeaderPictureCropTop

Gets or set crop top height of picture for left part of the header,in unit of centimeters.

public double LeftHeaderPictureCropTop { get; set; }

Property Value

double

LeftHeaderPictureHeight

Gets or set height of picture for left part of the header.

public int LeftHeaderPictureHeight { get; set; }

Property Value

int

LeftHeaderPictureWidth

Gets or set width of picture for left part of the header.

public int LeftHeaderPictureWidth { get; set; }

Property Value

int

LeftMargin 

public double LeftMargin { get; set; }

Property Value

double

ODSPageBackground

Returns ods page background. Read-only.

public OdsPageBackground ODSPageBackground { get; }

Property Value

OdsPageBackground

OddFooterString

Gets Odd page footer string. Read only.

public string OddFooterString { get; set; }

Property Value

string

OddHeaderString

Gets Odd page header string. Read only.

public string OddHeaderString { get; set; }

Property Value

string

Order 

public OrderType Order { get; set; }

Property Value

OrderType

Orientation 

public PageOrientationType Orientation { get; set; }

Property Value

PageOrientationType

PageHeight

Returns page width in points. Read-only.

public double PageHeight { get; }

Property Value

double

PageWidth

Returns page width in points. Read-only.

public double PageWidth { get; }

Property Value

double

PaperSize 

public PaperSizeType PaperSize { get; set; }

Property Value

PaperSizeType

PrintComments 

public PrintCommentType PrintComments { get; set; }

Property Value

PrintCommentType

PrintErrors 

public PrintErrorsType PrintErrors { get; set; }

Property Value

PrintErrorsType

PrintNotes 

public bool PrintNotes { get; set; }

Property Value

bool

PrintQuality 

public int PrintQuality { get; set; }

Property Value

int

PrinterSettings 

public byte[] PrinterSettings { get; set; }

Property Value

byte[]

RecordCode 

public int RecordCode { get; }

Property Value

int

RightFooter 

public string RightFooter { get; set; }

Property Value

string

RightFooterImage 

public SKBitmap RightFooterImage { get; set; }

Property Value

SKBitmap

RightFooterPictureCropBottom

Gets or set crop bottom height of picture for right part of the footer,in unit of centimeters.

public double RightFooterPictureCropBottom { get; set; }

Property Value

double

RightFooterPictureCropLeft

Gets or set crop left width of picture for right part of the footer,in unit of centimeters.

public double RightFooterPictureCropLeft { get; set; }

Property Value

double

RightFooterPictureCropRight

Gets or set crop right width of picture for right part of the footer,in unit of centimeters.

public double RightFooterPictureCropRight { get; set; }

Property Value

double

RightFooterPictureCropTop

Gets or set crop top height of picture for right part of the footer,in unit of centimeters.

public double RightFooterPictureCropTop { get; set; }

Property Value

double

RightFooterPictureHeight

Gets or set height of picture for right part of the footer.

public int RightFooterPictureHeight { get; set; }

Property Value

int

RightFooterPictureWidth

Gets or set width of picture for right part of the footer.

public int RightFooterPictureWidth { get; set; }

Property Value

int

RightHeader 

public string RightHeader { get; set; }

Property Value

string

RightHeaderImage 

public SKBitmap RightHeaderImage { get; set; }

Property Value

SKBitmap

RightHeaderPictureCropBottom

Gets or set crop bottom height of picture for right part of the header,in unit of centimeters.

public double RightHeaderPictureCropBottom { get; set; }

Property Value

double

RightHeaderPictureCropLeft

Gets or set crop left width of picture for right part of the header,in unit of centimeters.

public double RightHeaderPictureCropLeft { get; set; }

Property Value

double

RightHeaderPictureCropRight

Gets or set crop right width of picture for right part of the header,in unit of centimeters.

public double RightHeaderPictureCropRight { get; set; }

Property Value

double

RightHeaderPictureCropTop

Gets or set crop top height of picture for right part of the header,in unit of centimeters.

public double RightHeaderPictureCropTop { get; set; }

Property Value

double

RightHeaderPictureHeight

Gets or set height of picture for right part of the header.

public int RightHeaderPictureHeight { get; set; }

Property Value

int

RightHeaderPictureWidth

Gets or set width of picture for right part of the header.

public int RightHeaderPictureWidth { get; set; }

Property Value

int

RightMargin 

public double RightMargin { get; set; }

Property Value

double

ScaleWithDoc

Indicates whether scale header and footer with document scaling.default is 1

public byte ScaleWithDoc { get; set; }

Property Value

byte

StreamPos 

[Obsolete("get and set not implemented")]
public long StreamPos { get; set; }

Property Value

long

TopMargin 

public double TopMargin { get; set; }

Property Value

double

VResolution

Gets or sets vertical resolution in dpi.

public int VResolution { get; set; }

Property Value

int

Zoom 

public int Zoom { get; set; }

Property Value

int

Methods

Copy(PageSetup) 

public void Copy(PageSetup source)

Parameters

source PageSetup

GetStoreSize(ExcelVersion) 

[Obsolete("the method is not implemented")]
public virtual int GetStoreSize(ExcelVersion version)

Parameters

version ExcelVersion

Returns

int