Added in API level 35
Also in S Extensions 13

RenderParams

Kotlin |Java

class RenderParams

kotlin.Any
↳	android.graphics.pdf.RenderParams

Represents a set of parameters that will be used to render a page of the PDF document.

Summary

Nested classes
	`Builder` Builder for constructing `RenderParams`.

Constants
static Int	`FLAG_RENDER_FREETEXT_ANNOTATIONS` Flag to enable rendering of freetext annotation on the page.
static Int	`FLAG_RENDER_HIGHLIGHT_ANNOTATIONS` Flag to enable rendering of highlight annotation on the page.
static Int	`FLAG_RENDER_STAMP_ANNOTATIONS` Flag to enable rendering of stamp annotation on the page.
static Int	`FLAG_RENDER_TEXT_ANNOTATIONS` Flag to enable rendering of text annotation on the page.
static Int	`RENDER_FORM_CONTENT_DEFAULT` Mode to rely on the default behavior with respect to including PDF form content in rendered PDF bitmaps.
static Int	`RENDER_FORM_CONTENT_DISABLED` Mode to exclude PDF form content from rendered PDF bitmaps.
static Int	`RENDER_FORM_CONTENT_ENABLED` Mode to include PDF form content in rendered PDF bitmaps.
static Int	`RENDER_MODE_FOR_DISPLAY` Mode to render the content for display on a screen.
static Int	`RENDER_MODE_FOR_PRINT` Mode to render the content for printing.
static Int	`RENDER_PAGE_OBJECT_EXCLUDE_IMAGE` Flag to exclude `PdfPageImageObject` in the rendered page bitmaps
static Int	`RENDER_PAGE_OBJECT_EXCLUDE_NONE` Flag to include all the page objects in the rendered page bitmaps
static Int	`RENDER_PAGE_OBJECT_EXCLUDE_PATH` Flag to exclude `PdfPagePathObject` in the rendered page bitmaps
static Int	`RENDER_PAGE_OBJECT_EXCLUDE_TEXT` Flag to exclude `PdfPageTextObject` in the rendered page bitmaps

Public methods
Int	`getRenderFlags()` Returns the bitmask of the render flags.
Int	`getRenderFormContentMode()` Returns the mode for rendering PDF form content, one of: `RENDER_FORM_CONTENT_ENABLED`, `RENDER_FORM_CONTENT_DISABLED`, or `RENDER_FORM_CONTENT_DEFAULT`
Int	`getRenderMode()` Returns the render mode.
Int	`getRenderPageObjectFlags()` Returns the bitmask of the render page object flags.

Constants

FLAG_RENDER_FREETEXT_ANNOTATIONS

Added in API level 36.1
Also in S Extensions 18

static val FLAG_RENDER_FREETEXT_ANNOTATIONS: Int

Flag to enable rendering of freetext annotation on the page.

Value: 16

See Also

FLAG_RENDER_HIGHLIGHT_ANNOTATIONS

Added in API level 35
Also in S Extensions 13

static val FLAG_RENDER_HIGHLIGHT_ANNOTATIONS: Int

Flag to enable rendering of highlight annotation on the page.

Value: 4

See Also

FLAG_RENDER_STAMP_ANNOTATIONS

Added in API level 36.1
Also in S Extensions 18

static val FLAG_RENDER_STAMP_ANNOTATIONS: Int

Flag to enable rendering of stamp annotation on the page.

Value: 8

See Also

FLAG_RENDER_TEXT_ANNOTATIONS

Added in API level 35
Also in S Extensions 13

static val FLAG_RENDER_TEXT_ANNOTATIONS: Int

Flag to enable rendering of text annotation on the page.

Value: 2

See Also

RENDER_FORM_CONTENT_DEFAULT

Added in API level 36.1
Also in S Extensions 19

static val RENDER_FORM_CONTENT_DEFAULT: Int

Mode to rely on the default behavior with respect to including PDF form content in rendered PDF bitmaps.

PdfRenderer will render form content by default if the application is targeting SDK version android.os.Build.VERSION_CODES#VANILLA_ICE_CREAM or higher.

PdfRendererPreV will always render form content by default.

Value: 3

RENDER_FORM_CONTENT_DISABLED

Added in API level 36.1
Also in S Extensions 19

static val RENDER_FORM_CONTENT_DISABLED: Int

Mode to exclude PDF form content from rendered PDF bitmaps.

Value: 2

RENDER_FORM_CONTENT_ENABLED

Added in API level 36.1
Also in S Extensions 19

static val RENDER_FORM_CONTENT_ENABLED: Int

Mode to include PDF form content in rendered PDF bitmaps.

Value: 1

RENDER_MODE_FOR_DISPLAY

Added in API level 35
Also in S Extensions 13

static val RENDER_MODE_FOR_DISPLAY: Int

Mode to render the content for display on a screen.

Value: 1

RENDER_MODE_FOR_PRINT

Added in API level 35
Also in S Extensions 13

static val RENDER_MODE_FOR_PRINT: Int

Mode to render the content for printing.

Value: 2

RENDER_PAGE_OBJECT_EXCLUDE_IMAGE

Added in API level 10000

static val RENDER_PAGE_OBJECT_EXCLUDE_IMAGE: Int

Flag to exclude PdfPageImageObject in the rendered page bitmaps

Value: 4

RENDER_PAGE_OBJECT_EXCLUDE_NONE

Added in API level 10000

static val RENDER_PAGE_OBJECT_EXCLUDE_NONE: Int

Flag to include all the page objects in the rendered page bitmaps

Value: 0

RENDER_PAGE_OBJECT_EXCLUDE_PATH

Added in API level 10000

static val RENDER_PAGE_OBJECT_EXCLUDE_PATH: Int

Flag to exclude PdfPagePathObject in the rendered page bitmaps

Value: 2

RENDER_PAGE_OBJECT_EXCLUDE_TEXT

Added in API level 10000

static val RENDER_PAGE_OBJECT_EXCLUDE_TEXT: Int

Flag to exclude PdfPageTextObject in the rendered page bitmaps

Value: 8

Public methods

getRenderFlags

Added in API level 35
Also in S Extensions 13

fun getRenderFlags(): Int

Returns the bitmask of the render flags.

Return
`Int`	Value is either `0` or a combination of the following: `FLAG_RENDER_TEXT_ANNOTATIONS` `FLAG_RENDER_HIGHLIGHT_ANNOTATIONS` `FLAG_RENDER_STAMP_ANNOTATIONS` `FLAG_RENDER_FREETEXT_ANNOTATIONS`

getRenderFormContentMode

Added in API level 36.1
Also in S Extensions 19

fun getRenderFormContentMode(): Int

Returns the mode for rendering PDF form content, one of: RENDER_FORM_CONTENT_ENABLED, RENDER_FORM_CONTENT_DISABLED, or RENDER_FORM_CONTENT_DEFAULT

Return
`Int`	Value is one of the following: `RENDER_FORM_CONTENT_ENABLED` `RENDER_FORM_CONTENT_DISABLED` `RENDER_FORM_CONTENT_DEFAULT`

getRenderMode

Added in API level 35
Also in S Extensions 13

fun getRenderMode(): Int

Returns the render mode.

Return
`Int`	Value is one of the following: `RENDER_MODE_FOR_DISPLAY` `RENDER_MODE_FOR_PRINT`

getRenderPageObjectFlags

Added in API level 10000

fun getRenderPageObjectFlags(): Int

Returns the bitmask of the render page object flags.

Return
`Int`	Value is either `0` or a combination of the following: `RENDER_PAGE_OBJECT_EXCLUDE_PATH` `RENDER_PAGE_OBJECT_EXCLUDE_IMAGE` `RENDER_PAGE_OBJECT_EXCLUDE_TEXT` `RENDER_PAGE_OBJECT_EXCLUDE_NONE`

See Also