XlsPageSetupBase Class |
Namespace: Spire.Xls.Core.Spreadsheet
The XlsPageSetupBase type exposes the following members.
| Name | Description | |
|---|---|---|
|
|
AlignWithMargins |
Indicates whether align header footer margins with page margins.default is 1
|
|
|
AutoFirstPageNumber |
Indicates whether FirstPageNumber is set to Auto or not.
|
|
|
BackgoundImage |
Gets / sets background image.
|
|
|
BlackAndWhite |
True if elements of the document will be printed in black and white.
Read / write Boolean.
|
|
|
BottomMargin |
Returns or sets the size of the bottom margin, in inches.
Read / write Double.
|
|
|
CenterFooter |
Returns or sets the center part of the footer. Read / write String.
|
|
|
CenterFooterImage |
Gets / set image for center part of the footer.
|
|
|
CenterFooterPictureCropBottom |
Gets or set crop bottom height of picture for center part of the footer,in unit of centimeters.
|
|
|
CenterFooterPictureCropLeft |
Gets or set crop left width of picture for center part of the footer,in unit of centimeters.
|
|
|
CenterFooterPictureCropRight |
Gets or set crop right width of picture for center part of the footer,in unit of centimeters.
|
|
|
CenterFooterPictureCropTop |
Gets or set crop top height of picture for center part of the footer,in unit of centimeters.
|
|
|
CenterFooterPictureHeight |
Gets or set height of picture for center part of the footer.
|
|
|
CenterFooterPictureWidth |
Gets or set width of picture for center part of the footer.
|
|
|
CenterHeader |
Returns or sets the center part of the header. Read / write String.
|
|
|
CenterHeaderImage |
Gets / set image for center part of the header.
|
|
|
CenterHeaderPictureCropBottom |
Gets or set crop bottom height of picture for center part of the header,in unit of centimeters.
|
|
|
CenterHeaderPictureCropLeft |
Gets or set crop left width of picture for center part of the header,in unit of centimeters.
|
|
|
CenterHeaderPictureCropRight |
Gets or set crop right width of picture for center part of the header,in unit of centimeters.
|
|
|
CenterHeaderPictureCropTop |
Gets or set crop top height of picture for center part of the header,in unit of centimeters.
|
|
|
CenterHeaderPictureHeight |
Gets or set height of picture for center part of the header.
|
|
|
CenterHeaderPictureWidth |
Gets or set width of picture for center part of the header.
|
|
|
CenterHorizontally |
True if the sheet is centered horizontally on the page when it is
printed. Read / write Boolean.
|
|
|
CenterVertically |
True if the sheet is centered vertically on the page when it is
printed. Read / write Boolean.
|
|
|
Copies |
Number of copies to print.
|
|
|
CustomPaperSizeName |
Returns or sets the name of custom paper that is from printer.
|
|
|
DifferentFirst |
Indicates whether different first page header and footer.default is 0
|
|
|
DifferentOddEven |
Indicates whether different odd and even page headers and footers.default is 0
|
|
|
Draft |
True if the sheet will be printed without graphics.
Read / write Boolean.
|
|
|
EvenFooterString |
Gets OddEven page footer string. Read only.
|
|
|
EvenHeaderString |
Gets Even page header string. Read only.
|
|
|
FirstCenterFooterImage | |
|
|
FirstCenterFooterPictureHeight | |
|
|
FirstCenterFooterPictureWidth | |
|
|
FirstCenterHeaderImage | |
|
|
FirstCenterHeaderPictureHeight | |
|
|
FirstCenterHeaderPictureWidth | |
|
|
FirstFooterString |
Gets first page footer string. Read only.
|
|
|
FirstHeaderString |
Represents first page header string. Read only.
|
|
|
FirstLeftFooterImage | |
|
|
FirstLeftFooterPictureHeight | |
|
|
FirstLeftFooterPictureWidth | |
|
|
FirstLeftHeaderImage | |
|
|
FirstLeftHeaderPictureHeight | |
|
|
FirstLeftHeaderPictureWidth | |
|
|
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.
|
|
|
FirstRightFooterImage | |
|
|
FirstRightFooterPictureHeight | |
|
|
FirstRightFooterPictureWidth | |
|
|
FirstRightHeaderImage | |
|
|
FirstRightHeaderPictureHeight | |
|
|
FirstRightHeaderPictureWidth | |
|
|
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.
|
|
|
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.
|
|
|
FooterMarginInch |
Returns or sets the distance from the bottom of the page to the footer,
in inches. Read / write Double.
|
|
|
FullFooterString |
Gets footer full string. Read only.
|
|
|
FullHeaderString |
Represents full header string. Read only.
|
|
|
HeaderMarginInch |
Returns or sets the distance from the top of the page to the header,
in inches. Read / write Double.
|
|
|
HResolution |
Gets or sets horizontal resolution in dpi.
|
|
|
IsAutoPaperSize |
Returns whether paper size is automatic. Read only.
|
|
|
IsSettingsNotValid |
Indicates whether paper size, scaling factor, paper orientation (portrait / landscape),
print resolution, and number of copies are not initialized.
|
|
|
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.
|
|
|
LeftFooterImage |
Gets / set image for left part of the footer.
|
|
|
LeftFooterPictureCropBottom |
Gets or set crop bottom height of picture for left part of the footer,in unit of centimeters.
|
|
|
LeftFooterPictureCropLeft |
Gets or set crop left width of picture for left part of the footer,in unit of centimeters.
|
|
|
LeftFooterPictureCropRight |
Gets or set crop right width of picture for left part of the footer,in unit of centimeters.
|
|
|
LeftFooterPictureCropTop |
Gets or set crop top height of picture for left part of the footer,in unit of centimeters.
|
|
|
LeftFooterPictureHeight |
Gets or set height of picture for left part of the footer.
|
|
|
LeftFooterPictureWidth |
Gets or set width of picture for left part of the footer.
|
|
|
LeftHeader |
Returns or sets the left part of the header. Read / write String.
|
|
|
LeftHeaderImage |
Gets / set image for left part of the header.
|
|
|
LeftHeaderPictureCropBottom |
Gets or set crop bottom height of picture for left part of the header,in unit of centimeters.
|
|
|
LeftHeaderPictureCropLeft |
Gets or set crop left width of picture for left part of the header,in unit of centimeters.
|
|
|
LeftHeaderPictureCropRight |
Gets or set crop right width of picture for left part of the header,in unit of centimeters.
|
|
|
LeftHeaderPictureCropTop |
Gets or set crop top height of picture for left part of the header,in unit of centimeters.
|
|
|
LeftHeaderPictureHeight |
Gets or set height of picture for left part of the header.
|
|
|
LeftHeaderPictureWidth |
Gets or set width of picture for left part of the header.
|
|
|
LeftMargin |
Returns or sets the size of the left margin, in inches.
Read / write Double.
|
|
|
OddFooterString |
Gets Odd page footer string. Read only.
|
|
|
OddHeaderString |
Gets Odd page header string. Read only.
|
|
|
ODSPageBackground |
Returns ods page background. Read-only.
|
|
|
Order |
Returns or sets the order that Microsoft Excel uses to number
pages when printing a large worksheet. Read / write ExcelOrder.
|
|
|
Orientation |
Portrait or landscape printing mode. Read / write ExcelPageOrientation.
|
|
|
PageHeight |
Returns page width in points. Read-only.
|
|
|
PageWidth |
Returns page width in points. Read-only.
|
|
|
PaperSize |
Returns or sets the size of the paper. Read / write ExcelPaperSize.
|
|
|
Parent |
Reference to Parent object. Read-only.
(Inherited from
XlsObject
.)
|
|
|
PrintComments |
Returns or sets the way comments are printed with the sheet.
Read / write ExcelPrintLocation.
|
|
|
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.
|
|
|
PrinterSettings |
Returns or sets the settings of the printer.
|
|
|
PrintNotes |
True if cell notes are printed as end notes with the sheet. Applies
only to worksheets. Read / write Boolean.
|
|
|
PrintQuality |
Returns or sets the print quality. Read / write ushort.
|
|
|
RecordCode |
Returns code of the biff storage. Read-only.
|
|
|
ReferenceCount |
Get quantity of instance references.
(Inherited from
XlsObject
.)
|
|
|
RightFooter |
Returns or sets the right part of the footer. Read / write String.
|
|
|
RightFooterImage |
Gets / set image for right part of the footer.
|
|
|
RightFooterPictureCropBottom |
Gets or set crop bottom height of picture for right part of the footer,in unit of centimeters.
|
|
|
RightFooterPictureCropLeft |
Gets or set crop left width of picture for right part of the footer,in unit of centimeters.
|
|
|
RightFooterPictureCropRight |
Gets or set crop right width of picture for right part of the footer,in unit of centimeters.
|
|
|
RightFooterPictureCropTop |
Gets or set crop top height of picture for right part of the footer,in unit of centimeters.
|
|
|
RightFooterPictureHeight |
Gets or set height of picture for right part of the footer.
|
|
|
RightFooterPictureWidth |
Gets or set width of picture for right part of the footer.
|
|
|
RightHeader |
Returns or sets the right part of the header. Read / write String.
|
|
|
RightHeaderImage |
Gets / set image for right part of the header.
|
|
|
RightHeaderPictureCropBottom |
Gets or set crop bottom height of picture for right part of the header,in unit of centimeters.
|
|
|
RightHeaderPictureCropLeft |
Gets or set crop left width of picture for right part of the header,in unit of centimeters.
|
|
|
RightHeaderPictureCropRight |
Gets or set crop right width of picture for right part of the header,in unit of centimeters.
|
|
|
RightHeaderPictureCropTop |
Gets or set crop top height of picture for right part of the header,in unit of centimeters.
|
|
|
RightHeaderPictureHeight |
Gets or set height of picture for right part of the header.
|
|
|
RightHeaderPictureWidth |
Gets or set width of picture for right part of the header.
|
|
|
RightMargin |
Returns or sets the size of the right margin, in inches.
Read / write Double.
|
|
|
ScaleWithDoc |
Indicates whether scale header and footer with document scaling.default is 1
|
|
|
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.
|
|
|
TopMargin |
Returns or sets the size of the top margin, in inches.
Read / write Double.
|
|
|
VResolution |
Gets or sets vertical resolution in dpi.
|
|
|
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.
|
| Name | Description | |
|---|---|---|
|
|
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
.)
|
|
|
CheckDisposed |
Checks whether object was disposed and throws exception if it was.
(Inherited from
XlsObject
.)
|
|
|
Copy |
Copies the settings from the source PageSetup to the current PageSetup.
|
|
|
Dispose |
Dispose object and free resources.
(Inherited from
XlsObject
.)
|
|
|
Equals |
Determines whether the specified object is equal to the current object.
(Inherited from
Object
.)
|
|
|
Finalize |
Destructor. Call dispose method of current object.
(Inherited from
XlsObject
.)
|
|
|
FindParent(Type) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
|
|
FindParent( Type ) |
Find parent of object.
(Inherited from
XlsObject
.)
|
|
|
FindParent(Type, Boolean) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
|
|
FindParents |
Finds parent objects.
(Inherited from
XlsObject
.)
|
|
|
GetHashCode |
Serves as the default hash function.
(Inherited from
Object
.)
|
|
|
GetStoreSize |
Obsolete.
Size of the required storage space. Read-only.
|
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
|
|
MemberwiseClone |
Creates a shallow copy of the current
Object
.
(Inherited from
Object
.)
|
|
|
OnDispose |
Method which can be overriden by users to take any specific actions when
object is disposed.
(Inherited from
XlsObject
.)
|
|
|
ReleaseReference |
Decrease quantity of Reference. User must call this method
when freeing resources.
(Inherited from
XlsObject
.)
|
|
|
SetCustomPaperSize |
Sets the custom paper size. Unit mm.
|
|
|
SetParent |
Sets parent of the object.
(Inherited from
XlsObject
.)
|
|
|
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
| Name | Description | |
|---|---|---|
|
|
DEFAULT_BOTTOM_MARGIN |
Value of the bottom margin by default.
|
|
|
DEFAULT_LEFT_MARGIN |
Value of the left margin by default.
|
|
|
DEFAULT_RIGHT_MARGIN |
Value of the right margin by default.
|
|
|
DEFAULT_TOP_MARGIN |
Value of the top margin by default.
|
|
|
m_bIsDisposed |
Flag which indicates if the object was disposed or not.
(Inherited from
XlsObject
.)
|