Click or drag to resize

XlsPageSetupBase Class

Summary description for PageSetupBaseImpl.
Inheritance Hierarchy

Namespace: Spire.Xls.Core.Spreadsheet
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
public class XlsPageSetupBase : XlsObject, 
	IPageSetupBase, IExcelApplication

The XlsPageSetupBase type exposes the following members.

Properties
Name Description
Public property AlignWithMargins
Indicates whether align header footer margins with page margins.default is 1
Public property AutoFirstPageNumber
Indicates whether FirstPageNumber is set to Auto or not.
Public property BackgoundImage
Gets / sets background image.
Public property BlackAndWhite
True if elements of the document will be printed in black and white. Read / write Boolean.
Public property BottomMargin
Returns or sets the size of the bottom margin, in inches. Read / write Double.
Public property CenterFooter
Returns or sets the center part of the footer. Read / write String.
Public property CenterFooterImage
Gets / set image for center part of the footer.
Public property CenterFooterPictureCropBottom
Gets or set crop bottom height of picture for center part of the footer,in unit of centimeters.
Public property CenterFooterPictureCropLeft
Gets or set crop left width of picture for center part of the footer,in unit of centimeters.
Public property CenterFooterPictureCropRight
Gets or set crop right width of picture for center part of the footer,in unit of centimeters.
Public property CenterFooterPictureCropTop
Gets or set crop top height of picture for center part of the footer,in unit of centimeters.
Public property CenterFooterPictureHeight
Gets or set height of picture for center part of the footer.
Public property CenterFooterPictureWidth
Gets or set width of picture for center part of the footer.
Public property CenterHeader
Returns or sets the center part of the header. Read / write String.
Public property CenterHeaderImage
Gets / set image for center part of the header.
Public property CenterHeaderPictureCropBottom
Gets or set crop bottom height of picture for center part of the header,in unit of centimeters.
Public property CenterHeaderPictureCropLeft
Gets or set crop left width of picture for center part of the header,in unit of centimeters.
Public property CenterHeaderPictureCropRight
Gets or set crop right width of picture for center part of the header,in unit of centimeters.
Public property CenterHeaderPictureCropTop
Gets or set crop top height of picture for center part of the header,in unit of centimeters.
Public property CenterHeaderPictureHeight
Gets or set height of picture for center part of the header.
Public property CenterHeaderPictureWidth
Gets or set width of picture for center part of the header.
Public property CenterHorizontally
True if the sheet is centered horizontally on the page when it is printed. Read / write Boolean.
Public property CenterVertically
True if the sheet is centered vertically on the page when it is printed. Read / write Boolean.
Public property Copies
Number of copies to print.
Public property CustomPaperSizeName
Returns or sets the name of custom paper that is from printer.
Public property DifferentFirst
Indicates whether different first page header and footer.default is 0
Public property DifferentOddEven
Indicates whether different odd and even page headers and footers.default is 0
Public property Draft
True if the sheet will be printed without graphics. Read / write Boolean.
Public property EvenFooterString
Gets OddEven page footer string. Read only.
Public property EvenHeaderString
Gets Even page header string. Read only.
Public property FirstCenterFooterImage
Public property FirstCenterFooterPictureHeight
Public property FirstCenterFooterPictureWidth
Public property FirstCenterHeaderImage
Public property FirstCenterHeaderPictureHeight
Public property FirstCenterHeaderPictureWidth
Public property FirstFooterString
Gets first page footer string. Read only.
Public property FirstHeaderString
Represents first page header string. Read only.
Public property FirstLeftFooterImage
Public property FirstLeftFooterPictureHeight
Public property FirstLeftFooterPictureWidth
Public property FirstLeftHeaderImage
Public property FirstLeftHeaderPictureHeight
Public property FirstLeftHeaderPictureWidth
Public property FirstPageNumber
Returns or sets the first page number that will be used when this sheet is printed. If xlAutomatic, Microsoft Excel chooses the first page number. The default is xlAutomatic. Read / write Long.
Public property FirstRightFooterImage
Public property FirstRightFooterPictureHeight
Public property FirstRightFooterPictureWidth
Public property FirstRightHeaderImage
Public property FirstRightHeaderPictureHeight
Public property FirstRightHeaderPictureWidth
Public property FitToPagesTall
Returns or sets the number of pages tall the worksheet will be scaled to when it is printed. Applies only to worksheets. Read / write int.
Public property FitToPagesWide
Returns or sets the number of pages wide the worksheet will be scaled to when it is printed. Applies only to worksheets. Read / write int.
Public property FooterMarginInch
Returns or sets the distance from the bottom of the page to the footer, in inches. Read / write Double.
Public property FullFooterString
Gets footer full string. Read only.
Public property FullHeaderString
Represents full header string. Read only.
Public property HeaderMarginInch
Returns or sets the distance from the top of the page to the header, in inches. Read / write Double.
Public property HResolution
Gets or sets horizontal resolution in dpi.
Public property IsAutoPaperSize
Returns whether paper size is automatic. Read only.
Public property IsSettingsNotValid
Indicates whether paper size, scaling factor, paper orientation (portrait / landscape), print resolution, and number of copies are not initialized.
Public property LeftFooter
Returns or sets the left part of the footer. Read / write String. &L Left aligns the characters that follow. &C Centers the characters that follow. &R Right aligns the characters that follow. &E Turns double-underline printing on or off. &X Turns superscript printing on or off. &Y Turns subscript printing on or off. &B Turns bold printing on or off. &I Turns italic printing on or off. &U Turns underline printing on or off. &S Turns strikethrough printing on or off. &D Prints the current date. &T Prints the current time. &F Prints the name of the document. &A Prints the name of the workbook tab. &P Prints the page number. &P+number Prints the page number plus the specified number. &P-number Prints the page number minus the specified number. && Prints a single ampersand. & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. &N Prints the total number of pages in the document.
Public property LeftFooterImage
Gets / set image for left part of the footer.
Public property LeftFooterPictureCropBottom
Gets or set crop bottom height of picture for left part of the footer,in unit of centimeters.
Public property LeftFooterPictureCropLeft
Gets or set crop left width of picture for left part of the footer,in unit of centimeters.
Public property LeftFooterPictureCropRight
Gets or set crop right width of picture for left part of the footer,in unit of centimeters.
Public property LeftFooterPictureCropTop
Gets or set crop top height of picture for left part of the footer,in unit of centimeters.
Public property LeftFooterPictureHeight
Gets or set height of picture for left part of the footer.
Public property LeftFooterPictureWidth
Gets or set width of picture for left part of the footer.
Public property LeftHeader
Returns or sets the left part of the header. Read / write String.
Public property LeftHeaderImage
Gets / set image for left part of the header.
Public property LeftHeaderPictureCropBottom
Gets or set crop bottom height of picture for left part of the header,in unit of centimeters.
Public property LeftHeaderPictureCropLeft
Gets or set crop left width of picture for left part of the header,in unit of centimeters.
Public property LeftHeaderPictureCropRight
Gets or set crop right width of picture for left part of the header,in unit of centimeters.
Public property LeftHeaderPictureCropTop
Gets or set crop top height of picture for left part of the header,in unit of centimeters.
Public property LeftHeaderPictureHeight
Gets or set height of picture for left part of the header.
Public property LeftHeaderPictureWidth
Gets or set width of picture for left part of the header.
Public property LeftMargin
Returns or sets the size of the left margin, in inches. Read / write Double.
Public property OddFooterString
Gets Odd page footer string. Read only.
Public property OddHeaderString
Gets Odd page header string. Read only.
Public property ODSPageBackground
Returns ods page background. Read-only.
Public property Order
Returns or sets the order that Microsoft Excel uses to number pages when printing a large worksheet. Read / write ExcelOrder.
Public property Orientation
Portrait or landscape printing mode. Read / write ExcelPageOrientation.
Public property PageHeight
Returns page width in points. Read-only.
Public property PageWidth
Returns page width in points. Read-only.
Public property PaperSize
Returns or sets the size of the paper. Read / write ExcelPaperSize.
Public property Parent
Reference to Parent object. Read-only.
(Inherited from XlsObject .)
Public property PrintComments
Returns or sets the way comments are printed with the sheet. Read / write ExcelPrintLocation.
Public property PrintErrors
Sets or returns an ExcelPrintErrors constant specifying the type of print error displayed. This feature allows users to suppress the display of error values when printing a worksheet. Read / write.
Public property PrinterSettings
Returns or sets the settings of the printer.
Public property PrintNotes
True if cell notes are printed as end notes with the sheet. Applies only to worksheets. Read / write Boolean.
Public property PrintQuality
Returns or sets the print quality. Read / write ushort.
Public property RecordCode
Returns code of the biff storage. Read-only.
Protected property ReferenceCount
Get quantity of instance references.
(Inherited from XlsObject .)
Public property RightFooter
Returns or sets the right part of the footer. Read / write String.
Public property RightFooterImage
Gets / set image for right part of the footer.
Public property RightFooterPictureCropBottom
Gets or set crop bottom height of picture for right part of the footer,in unit of centimeters.
Public property RightFooterPictureCropLeft
Gets or set crop left width of picture for right part of the footer,in unit of centimeters.
Public property RightFooterPictureCropRight
Gets or set crop right width of picture for right part of the footer,in unit of centimeters.
Public property RightFooterPictureCropTop
Gets or set crop top height of picture for right part of the footer,in unit of centimeters.
Public property RightFooterPictureHeight
Gets or set height of picture for right part of the footer.
Public property RightFooterPictureWidth
Gets or set width of picture for right part of the footer.
Public property RightHeader
Returns or sets the right part of the header. Read / write String.
Public property RightHeaderImage
Gets / set image for right part of the header.
Public property RightHeaderPictureCropBottom
Gets or set crop bottom height of picture for right part of the header,in unit of centimeters.
Public property RightHeaderPictureCropLeft
Gets or set crop left width of picture for right part of the header,in unit of centimeters.
Public property RightHeaderPictureCropRight
Gets or set crop right width of picture for right part of the header,in unit of centimeters.
Public property RightHeaderPictureCropTop
Gets or set crop top height of picture for right part of the header,in unit of centimeters.
Public property RightHeaderPictureHeight
Gets or set height of picture for right part of the header.
Public property RightHeaderPictureWidth
Gets or set width of picture for right part of the header.
Public property RightMargin
Returns or sets the size of the right margin, in inches. Read / write Double.
Public property ScaleWithDoc
Indicates whether scale header and footer with document scaling.default is 1
Public property StreamPos Obsolete.
Indicates record position in stream. This is a utility member of class and is used only in the serialization process. Does not influence the data.
Public property TopMargin
Returns or sets the size of the top margin, in inches. Read / write Double.
Public property VResolution
Gets or sets vertical resolution in dpi.
Public property Zoom
Returns or sets a percentage (between 10 and 400 percent) by which Microsoft Excel will scale the worksheet for printing. Applies only to worksheets. Read / write ushort.
Top
Methods
Name Description
Protected method AddReference
Increase the quantity of reference. User must use this method when new wrapper on object is created or reference on object stored.
(Inherited from XlsObject .)
Protected method CheckDisposed
Checks whether object was disposed and throws exception if it was.
(Inherited from XlsObject .)
Public method Copy
Copies the settings from the source PageSetup to the current PageSetup.
Public method Dispose
Dispose object and free resources.
(Inherited from XlsObject .)
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Protected method Finalize
Destructor. Call dispose method of current object.
(Inherited from XlsObject .)
Protected method FindParent(Type)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParent( Type )
Find parent of object.
(Inherited from XlsObject .)
Protected method FindParent(Type, Boolean)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParents
Finds parent objects.
(Inherited from XlsObject .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetStoreSize Obsolete.
Size of the required storage space. Read-only.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method OnDispose
Method which can be overriden by users to take any specific actions when object is disposed.
(Inherited from XlsObject .)
Protected method ReleaseReference
Decrease quantity of Reference. User must call this method when freeing resources.
(Inherited from XlsObject .)
Public method SetCustomPaperSize
Sets the custom paper size. Unit mm.
Protected method SetParent
Sets parent of the object.
(Inherited from XlsObject .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Top
Fields
Name Description
Public field Static member DEFAULT_BOTTOM_MARGIN
Value of the bottom margin by default.
Public field Static member DEFAULT_LEFT_MARGIN
Value of the left margin by default.
Public field Static member DEFAULT_RIGHT_MARGIN
Value of the right margin by default.
Public field Static member DEFAULT_TOP_MARGIN
Value of the top margin by default.
Protected field m_bIsDisposed
Flag which indicates if the object was disposed or not.
(Inherited from XlsObject .)
Top
See Also