Click or drag to resize

XlsChartPageSetup Class

Represents the page setup settings for a chart in an Excel document.
Inheritance Hierarchy

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

The XlsChartPageSetup type exposes the following members.

Properties
Name Description
Public property AlignWithMargins
Indicates whether align header footer margins with page margins.default is 1
(Inherited from XlsPageSetupBase .)
Public property AutoFirstPageNumber
Indicates whether FirstPageNumber is set to Auto or not.
(Inherited from XlsPageSetupBase .)
Public property BackgoundImage
Gets / sets background image.
(Inherited from XlsPageSetupBase .)
Public property BlackAndWhite
True if elements of the document will be printed in black and white. Read / write Boolean.
(Inherited from XlsPageSetupBase .)
Public property BottomMargin
Returns or sets the size of the bottom margin, in inches. Read / write Double.
(Inherited from XlsPageSetupBase .)
Public property CenterFooter
Returns or sets the center part of the footer. Read / write String.
(Inherited from XlsPageSetupBase .)
Public property CenterFooterImage
Gets / set image for center part of the footer.
(Inherited from XlsPageSetupBase .)
Public property CenterFooterPictureCropBottom
Gets or set crop bottom height of picture for center part of the footer,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property CenterFooterPictureCropLeft
Gets or set crop left width of picture for center part of the footer,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property CenterFooterPictureCropRight
Gets or set crop right width of picture for center part of the footer,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property CenterFooterPictureCropTop
Gets or set crop top height of picture for center part of the footer,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property CenterFooterPictureHeight
Gets or set height of picture for center part of the footer.
(Inherited from XlsPageSetupBase .)
Public property CenterFooterPictureWidth
Gets or set width of picture for center part of the footer.
(Inherited from XlsPageSetupBase .)
Public property CenterHeader
Returns or sets the center part of the header. Read / write String.
(Inherited from XlsPageSetupBase .)
Public property CenterHeaderImage
Gets / set image for center part of the header.
(Inherited from XlsPageSetupBase .)
Public property CenterHeaderPictureCropBottom
Gets or set crop bottom height of picture for center part of the header,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property CenterHeaderPictureCropLeft
Gets or set crop left width of picture for center part of the header,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property CenterHeaderPictureCropRight
Gets or set crop right width of picture for center part of the header,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property CenterHeaderPictureCropTop
Gets or set crop top height of picture for center part of the header,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property CenterHeaderPictureHeight
Gets or set height of picture for center part of the header.
(Inherited from XlsPageSetupBase .)
Public property CenterHeaderPictureWidth
Gets or set width of picture for center part of the header.
(Inherited from XlsPageSetupBase .)
Public property CenterHorizontally
True if the sheet is centered horizontally on the page when it is printed. Read / write Boolean.
(Inherited from XlsPageSetupBase .)
Public property CenterVertically
True if the sheet is centered vertically on the page when it is printed. Read / write Boolean.
(Inherited from XlsPageSetupBase .)
Public property Copies
Number of copies to print.
(Inherited from XlsPageSetupBase .)
Public property CustomPaperSizeName
Returns or sets the name of custom paper that is from printer.
(Inherited from XlsPageSetupBase .)
Public property DifferentFirst
Indicates whether different first page header and footer.default is 0
(Inherited from XlsPageSetupBase .)
Public property DifferentOddEven
Indicates whether different odd and even page headers and footers.default is 0
(Inherited from XlsPageSetupBase .)
Public property Draft
True if the sheet will be printed without graphics. Read / write Boolean.
(Inherited from XlsPageSetupBase .)
Public property EvenFooterString
Gets OddEven page footer string. Read only.
(Inherited from XlsPageSetupBase .)
Public property EvenHeaderString
Gets Even page header string. Read only.
(Inherited from XlsPageSetupBase .)
Public property FirstCenterFooterImage (Inherited from XlsPageSetupBase .)
Public property FirstCenterFooterPictureHeight (Inherited from XlsPageSetupBase .)
Public property FirstCenterFooterPictureWidth (Inherited from XlsPageSetupBase .)
Public property FirstCenterHeaderImage (Inherited from XlsPageSetupBase .)
Public property FirstCenterHeaderPictureHeight (Inherited from XlsPageSetupBase .)
Public property FirstCenterHeaderPictureWidth (Inherited from XlsPageSetupBase .)
Public property FirstFooterString
Gets first page footer string. Read only.
(Inherited from XlsPageSetupBase .)
Public property FirstHeaderString
Represents first page header string. Read only.
(Inherited from XlsPageSetupBase .)
Public property FirstLeftFooterImage (Inherited from XlsPageSetupBase .)
Public property FirstLeftFooterPictureHeight (Inherited from XlsPageSetupBase .)
Public property FirstLeftFooterPictureWidth (Inherited from XlsPageSetupBase .)
Public property FirstLeftHeaderImage (Inherited from XlsPageSetupBase .)
Public property FirstLeftHeaderPictureHeight (Inherited from XlsPageSetupBase .)
Public property FirstLeftHeaderPictureWidth (Inherited from XlsPageSetupBase .)
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.
(Inherited from XlsPageSetupBase .)
Public property FirstRightFooterImage (Inherited from XlsPageSetupBase .)
Public property FirstRightFooterPictureHeight (Inherited from XlsPageSetupBase .)
Public property FirstRightFooterPictureWidth (Inherited from XlsPageSetupBase .)
Public property FirstRightHeaderImage (Inherited from XlsPageSetupBase .)
Public property FirstRightHeaderPictureHeight (Inherited from XlsPageSetupBase .)
Public property FirstRightHeaderPictureWidth (Inherited from XlsPageSetupBase .)
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 Boolean.
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 Boolean.
Public property FooterMarginInch
Returns or sets the distance from the bottom of the page to the footer, in inches. Read / write Double.
(Inherited from XlsPageSetupBase .)
Public property FullFooterString
Gets footer full string. Read only.
(Inherited from XlsPageSetupBase .)
Public property FullHeaderString
Represents full header string. Read only.
(Inherited from XlsPageSetupBase .)
Public property HeaderMarginInch
Returns or sets the distance from the top of the page to the header, in inches. Read / write Double.
(Inherited from XlsPageSetupBase .)
Public property HResolution
Gets or sets horizontal resolution in dpi.
(Inherited from XlsPageSetupBase .)
Public property IsAutoPaperSize
Returns whether paper size is automatic. Read only.
(Inherited from XlsPageSetupBase .)
Public property IsSettingsNotValid
Indicates whether paper size, scaling factor, paper orientation (portrait / landscape), print resolution, and number of copies are not initialized.
(Inherited from XlsPageSetupBase .)
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.
(Inherited from XlsPageSetupBase .)
Public property LeftFooterImage
Gets / set image for left part of the footer.
(Inherited from XlsPageSetupBase .)
Public property LeftFooterPictureCropBottom
Gets or set crop bottom height of picture for left part of the footer,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property LeftFooterPictureCropLeft
Gets or set crop left width of picture for left part of the footer,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property LeftFooterPictureCropRight
Gets or set crop right width of picture for left part of the footer,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property LeftFooterPictureCropTop
Gets or set crop top height of picture for left part of the footer,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property LeftFooterPictureHeight
Gets or set height of picture for left part of the footer.
(Inherited from XlsPageSetupBase .)
Public property LeftFooterPictureWidth
Gets or set width of picture for left part of the footer.
(Inherited from XlsPageSetupBase .)
Public property LeftHeader
Returns or sets the left part of the header. Read / write String.
(Inherited from XlsPageSetupBase .)
Public property LeftHeaderImage
Gets / set image for left part of the header.
(Inherited from XlsPageSetupBase .)
Public property LeftHeaderPictureCropBottom
Gets or set crop bottom height of picture for left part of the header,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property LeftHeaderPictureCropLeft
Gets or set crop left width of picture for left part of the header,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property LeftHeaderPictureCropRight
Gets or set crop right width of picture for left part of the header,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property LeftHeaderPictureCropTop
Gets or set crop top height of picture for left part of the header,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property LeftHeaderPictureHeight
Gets or set height of picture for left part of the header.
(Inherited from XlsPageSetupBase .)
Public property LeftHeaderPictureWidth
Gets or set width of picture for left part of the header.
(Inherited from XlsPageSetupBase .)
Public property LeftMargin
Returns or sets the size of the left margin, in inches. Read / write Double.
(Inherited from XlsPageSetupBase .)
Public property OddFooterString
Gets Odd page footer string. Read only.
(Inherited from XlsPageSetupBase .)
Public property OddHeaderString
Gets Odd page header string. Read only.
(Inherited from XlsPageSetupBase .)
Public property ODSPageBackground
Returns ods page background. Read-only.
(Inherited from XlsPageSetupBase .)
Public property Order
Returns or sets the order that Microsoft Excel uses to number pages when printing a large worksheet. Read / write ExcelOrder.
(Inherited from XlsPageSetupBase .)
Public property Orientation
Portrait or landscape printing mode. Read / write ExcelPageOrientation.
(Inherited from XlsPageSetupBase .)
Public property PageHeight
Returns page width in points. Read-only.
(Inherited from XlsPageSetupBase .)
Public property PageWidth
Returns page width in points. Read-only.
(Inherited from XlsPageSetupBase .)
Public property PaperSize
Returns or sets the size of the paper. Read / write ExcelPaperSize.
(Inherited from XlsPageSetupBase .)
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.
(Inherited from XlsPageSetupBase .)
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.
(Inherited from XlsPageSetupBase .)
Public property PrinterSettings
Returns or sets the settings of the printer.
(Inherited from XlsPageSetupBase .)
Public property PrintNotes
True if cell notes are printed as end notes with the sheet. Applies only to worksheets. Read / write Boolean.
(Inherited from XlsPageSetupBase .)
Public property PrintQuality
Returns or sets the print quality. Read / write ushort.
(Inherited from XlsPageSetupBase .)
Public property RecordCode
Returns code of the biff storage. Read-only.
(Inherited from XlsPageSetupBase .)
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.
(Inherited from XlsPageSetupBase .)
Public property RightFooterImage
Gets / set image for right part of the footer.
(Inherited from XlsPageSetupBase .)
Public property RightFooterPictureCropBottom
Gets or set crop bottom height of picture for right part of the footer,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property RightFooterPictureCropLeft
Gets or set crop left width of picture for right part of the footer,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property RightFooterPictureCropRight
Gets or set crop right width of picture for right part of the footer,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property RightFooterPictureCropTop
Gets or set crop top height of picture for right part of the footer,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property RightFooterPictureHeight
Gets or set height of picture for right part of the footer.
(Inherited from XlsPageSetupBase .)
Public property RightFooterPictureWidth
Gets or set width of picture for right part of the footer.
(Inherited from XlsPageSetupBase .)
Public property RightHeader
Returns or sets the right part of the header. Read / write String.
(Inherited from XlsPageSetupBase .)
Public property RightHeaderImage
Gets / set image for right part of the header.
(Inherited from XlsPageSetupBase .)
Public property RightHeaderPictureCropBottom
Gets or set crop bottom height of picture for right part of the header,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property RightHeaderPictureCropLeft
Gets or set crop left width of picture for right part of the header,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property RightHeaderPictureCropRight
Gets or set crop right width of picture for right part of the header,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property RightHeaderPictureCropTop
Gets or set crop top height of picture for right part of the header,in unit of centimeters.
(Inherited from XlsPageSetupBase .)
Public property RightHeaderPictureHeight
Gets or set height of picture for right part of the header.
(Inherited from XlsPageSetupBase .)
Public property RightHeaderPictureWidth
Gets or set width of picture for right part of the header.
(Inherited from XlsPageSetupBase .)
Public property RightMargin
Returns or sets the size of the right margin, in inches. Read / write Double.
(Inherited from XlsPageSetupBase .)
Public property ScaleWithDoc
Indicates whether scale header and footer with document scaling.default is 1
(Inherited from XlsPageSetupBase .)
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.
(Inherited from XlsPageSetupBase .)
Public property TopMargin
Returns or sets the size of the top margin, in inches. Read / write Double.
(Inherited from XlsPageSetupBase .)
Public property VResolution
Gets or sets vertical resolution in dpi.
(Inherited from XlsPageSetupBase .)
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.
(Inherited from XlsPageSetupBase .)
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 Clone
Creates a deep copy of the XlsChartPageSetup object.
Public method Copy
Copies the settings from the source PageSetup to the current PageSetup.
(Inherited from XlsPageSetupBase .)
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.
(Inherited from XlsPageSetupBase .)
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.
(Inherited from XlsPageSetupBase .)
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
Protected field m_bIsDisposed
Flag which indicates if the object was disposed or not.
(Inherited from XlsObject .)
Top
See Also