ig.excel.PrintOptions

Class which exposes the various print options available for a worksheet which can be saved with both a worksheet and a custom view.

Remarks

This class provides a way to control how a worksheet is printed.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • alignHeadersAndFootersWithMargins
    Inherited

    .alignHeadersAndFootersWithMargins( );

    Gets the value indicating whether to align header and footer margins with page margins.

  • alignHeadersAndFootersWithMargins
    Inherited

    .alignHeadersAndFootersWithMargins( value:boolean );

    Sets the value indicating whether to align header and footer margins with page margins.

    • value
    • Type:boolean
  • bottomMargin
    Inherited

    .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.
  • bottomMargin
    Inherited

    .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.
  • centerHorizontally

    .centerHorizontally( );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the printed pages should be centered horizontally.

    Gets the value indicating whether the printed pages should be centered horizontally.

  • centerHorizontally

    .centerHorizontally( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the printed pages should be centered horizontally.

    Sets the value indicating whether the printed pages should be centered horizontally.

    • value
    • Type:boolean
  • centerVertically

    .centerVertically( );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the printed pages should be centered vertically.

    Gets the value indicating whether the printed pages should be centered vertically.

  • centerVertically

    .centerVertically( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the printed pages should be centered vertically.

    Sets the value indicating whether the printed pages should be centered vertically.

    • value
    • Type:boolean
  • clearPageBreaks

    .clearPageBreaks( );

    Clears all page breaks from the PrintOptions.

  • columnsToRepeatAtLeft

    .columnsToRepeatAtLeft( );
    Return Type:
    ig.excel.RepeatTitleRange
    Return Type Description:
    Returns a RepeatTitleRange.

    Gets the range of columns which should be printed on every page.

    Exceptions

    Exception Description
    ig.ArgumentException Occurs when the value specified is not null and its value is greater than or equal to the number of columns in the Worksheet.
  • columnsToRepeatAtLeft

    .columnsToRepeatAtLeft( value:ig.excel.RepeatTitleRange );
    Return Type:
    ig.excel.RepeatTitleRange
    Return Type Description:
    Returns a RepeatTitleRange.

    Sets the range of columns which should be printed on every page.

    • value
    • Type:ig.excel.RepeatTitleRange

    Exceptions

    Exception Description
    ig.ArgumentException Occurs when the value specified is not null and its value is greater than or equal to the number of columns in the Worksheet.
  • draftQuality
    Inherited

    .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
    Inherited

    .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
    Inherited

    .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: Section 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. Replacement 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). Formatting 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.

    The header or footer string could look like this: &L&"Arial,Bold"&D&CPage &P of &N on &A&R&14&F.

  • footer
    Inherited

    .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: Section 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. Replacement 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). Formatting 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.

    The header or footer string could look like this: &L&"Arial,Bold"&D&CPage &P of &N on &A&R&14&F.

  • footerMargin
    Inherited

    .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.
  • footerMargin
    Inherited

    .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.
  • header
    Inherited

    .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: Section 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. Replacement 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). Formatting 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.

    The header or footer string could look like this: &L&"Arial,Bold"&D&CPage &P of &N on &A&R&14&F.

  • header
    Inherited

    .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: Section 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. Replacement 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). Formatting 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.

    The header or footer string could look like this: &L&"Arial,Bold"&D&CPage &P of &N on &A&R&14&F.

  • headerMargin
    Inherited

    .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.
  • headerMargin
    Inherited

    .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.
  • horizontalPageBreaks

    .horizontalPageBreaks( );
    Return Type:
    ig.excel.HorizontalPageBreakCollection
    Return Type Description:
    Returns a HorizontalPageBreakCollection.

    Gets the collection of horizontal page breaks in the Worksheet.

  • horizontalPageBreaks

    .horizontalPageBreaks( index:number );
    Return Type:
    ig.excel.HorizontalPageBreak
    Return Type Description:
    A PageBreak-derived instance.

    Gets the page break at the specified index.

    • index
    • Type:number
    • The index of the page break to get.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException Occurs when index is less than 0 or greater than of equal to PageBreakCollection`1.count.
  • insertPageBreak

    .insertPageBreak( cell:ig.excel.WorksheetCell );

    Inserts a horizontal and/or vertical page break before the specified cell.

    • cell
    • Type:ig.excel.WorksheetCell
    • The cell at which to insert the page break(s).

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when cell is null.
    ig.ArgumentException Occurs when cell is at the top-left corner of the Worksheet.

    Remarks

    If the cell is not contained in one of the print areas in the PrintOptions.printAreas collection, the page breaks added will be as follows: If the cell is at the top-left corner of the Worksheet, an exception will be thrown. If the cell is on the left edge of the Worksheet, a horizontal page break will be inserted above the cell. If the cell is on the top edge of the Worksheet, a vertical page break will be inserted to the left of the cell. If the cell is anywhere else in the Worksheet, a horizontal page break will be inserted above the cell and a vertical page break will be inserted to the left of the cell.

    If the cell is contained in one of the print areas in the PrintOptions.printAreas collection, the page breaks added will be as follows: If the cell is at the top-left corner of the print area, no page breaks will be inserted. If the cell is on the left edge of the print area, a horizontal page break will be inserted above the cell. If the cell is on the top edge of the print area, a vertical page break will be inserted to the left of the cell. If the cell is anywhere else in the print area, a horizontal page break will be inserted above the cell and a vertical page break will be inserted to the left of the cell.

    When page breaks are inserted in a print area, they will only extend to the edges of the print area.

  • insertPageBreak

    .insertPageBreak( column:ig.excel.WorksheetColumn );

    Inserts a vertical page break to the left of the specified column.

    • column
    • Type:ig.excel.WorksheetColumn
    • The column at which to insert the page break.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when column is null.
    ig.ArgumentException Occurs when column is at the left edge of the Worksheet.

    Remarks

    If the column is not contained in one of the print areas in the PrintOptions.printAreas collection, the page breaks added will be as follows: If the column is at the left edge of the Worksheet, an exception will be thrown. If the column is anywhere else in the Worksheet, a vertical page break will be inserted to the left of the column.

    If the column is contained in one of the print areas in the PrintOptions.printAreas collection, the page breaks added will be as follows: If the column is at the left edge of the print area, no page break will be inserted. If the column is anywhere else in the print area, a vertical page break will be inserted to the left of the column.

  • insertPageBreak

    .insertPageBreak( row:ig.excel.WorksheetRow );

    Inserts a horizontal page break above the specified row.

    • row
    • Type:ig.excel.WorksheetRow
    • The row at which to insert the page break.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when row is null.
    ig.ArgumentException Occurs when row is at the top edge of the Worksheet.

    Remarks

    If the row is not contained in one of the print areas in the PrintOptions.printAreas collection, the page breaks added will be as follows: If the row is at the top edge of the Worksheet, an exception will be thrown. If the row is anywhere else in the Worksheet, a horizontal page break will be inserted above the row.

    If the row is contained in one of the print areas in the PrintOptions.printAreas collection, the page breaks added will be as follows: If the row is at the top edge of the print area, no page break will be inserted. If the row is anywhere else in the print area, a horizontal page break will be inserted above the row.

  • leftMargin
    Inherited

    .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.
  • leftMargin
    Inherited

    .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.
  • maxPagesHorizontally

    .maxPagesHorizontally( );
    Return Type:
    number
    Return Type Description:
    The maximum number of pages allowed in the horizontal direction to print the worksheet.

    Gets the maximum number of pages allowed in the horizontal direction to print the worksheet.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value assigned is outside the valid range of 0 and 32767.

    Remarks

    A value of zero indicates no maximum is used in the horizontal direction. As many pages as needed will be used.

    Note: For MaxPagesHorizontally and PrintOptions.maxPagesVertically to affect the way the worksheet is printed, PrintOptions.scalingType must be set to a value of FitToPages. However, if the the ScalingType is different and these values aren't used, they will still be saved with the worksheet.

  • maxPagesHorizontally

    .maxPagesHorizontally( value:number );
    Return Type:
    number
    Return Type Description:
    The maximum number of pages allowed in the horizontal direction to print the worksheet.

    Sets the maximum number of pages allowed in the horizontal direction to print the worksheet.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value assigned is outside the valid range of 0 and 32767.

    Remarks

    A value of zero indicates no maximum is used in the horizontal direction. As many pages as needed will be used.

    Note: For MaxPagesHorizontally and PrintOptions.maxPagesVertically to affect the way the worksheet is printed, PrintOptions.scalingType must be set to a value of FitToPages. However, if the the ScalingType is different and these values aren't used, they will still be saved with the worksheet.

  • maxPagesVertically

    .maxPagesVertically( );
    Return Type:
    number
    Return Type Description:
    The maximum number of pages allowed in the vertical direction to print the worksheet.

    Gets the maximum number of pages allowed in the vertical direction to print the worksheet.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value assigned is outside the valid range of 0 and 32767.

    Remarks

    A value of zero indicates no maximum is used in the vertical direction. As many pages as needed will be used.

    Note: For PrintOptions.maxPagesHorizontally and MaxPagesVertically to affect the way the worksheet is printed, PrintOptions.scalingType must be set to a value of FitToPages. However, if the the ScalingType is different and these values aren't used, they will still be saved with the worksheet.

  • maxPagesVertically

    .maxPagesVertically( value:number );
    Return Type:
    number
    Return Type Description:
    The maximum number of pages allowed in the vertical direction to print the worksheet.

    Sets the maximum number of pages allowed in the vertical direction to print the worksheet.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value assigned is outside the valid range of 0 and 32767.

    Remarks

    A value of zero indicates no maximum is used in the vertical direction. As many pages as needed will be used.

    Note: For PrintOptions.maxPagesHorizontally and MaxPagesVertically to affect the way the worksheet is printed, PrintOptions.scalingType must be set to a value of FitToPages. However, if the the ScalingType is different and these values aren't used, they will still be saved with the worksheet.

  • numberOfCopies
    Inherited

    .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
    Inherited

    .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
    Inherited

    .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.
  • orientation
    Inherited

    .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.
  • orientationResolved
    Inherited

    .orientationResolved( );
    Return Type:
    ig.excel.Orientation
    Return Type Description:
    Returns a Orientation.

    Returns the resolved orientation for each page of the printed worksheet.

  • pageNumbering
    Inherited

    .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
    Inherited

    .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.

  • pageOrder

    .pageOrder( );
    Return Type:
    ig.excel.PageOrder
    Return Type Description:
    The order in which to print pages for multiple page worksheets.

    Gets the order in which to print pages for multiple page worksheets.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The assigned value is not defined in the PrintOptions.pageOrder enumeration.
  • pageOrder

    .pageOrder( value:ig.excel.PageOrder );
    Return Type:
    ig.excel.PageOrder
    Return Type Description:
    The order in which to print pages for multiple page worksheets.

    Sets the order in which to print pages for multiple page worksheets.

    • value
    • Type:ig.excel.PageOrder

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The assigned value is not defined in the PrintOptions.pageOrder enumeration.
  • paperSize
    Inherited

    .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.
  • paperSize
    Inherited

    .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.
  • printAreas

    .printAreas( );
    Return Type:
    ig.excel.PrintAreasCollection
    Return Type Description:
    Returns a PrintAreasCollection.

    Gets the collection of print areas in the Worksheet.

  • printAreas

    .printAreas( index:number );
    Return Type:
    ig.excel.WorksheetRegion
    Return Type Description:
    A WorksheetRegion instance representing a print area in the Worksheet.

    Gets the print area at the specified index.

    • index
    • Type:number
    • The index of the print area to get.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException Occurs when index is less than 0 or greater than or equal to the size of the collection.
  • printErrors
    Inherited

    .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
    Inherited

    .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.

  • printGridlines

    .printGridlines( );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether to print the worksheet gridlines.

    Gets the value which indicates whether to print the worksheet gridlines.

  • printGridlines

    .printGridlines( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value which indicates whether to print the worksheet gridlines.

    Sets the value which indicates whether to print the worksheet gridlines.

    • value
    • Type:boolean
  • printInBlackAndWhite
    Inherited

    .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
    Inherited

    .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
    Inherited

    .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
    Inherited

    .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.

  • printRowAndColumnHeaders

    .printRowAndColumnHeaders( );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether to print row and column headers.

    Gets the value indicating whether to print row and column headers.

    Remarks

    The row and column headers show the identifier of the row or column.

  • printRowAndColumnHeaders

    .printRowAndColumnHeaders( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether to print row and column headers.

    Sets the value indicating whether to print row and column headers.

    • value
    • Type:boolean

    Remarks

    The row and column headers show the identifier of the row or column.

  • 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
    Inherited

    .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
    Inherited

    .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
    Inherited

    .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.
  • rightMargin
    Inherited

    .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.
  • rowsToRepeatAtTop

    .rowsToRepeatAtTop( );
    Return Type:
    ig.excel.RepeatTitleRange
    Return Type Description:
    Returns a RepeatTitleRange.

    Gets the range of rows which should be printed on every page.

    Exceptions

    Exception Description
    ig.ArgumentException Occurs when the value specified is not null and its value is greater than or equal to the number of rows in the Worksheet.
  • rowsToRepeatAtTop

    .rowsToRepeatAtTop( value:ig.excel.RepeatTitleRange );
    Return Type:
    ig.excel.RepeatTitleRange
    Return Type Description:
    Returns a RepeatTitleRange.

    Sets the range of rows which should be printed on every page.

    • value
    • Type:ig.excel.RepeatTitleRange

    Exceptions

    Exception Description
    ig.ArgumentException Occurs when the value specified is not null and its value is greater than or equal to the number of rows in the Worksheet.
  • scaleHeadersAndFootersWithDocument
    Inherited

    .scaleHeadersAndFootersWithDocument( );

    Gets the value indicating whether to scale the headers and footers with the document scaling.

  • scaleHeadersAndFootersWithDocument
    Inherited

    .scaleHeadersAndFootersWithDocument( value:boolean );

    Sets the value indicating whether to scale the headers and footers with the document scaling.

    • value
    • Type:boolean
  • scalingFactor

    .scalingFactor( );
    Return Type:
    number
    Return Type Description:
    The scaling factor to use when printing the worksheet.

    Gets the scaling factor to use when printing the worksheet.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is outside the valid range of 10 and 400.

    Remarks

    The scaling factor is similar to magnifications in that is it stored as a percentage of the normal scaling. A value of 100 indicates normal scaling whereas a value of 200 indicates the worksheet is scaled to twice its normal size.

    Note: For ScalingFactor to affect the way the worksheet is printed, PrintOptions.scalingType must be set to a value of UseScalingFactor.

  • scalingFactor

    .scalingFactor( value:number );
    Return Type:
    number
    Return Type Description:
    The scaling factor to use when printing the worksheet.

    Sets the scaling factor to use when printing the worksheet.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The assigned value is outside the valid range of 10 and 400.

    Remarks

    The scaling factor is similar to magnifications in that is it stored as a percentage of the normal scaling. A value of 100 indicates normal scaling whereas a value of 200 indicates the worksheet is scaled to twice its normal size.

    Note: For ScalingFactor to affect the way the worksheet is printed, PrintOptions.scalingType must be set to a value of UseScalingFactor.

  • scalingType

    .scalingType( );
    Return Type:
    ig.excel.ScalingType
    Return Type Description:
    The method for scaling the worksheet when it is printed.

    Gets the method for scaling the worksheet when it is printed.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The assigned value is not defined in the PrintOptions.scalingType enumeration.

    Remarks

    If this is set to a value of UseScalingFactor, PrintOptions.scalingFactor is used to uniformly scale the worksheet on the printed pages.

    If this is set to a value of FitToPages, PrintOptions.maxPagesHorizontally and PrintOptions.maxPagesVertically are used to set the maximum number of pages to fit the printed worksheet into in both directions.

  • scalingType

    .scalingType( value:ig.excel.ScalingType );
    Return Type:
    ig.excel.ScalingType
    Return Type Description:
    The method for scaling the worksheet when it is printed.

    Sets the method for scaling the worksheet when it is printed.

    • value
    • Type:ig.excel.ScalingType

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The assigned value is not defined in the PrintOptions.scalingType enumeration.

    Remarks

    If this is set to a value of UseScalingFactor, PrintOptions.scalingFactor is used to uniformly scale the worksheet on the printed pages.

    If this is set to a value of FitToPages, PrintOptions.maxPagesHorizontally and PrintOptions.maxPagesVertically are used to set the maximum number of pages to fit the printed worksheet into in both directions.

  • startPageNumber
    Inherited

    .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
    Inherited

    .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
    Inherited

    .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.
  • topMargin
    Inherited

    .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.
  • verticalPageBreaks

    .verticalPageBreaks( );
    Return Type:
    ig.excel.VerticalPageBreakCollection
    Return Type Description:
    Returns a VerticalPageBreakCollection.

    Gets the collection of vertical page breaks in the Worksheet.

  • verticalPageBreaks

    .verticalPageBreaks( index:number );
    Return Type:
    ig.excel.VerticalPageBreak
    Return Type Description:
    A PageBreak-derived instance.

    Gets the page break at the specified index.

    • index
    • Type:number
    • The index of the page break to get.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException Occurs when index is less than 0 or greater than of equal to PageBreakCollection`1.count.
  • verticalResolution
    Inherited

    .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.
  • verticalResolution
    Inherited

    .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.

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.