Added in API level 35
Also in S Extensions 13

RenderParams

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 for constructing RenderParams.
Constants
static Int

Flag to enable rendering of freetext annotation on the page.
static Int

Flag to enable rendering of highlight annotation on the page.
static Int

Flag to enable rendering of stamp annotation on the page.
static Int

Flag to enable rendering of text annotation on the page.
static Int

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

Mode to exclude PDF form content from rendered PDF bitmaps.
static Int

Mode to include PDF form content in rendered PDF bitmaps.
static Int

Mode to render the content for display on a screen.
static Int

Mode to render the content for printing.
Public methods
Int

Returns the bitmask of the render flags.
Int

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

Returns the render mode.

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

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

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

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

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

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 android.graphics.pdf.RenderParams#FLAG_RENDER_TEXT_ANNOTATIONS, android.graphics.pdf.RenderParams#FLAG_RENDER_HIGHLIGHT_ANNOTATIONS, android.graphics.pdf.RenderParams#FLAG_RENDER_STAMP_ANNOTATIONS, and android.graphics.pdf.RenderParams#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 android.graphics.pdf.RenderParams#RENDER_FORM_CONTENT_ENABLED, android.graphics.pdf.RenderParams#RENDER_FORM_CONTENT_DISABLED, or android.graphics.pdf.RenderParams#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 android.graphics.pdf.RenderParams#RENDER_MODE_FOR_DISPLAY, or android.graphics.pdf.RenderParams#RENDER_MODE_FOR_PRINT