[]
        
(Showing Draft Content)

C1.C1Preview.OutputRange

OutputRange Class

Describes a part of the document (pages or objects) that is to be exported or printed. Note: all page numbers are 1-based.

Inheritance
OutputRange
Implements
Namespace: C1.C1Preview
Assembly: C1.PrintDocument.8.dll
Syntax
[TypeConverter(typeof(ExpandableObjectConverter))]
public class OutputRange : IEnumerable, ICloneable

Constructors

Name Description
OutputRange()

Creates a new instance of the output range that includes all pages in the document. Note that enumerating the resulting range must be broken by the client.

OutputRange(int)

Creates a new instance of the output range that includes all pages in the document.

OutputRange(int, int)

Creates an instance of OutputRange that includes a single interval of pages. FromPage may be greater than ToPage, in that case the range is inverted.

OutputRange(int[])

Creates an instance of OutputRange that includes all pages with numbers specified in the list. The list may include Dash values to specify intervals.

OutputRange(string)

Creates an instance of OutputRange that includes pages specified by the string parameter. The string may contain:

  • page numbers (1-based) separated by spaces or commas;
  • dashes ('-') to specify intervals (a dash at the end implies infinity).

Fields

Name Description
Dash

If included in the page indices list, specifies that all pages from preceeding to the next one are to be included in the output.

NoPage

This value indicates an invalid page number.

Properties

Name Description
All

Represents an all-inclusive range.

FromPage

Gets the first page in the range.

Inverted

Gets or sets the value indicating whether the range should be inverted. If the range is inverted, the range's iterator goes from the end of the range backwards.

MaxPageNumber

Gets or sets the absolute upper limit for page numbers in the range.

PageCount

Gets the total number of pages in the range. Note that if the MaxPageNumber has not been set, this property will get int.MaxValue.

PageNumbers

Gets the list of page numbers.

ToPage

Gets the last page in the range.

Type

Type of range: all pages, range of pages etc.

Methods

Name Description
AssignFrom(OutputRange)

Copies values from another instance of OutputRange.

Clone()

Clones the current OutputRange.

Contains(int)

Tests whether the specified page is within the range.

GetEnumerator()

Creates and returns a new enumerator that allows to loop through all pages in the range.

GetFirstPage()

Returns the first page in the range.

GetNextPage(int)

Returns the page number in the range following the specified one, or -1 if the specified number was the last one.

GetNextPage(int, ref int)

Returns the page number in the range following the specified one, or -1 if the specified number was the last one.

ToString()

Returns a string that represents the current OutputRange.