ig.excel.PrintOptionsBase
Remarks
This class provides a way to control how a sheet is printed.
Dependencies
-
alignHeadersAndFootersWithMargins
- .alignHeadersAndFootersWithMargins( );
Gets the value indicating whether to align header and footer margins with page margins.
See Also
-
alignHeadersAndFootersWithMargins
- .alignHeadersAndFootersWithMargins( value:boolean );
Sets the value indicating whether to align header and footer margins with page margins.
- value
- Type:boolean
See Also
-
bottomMargin
- .bottomMargin( );
- Return Type:
- number
- Return Type Description:
- The margin at the bottom of each printed page of the worksheet, specified in inches.
Gets the margin at the bottom of each printed page of the worksheet, specified in inches.
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid margin range of 0 and 100 inches. See Also
-
bottomMargin
- .bottomMargin( value:number );
- Return Type:
- number
- Return Type Description:
- The margin at the bottom of each printed page of the worksheet, specified in inches.
Sets the margin at the bottom of each printed page of the worksheet, specified in inches.
- value
- Type:number
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid margin range of 0 and 100 inches. See Also
-
draftQuality
- .draftQuality( );
- Return Type:
- boolean
- Return Type Description:
- The value indicating whether the printed pages should be printed using draft quality.
Gets the value indicating whether the printed pages should be printed using draft quality.
-
draftQuality
- .draftQuality( value:boolean );
- Return Type:
- boolean
- Return Type Description:
- The value indicating whether the printed pages should be printed using draft quality.
Sets the value indicating whether the printed pages should be printed using draft quality.
- value
- Type:boolean
-
footer
- .footer( );
- Return Type:
- string
- Return Type Description:
- The footer for each page of the worksheet.
Gets the footer for each page of the printed worksheet.
Remarks
The '&' character in the header and footer is a special character. Depending on what is after it, the formatting of the text can be controlled or dynamic text can be inserted. Below is a list of the available commands:
-
&L The following text will appear in the left section. The formatting of new sections is always the default formatting, regardless of the formatting of the previous section. -
&C The following text will appear in the center section. The formatting of new sections is always the default formatting, regardless of the formatting of the previous section. -
&R The following text will appear in the right section. The formatting of new sections is always the default formatting, regardless of the formatting of the previous section.
Section commands -
&& Insert the '&' character. -
&A Insert the current worksheet name. -
&D Insert the current date. -
&F Insert the current file name. -
&G Insert an image (Note: This command is currently not supported). -
&N Insert the number of pages the worksheet will need to print. -
&P Insert the current page number. -
&T Insert the current time. -
&Z Insert the current file path (without the file name).
Replacement commands -
&B Toggle bold. -
&E Toggle double underlining. -
&I Toggle italics. -
&S Toggle strikethrough. -
&U Toggle underlining. -
&X Toggle superscript. -
&Y Toggle subscript. -
& Sets a new font size for the following text. The size is expressed as a positive integer. If a number is to follow this command in the header, it must be separated by a space. -
&" " Sets a new font for the following text. If the font name is not recognized, the default font will be used. -
&" , " Sets the new font and font style for the following text. The font style is usually "Regular", "Bold", "Italic", or "Bold Italic", but can be other styles depending on the font. The available font styles can be seen in the font dialog when a font is selected.
Formatting commands The header or footer string could look like this: &L&"Arial,Bold"&D&CPage &P of &N on &A&R&14&F.
-
footer
- .footer( value:string );
- Return Type:
- string
- Return Type Description:
- The footer for each page of the worksheet.
Sets the footer for each page of the printed worksheet.
- value
- Type:string
Remarks
The '&' character in the header and footer is a special character. Depending on what is after it, the formatting of the text can be controlled or dynamic text can be inserted. Below is a list of the available commands:
-
&L The following text will appear in the left section. The formatting of new sections is always the default formatting, regardless of the formatting of the previous section. -
&C The following text will appear in the center section. The formatting of new sections is always the default formatting, regardless of the formatting of the previous section. -
&R The following text will appear in the right section. The formatting of new sections is always the default formatting, regardless of the formatting of the previous section.
Section commands -
&& Insert the '&' character. -
&A Insert the current worksheet name. -
&D Insert the current date. -
&F Insert the current file name. -
&G Insert an image (Note: This command is currently not supported). -
&N Insert the number of pages the worksheet will need to print. -
&P Insert the current page number. -
&T Insert the current time. -
&Z Insert the current file path (without the file name).
Replacement commands -
&B Toggle bold. -
&E Toggle double underlining. -
&I Toggle italics. -
&S Toggle strikethrough. -
&U Toggle underlining. -
&X Toggle superscript. -
&Y Toggle subscript. -
& Sets a new font size for the following text. The size is expressed as a positive integer. If a number is to follow this command in the header, it must be separated by a space. -
&" " Sets a new font for the following text. If the font name is not recognized, the default font will be used. -
&" , " Sets the new font and font style for the following text. The font style is usually "Regular", "Bold", "Italic", or "Bold Italic", but can be other styles depending on the font. The available font styles can be seen in the font dialog when a font is selected.
Formatting commands The header or footer string could look like this: &L&"Arial,Bold"&D&CPage &P of &N on &A&R&14&F.
-
footerMargin
- .footerMargin( );
- Return Type:
- number
- Return Type Description:
- The footer margin for each printed page of the worksheet, specified in inches.
Gets the footer margin for each printed page of the worksheet, specified in inches.
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid margin range of 0 and 100 inches. See Also
-
footerMargin
- .footerMargin( value:number );
- Return Type:
- number
- Return Type Description:
- The footer margin for each printed page of the worksheet, specified in inches.
Sets the footer margin for each printed page of the worksheet, specified in inches.
- value
- Type:number
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid margin range of 0 and 100 inches. See Also
-
header
- .header( );
- Return Type:
- string
- Return Type Description:
- The header for each page of the worksheet.
Gets the header for each page of the printed worksheet.
Remarks
The '&' character in the header and footer is a special character. Depending on what is after it, the formatting of the text can be controlled or dynamic text can be inserted. Below is a list of the available commands:
-
&L The following text will appear in the left section. The formatting of new sections is always the default formatting, regardless of the formatting of the previous section. -
&C The following text will appear in the center section. The formatting of new sections is always the default formatting, regardless of the formatting of the previous section. -
&R The following text will appear in the right section. The formatting of new sections is always the default formatting, regardless of the formatting of the previous section.
Section commands -
&& Insert the '&' character. -
&A Insert the current worksheet name. -
&D Insert the current date. -
&F Insert the current file name. -
&G Insert an image (Note: This command is currently not supported). -
&N Insert the number of pages the worksheet will need to print. -
&P Insert the current page number. -
&T Insert the current time. -
&Z Insert the current file path (without the file name).
Replacement commands -
&B Toggle bold. -
&E Toggle double underlining. -
&I Toggle italics. -
&S Toggle strikethrough. -
&U Toggle underlining. -
&X Toggle superscript. -
&Y Toggle subscript. -
& Sets a new font size for the following text. The size is expressed as a positive integer. If a number is to follow this command in the header, it must be separated by a space. -
&" " Sets a new font for the following text. If the font name is not recognized, the default font will be used. -
&" , " Sets the new font and font style for the following text. The font style is usually "Regular", "Bold", "Italic", or "Bold Italic", but can be other styles depending on the font. The available font styles can be seen in the font dialog when a font is selected.
Formatting commands The header or footer string could look like this: &L&"Arial,Bold"&D&CPage &P of &N on &A&R&14&F.
-
header
- .header( value:string );
- Return Type:
- string
- Return Type Description:
- The header for each page of the worksheet.
Sets the header for each page of the printed worksheet.
- value
- Type:string
Remarks
The '&' character in the header and footer is a special character. Depending on what is after it, the formatting of the text can be controlled or dynamic text can be inserted. Below is a list of the available commands:
-
&L The following text will appear in the left section. The formatting of new sections is always the default formatting, regardless of the formatting of the previous section. -
&C The following text will appear in the center section. The formatting of new sections is always the default formatting, regardless of the formatting of the previous section. -
&R The following text will appear in the right section. The formatting of new sections is always the default formatting, regardless of the formatting of the previous section.
Section commands -
&& Insert the '&' character. -
&A Insert the current worksheet name. -
&D Insert the current date. -
&F Insert the current file name. -
&G Insert an image (Note: This command is currently not supported). -
&N Insert the number of pages the worksheet will need to print. -
&P Insert the current page number. -
&T Insert the current time. -
&Z Insert the current file path (without the file name).
Replacement commands -
&B Toggle bold. -
&E Toggle double underlining. -
&I Toggle italics. -
&S Toggle strikethrough. -
&U Toggle underlining. -
&X Toggle superscript. -
&Y Toggle subscript. -
& Sets a new font size for the following text. The size is expressed as a positive integer. If a number is to follow this command in the header, it must be separated by a space. -
&" " Sets a new font for the following text. If the font name is not recognized, the default font will be used. -
&" , " Sets the new font and font style for the following text. The font style is usually "Regular", "Bold", "Italic", or "Bold Italic", but can be other styles depending on the font. The available font styles can be seen in the font dialog when a font is selected.
Formatting commands The header or footer string could look like this: &L&"Arial,Bold"&D&CPage &P of &N on &A&R&14&F.
-
headerMargin
- .headerMargin( );
- Return Type:
- number
- Return Type Description:
- The header margin for each printed page of the worksheet, specified in inches.
Gets the header margin for each printed page of the worksheet, specified in inches.
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid margin range of 0 and 100 inches. See Also
-
headerMargin
- .headerMargin( value:number );
- Return Type:
- number
- Return Type Description:
- The header margin for each printed page of the worksheet, specified in inches.
Sets the header margin for each printed page of the worksheet, specified in inches.
- value
- Type:number
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid margin range of 0 and 100 inches. See Also
-
leftMargin
- .leftMargin( );
- Return Type:
- number
- Return Type Description:
- The margin at the left of each printed page of the worksheet, specified in inches.
Gets the margin at the left of each printed page of the worksheet, specified in inches.
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid margin range of 0 and 100 inches. See Also
-
leftMargin
- .leftMargin( value:number );
- Return Type:
- number
- Return Type Description:
- The margin at the left of each printed page of the worksheet, specified in inches.
Sets the margin at the left of each printed page of the worksheet, specified in inches.
- value
- Type:number
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid margin range of 0 and 100 inches. See Also
-
numberOfCopies
- .numberOfCopies( );
- Return Type:
- number
- Return Type Description:
- The number of copies to print.
Gets the number of copies to print.
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid range of 1 and 65535. -
numberOfCopies
- .numberOfCopies( value:number );
- Return Type:
- number
- Return Type Description:
- The number of copies to print.
Sets the number of copies to print.
- value
- Type:number
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid range of 1 and 65535. -
orientation
- .orientation( );
- Return Type:
- ig.excel.Orientation
- Return Type Description:
- The orientation for each page of the printed worksheet.
Gets the orientation for each page of the printed worksheet.
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The assigned value is not defined in the PrintOptionsBase.orientation enumeration. See Also
-
orientation
- .orientation( value:ig.excel.Orientation );
- Return Type:
- ig.excel.Orientation
- Return Type Description:
- The orientation for each page of the printed worksheet.
Sets the orientation for each page of the printed worksheet.
- value
- Type:ig.excel.Orientation
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The assigned value is not defined in the PrintOptionsBase.orientation enumeration. See Also
-
orientationResolved
- .orientationResolved( );
- Return Type:
- ig.excel.Orientation
- Return Type Description:
- Returns a Orientation.
Returns the resolved orientation for each page of the printed worksheet.
See Also
-
pageNumbering
- .pageNumbering( );
- Return Type:
- ig.excel.PageNumbering
- Return Type Description:
- The method with which pages are numbered.
Gets the method with which pages are numbered.
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The assigned value is not defined in the PrintOptionsBase.pageNumbering enumeration. Remarks
If this is set to a value of UseStartPageNumber, the first page is numbered using the PrintOptionsBase.startPageNumber.
-
pageNumbering
- .pageNumbering( value:ig.excel.PageNumbering );
- Return Type:
- ig.excel.PageNumbering
- Return Type Description:
- The method with which pages are numbered.
Sets the method with which pages are numbered.
- value
- Type:ig.excel.PageNumbering
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The assigned value is not defined in the PrintOptionsBase.pageNumbering enumeration. Remarks
If this is set to a value of UseStartPageNumber, the first page is numbered using the PrintOptionsBase.startPageNumber.
-
paperSize
- .paperSize( );
- Return Type:
- ig.excel.PaperSize
- Return Type Description:
- The paper size for each printed page of the worksheet.
Gets the paper size for each printed page of the worksheet.
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The assigned value is not defined in the PrintOptionsBase.paperSize enumeration. See Also
-
paperSize
- .paperSize( value:ig.excel.PaperSize );
- Return Type:
- ig.excel.PaperSize
- Return Type Description:
- The paper size for each printed page of the worksheet.
Sets the paper size for each printed page of the worksheet.
- value
- Type:ig.excel.PaperSize
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The assigned value is not defined in the PrintOptionsBase.paperSize enumeration. See Also
-
printErrors
- .printErrors( );
- Return Type:
- ig.excel.PrintErrors
- Return Type Description:
- The way error values of cells are printed.
Gets the way error values of cells are printed.
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The assigned value is not defined in the PrintOptionsBase.printErrors enumeration. Remarks
A cell can have an error value if its WorksheetCell.value is set directly to an ErrorValue or if it is set to a Formula that evaluates to an error.
-
printErrors
- .printErrors( value:ig.excel.PrintErrors );
- Return Type:
- ig.excel.PrintErrors
- Return Type Description:
- The way error values of cells are printed.
Sets the way error values of cells are printed.
- value
- Type:ig.excel.PrintErrors
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The assigned value is not defined in the PrintOptionsBase.printErrors enumeration. Remarks
A cell can have an error value if its WorksheetCell.value is set directly to an ErrorValue or if it is set to a Formula that evaluates to an error.
-
printInBlackAndWhite
- .printInBlackAndWhite( );
- Return Type:
- boolean
- Return Type Description:
- The value indicating whether the worksheet should be printed in black and white.
Gets the value indicating whether the worksheet should be printed in black and white.
-
printInBlackAndWhite
- .printInBlackAndWhite( value:boolean );
- Return Type:
- boolean
- Return Type Description:
- The value indicating whether the worksheet should be printed in black and white.
Sets the value indicating whether the worksheet should be printed in black and white.
- value
- Type:boolean
-
printNotes
- .printNotes( );
- Return Type:
- ig.excel.PrintNotes
- Return Type Description:
- The way cell notes are printed.
Gets the way cell comments are printed.
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The assigned value is not defined in the PrintOptionsBase.printNotes enumeration. Remarks
If this is set to a value of PrintAsDisplayed, the comments will only print if they are displayed on the worksheet. If comments are hidden but indicators are shown, neither the indicators nor the comments will print.
-
printNotes
- .printNotes( value:ig.excel.PrintNotes );
- Return Type:
- ig.excel.PrintNotes
- Return Type Description:
- The way cell notes are printed.
Sets the way cell comments are printed.
- value
- Type:ig.excel.PrintNotes
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The assigned value is not defined in the PrintOptionsBase.printNotes enumeration. Remarks
If this is set to a value of PrintAsDisplayed, the comments will only print if they are displayed on the worksheet. If comments are hidden but indicators are shown, neither the indicators nor the comments will print.
-
reset
- .reset( );
Resets the print options to their default settings.
Remarks
The defaults used for each setting are the same defaults with which Microsoft Excel creates a blank worksheet.
-
resolution
- .resolution( );
- Return Type:
- number
- Return Type Description:
- The horizontal print resolution in DPI.
Gets the horizontal print resolution in DPI.
Exceptions
Exception Description ig.ArgumentOutOfRangeException The value assigned is outside the valid range of 0 and 65535. -
resolution
- .resolution( value:number );
- Return Type:
- number
- Return Type Description:
- The horizontal print resolution in DPI.
Sets the horizontal print resolution in DPI.
- value
- Type:number
Exceptions
Exception Description ig.ArgumentOutOfRangeException The value assigned is outside the valid range of 0 and 65535. -
rightMargin
- .rightMargin( );
- Return Type:
- number
- Return Type Description:
- The margin at the right of each printed page of the worksheet, specified in inches.
Gets the margin at the right of each printed page of the worksheet, specified in inches.
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid margin range of 0 and 100 inches. See Also
-
rightMargin
- .rightMargin( value:number );
- Return Type:
- number
- Return Type Description:
- The margin at the right of each printed page of the worksheet, specified in inches.
Sets the margin at the right of each printed page of the worksheet, specified in inches.
- value
- Type:number
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid margin range of 0 and 100 inches. See Also
-
scaleHeadersAndFootersWithDocument
- .scaleHeadersAndFootersWithDocument( );
Gets the value indicating whether to scale the headers and footers with the document scaling.
See Also
-
scaleHeadersAndFootersWithDocument
- .scaleHeadersAndFootersWithDocument( value:boolean );
Sets the value indicating whether to scale the headers and footers with the document scaling.
- value
- Type:boolean
See Also
-
startPageNumber
- .startPageNumber( );
- Return Type:
- number
- Return Type Description:
- The page number for the first printed page of the worksheet.
Gets the page number for the first printed page of the worksheet.
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid range of -32765 and 32767. Remarks
For this value to be used, PrintOptionsBase.pageNumbering must be set to a value of UseStartPageNumber.
-
startPageNumber
- .startPageNumber( value:number );
- Return Type:
- number
- Return Type Description:
- The page number for the first printed page of the worksheet.
Sets the page number for the first printed page of the worksheet.
- value
- Type:number
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid range of -32765 and 32767. Remarks
For this value to be used, PrintOptionsBase.pageNumbering must be set to a value of UseStartPageNumber.
-
topMargin
- .topMargin( );
- Return Type:
- number
- Return Type Description:
- The margin at the top of each printed page of the worksheet, specified in inches.
Gets the margin at the top of each printed page of the worksheet, specified in inches.
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid margin range of 0 and 100 inches. See Also
-
topMargin
- .topMargin( value:number );
- Return Type:
- number
- Return Type Description:
- The margin at the top of each printed page of the worksheet, specified in inches.
Sets the margin at the top of each printed page of the worksheet, specified in inches.
- value
- Type:number
Exceptions
Exception Description ig.ArgumentOutOfRangeException The assigned value is outside the valid margin range of 0 and 100 inches. See Also
-
verticalResolution
- .verticalResolution( );
- Return Type:
- number
- Return Type Description:
- The vertical print resolution in DPI.
Gets the vertical print resolution in DPI.
Exceptions
Exception Description ig.ArgumentOutOfRangeException The value assigned is outside the valid range of 0 and 65535. See Also
-
verticalResolution
- .verticalResolution( value:number );
- Return Type:
- number
- Return Type Description:
- The vertical print resolution in DPI.
Sets the vertical print resolution in DPI.
- value
- Type:number
Exceptions
Exception Description ig.ArgumentOutOfRangeException The value assigned is outside the valid range of 0 and 65535. See Also