# HtmlRenderPageSet

Immutable selection and composition policy for rendered HTML pages.

Class 

`OfficeIMO.Html`

**Namespace**

`OfficeIMO.Html`

**Assembly**

`OfficeIMO.Html`

**Source revision**

`3b680b1b6fb1` with working tree changes

**Source**

[HtmlRenderPageSet.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderPageSet.cs#L21)

**Modifiers**

sealed

Immutable selection and composition policy for rendered HTML pages.

## Inheritance

- object
- HtmlRenderPageSet

## Usage

Explore 7 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 6

- Method [HtmlRenderPageSet.All](/api/html/officeimo-html-htmlrenderpageset/#method-all)
- Method [HtmlRenderPageSet.Page](/api/html/officeimo-html-htmlrenderpageset/#method-page-int32)
- Method [HtmlRenderPageSet.Pages](/api/html/officeimo-html-htmlrenderpageset/#method-pages-int32-int32)
- Method [HtmlRenderPageSet.Stitched](/api/html/officeimo-html-htmlrenderpageset/#method-stitched)
- Property [HtmlRenderProfileContract.DefaultPageSet](/api/html/officeimo-html-htmlrenderprofilecontract/#property-defaultpageset)
- Property [HtmlRenderRequest.PageSet](/api/html/officeimo-html-htmlrenderrequest/#property-pageset)

### Accepted by parameters 1

- Method [HtmlRenderRequest.WithPageSet](/api/html/officeimo-html-htmlrenderrequest/#method-withpageset-officeimo-html-htmlrenderpageset) parameter `pageSet`

Filter members 

Show inherited

## Methods

`public static HtmlRenderPageSet All()` [#](#method-all)

[HtmlRenderPageSet.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderPageSet.cs#L21)

Returns every rendered page as a separate ordered surface.

Returns

`HtmlRenderPageSet`

`public static HtmlRenderPageSet Page(int pageIndex)` [#](#method-page-int32)

[HtmlRenderPageSet.cs:25](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderPageSet.cs#L25)

Returns one selected zero-based page.

Parameters

**pageIndex int required**

Returns

`HtmlRenderPageSet`

`public static HtmlRenderPageSet Pages(int firstPageIndex, int pageCount)` [#](#method-pages-int32-int32)

[HtmlRenderPageSet.cs:31](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderPageSet.cs#L31)

Returns a bounded range of pages as separate ordered surfaces.

Parameters

**firstPageIndex int required**

**pageCount int required**

Returns

`HtmlRenderPageSet`

`public static HtmlRenderPageSet Stitched()` [#](#method-stitched)

[HtmlRenderPageSet.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderPageSet.cs#L37)

Places every rendered page vertically on one continuous surface.

Returns

`HtmlRenderPageSet`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public HtmlRenderPageSetMode Mode { get; }` [#](#property-mode)

[HtmlRenderPageSet.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderPageSet.cs#L12)

How selected pages are exposed to the output adapter.

`public int FirstPageIndex { get; }` [#](#property-firstpageindex)

[HtmlRenderPageSet.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderPageSet.cs#L15)

Zero-based first source page included by the selection.

`public int? PageCount { get; }` [#](#property-pagecount)

[HtmlRenderPageSet.cs:18](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderPageSet.cs#L18)

Maximum pages included by a range, or null for every remaining page.

<!-- PowerForge markdown artifact sha256:553AE928D4923031800C48E6906967FCAD302FF353CAF89C7C1AB18303108FD1 -->
