[]
        
(Showing Draft Content)

GrapeCity.Documents.Common.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
Namespace: GrapeCity.Documents.Common
Assembly: DS.Documents.Imaging.dll
Syntax
public class OutputRange : IEnumerable<int>, IEnumerable
Public Class OutputRange
    Implements IEnumerable(Of Integer), IEnumerable

Constructors

Name Description
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, int, bool)

Creates an instance of OutputRange that includes a single interval of pages.

OutputRange(int[])

Creates an instance of OutputRange that includes all pages with numbers specified in the list.

OutputRange(int[], bool)

Creates an instance of OutputRange that includes all pages with numbers specified in the list.

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 commas;
  • dashes ('-') to specify intervals (a dash at the end implies infinity).
OutputRange(string, bool)

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

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

Fields

Name Description
All

Represents an all-inclusive range.

AllInverted

Represents an all-inclusive range with inverted order.

Properties

Name Description
FromPage

Gets the first page in the range.

Inverted

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

ToPage

Gets the last page in the range.

Type

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

Methods

Name Description
Contains(int)

Tests whether the specified page is within the range.

Equals(object)

Determines whether the specified object is equal to the current object.

GetEnumerator()

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

GetEnumerator(int)

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

GetEnumerator(int, int)

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

GetHashCode()

Serves as the default hash function.

GetMaxPage(int)

Gets the ending page number of the current range.

GetMinPage(int)

Gets the starting page number of the current range.

GetPage(int, int, int)

Gets the page number of a page with a specified index within the current range.

GetPageCount(int, int)

Gets the total number of pages in the current range.

InRange(int, int)

Tests whether page numbers specified by the current OutputRange fall within a specified range.

ToString()

Returns a string that represents the current OutputRange.

TryParse(string, out OutputRange)

Tries to parse specified string and create OutputRange object from it.