Prints document pages.
Syntax
ASP.NET Ajax Javascript (Specification) | |
---|
function print(
: object
) : (Any); |
ASP.NET Ajax Javascript (Usage) | |
---|
var resultVar = instanceOfPageView.print(object); |
Parameters
- printOptions
- Print options is a set of parameters. All parameters are optional.
- imageHandlerUrl - Defines the service of images. Parameter can be undefined, in this case method will try to use image handler from this viewer. If this viewer is not initialized with image handler the method to do nothing.
- documentIdentifier - Defines the identifier of printed document. If this parameter is undefined the method will try to use the documentIdentifier of current loaded to this view document. In case of loaded document missing the method to do nothing.
- pageNumber - Defines the page number of printed page. If this parameter is undefined the method will find pageArray parameter. In other case page with required page number will be printed.
- pageArray - Defines the page number array for printing. It contains the indexes of document pages. The parameter has lower priority in compare with pageNumber parameter. If both parameters exist pageNumber will be used. Parameter can be not present in the set in case of pageFilter or pageNumber parameter presence.
- pageFilter - Defines the description of printed pages. This is formulized string which contains comma separated terms, where each term is one of both index of page or range of pages. Range of pages is a pair of page numbers separated with dash. First number of range is started page number of range and second number is last page number of range. If the whole construction has crossings in page numbers the seriated indexes will be merged. This parameter is alternative for pageArray.
- includeAnnotations - If this parameter is present and its value is true the annotations are printed. Otherwise, annotation marks will not be printed.
- callback - Defines the handler of printing process. It handler is called on start of printing and after each printed page. This function should be of function(arguments) prototype. The single parameter arguments is a set of parameters:
- documentIdentifier - Identifier of printing document.
- pageArray - Array of page indexes which is being printed.
- printingPageIndex - This is index of printing page number in pageArray. Before printing the page with first index this value is 0. After printing all pages enumerated in pageArray this value is length of pageArray.
- error - Error which is occured when the page is printed. For more detail inforamtion see ImGearPageOpenFailedEventArgs exception parameter.
- canceled - The print method sets this parameter to false before callback calling. Callback handler can set these parameter to true for terminating the printing process.
See Also