RenderParams

Kotlin |Java

class RenderParams : Parcelable

The set of parameters that will be used to render the page of a PDF Document. It can be tuned to set the render mode, render flags and render form content mode.

Note: renderFlags defaults to FLAG_RENDER_NONE which means that no annotations will be rendered on the bitmap. renderFormContentMode defaults to RENDER_FORM_CONTENT_ENABLED which means that PDF form widgets (if present) will be rendered on the bitmap.

See also
`RenderParams.RenderMode`
`RenderParams.RenderFlags`
`RenderParams.RenderFormContentMode`

Summary

Constants
`const Int`	`FLAG_RENDER_FREETEXT` Flag to enable rendering of freetext annotation on the page.
`const Int`	`FLAG_RENDER_HIGHLIGHT_ANNOTATIONS` Flag to enable rendering of highlight annotation on the page.
`const Int`	`FLAG_RENDER_NONE = 0` Flag to disable rendering of all types of annotations on the page.
`const Int`	`FLAG_RENDER_STAMP_ANNOTATIONS` Flag to enable rendering of stamp annotation on the page.
`const Int`	`FLAG_RENDER_TEXT_ANNOTATIONS` Flag to enable rendering of text annotation on the page.
`const Int`	`RENDER_FORM_CONTENT_DISABLED = 2` Mode to exclude PDF form content in rendered PDF bitmaps.
`const Int`	`RENDER_FORM_CONTENT_ENABLED = 1` Mode to include PDF form content in rendered PDF bitmaps.
`const Int`	`RENDER_MODE_FOR_DISPLAY = 1` Mode to render the content for display on a screen.
`const Int`	`RENDER_MODE_FOR_PRINT = 2` Mode to render the content for printing.

Public companion properties
`Parcelable.Creator<RenderParams>`	`CREATOR`

Public constructors
`RenderParams(renderMode: Int, renderFlags: Int, renderFormContentMode: Int)`

Public functions
`open Int`	`describeContents()`
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`open Unit`	`writeToParcel(dest: Parcel, flags: Int)`

Public properties
`Int`	`renderFlags`
`Int`	`renderFormContentMode`
`Int`	`renderMode`

Constants

FLAG_RENDER_FREETEXT

const val FLAG_RENDER_FREETEXT: Int

Flag to enable rendering of freetext annotation on the page.

FLAG_RENDER_HIGHLIGHT_ANNOTATIONS

const val FLAG_RENDER_HIGHLIGHT_ANNOTATIONS: Int

Flag to enable rendering of highlight annotation on the page.

FLAG_RENDER_NONE

const val FLAG_RENDER_NONE = 0: Int

Flag to disable rendering of all types of annotations on the page.

FLAG_RENDER_STAMP_ANNOTATIONS

const val FLAG_RENDER_STAMP_ANNOTATIONS: Int

Flag to enable rendering of stamp annotation on the page.

FLAG_RENDER_TEXT_ANNOTATIONS

const val FLAG_RENDER_TEXT_ANNOTATIONS: Int

Flag to enable rendering of text annotation on the page.

RENDER_FORM_CONTENT_DISABLED

const val RENDER_FORM_CONTENT_DISABLED = 2: Int

Mode to exclude PDF form content in rendered PDF bitmaps.

RENDER_FORM_CONTENT_ENABLED

const val RENDER_FORM_CONTENT_ENABLED = 1: Int

Mode to include PDF form content in rendered PDF bitmaps.

RENDER_MODE_FOR_DISPLAY

const val RENDER_MODE_FOR_DISPLAY = 1: Int

Mode to render the content for display on a screen.

RENDER_MODE_FOR_PRINT

const val RENDER_MODE_FOR_PRINT = 2: Int

Mode to render the content for printing.

Public companion properties

CREATOR

val CREATOR: Parcelable.Creator<RenderParams>

Public constructors

RenderParams

Added in 1.0.0-alpha13

RenderParams(
    renderMode: Int,
    renderFlags: Int = FLAG_RENDER_NONE,
    renderFormContentMode: Int = RENDER_FORM_CONTENT_ENABLED
)

Public functions

describeContents

Added in 1.0.0-alpha13

open fun describeContents(): Int

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

writeToParcel

Added in 1.0.0-alpha13

open fun writeToParcel(dest: Parcel, flags: Int): Unit

Public properties

renderFlags

Added in 1.0.0-alpha13

val renderFlags: Int

renderFormContentMode

Added in 1.0.0-alpha13

val renderFormContentMode: Int

renderMode

Added in 1.0.0-alpha13

val renderMode: Int