Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions) Summary: [Nested Classes](https://developer.android.com/reference/android/graphics/pdf/RenderParams#nestedclasses) \| [Constants](https://developer.android.com/reference/android/graphics/pdf/RenderParams#constants) \| [Methods](https://developer.android.com/reference/android/graphics/pdf/RenderParams#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/graphics/pdf/RenderParams#inhmethods)

# RenderParams

*** ** * ** ***


`
public

final

class
RenderParams
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.graphics.pdf.RenderParams |

<br />

*** ** * ** ***

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

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder` Builder for constructing `https://developer.android.com/reference/android/graphics/pdf/RenderParams`. |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/graphics/pdf/RenderParams#FLAG_RENDER_FREETEXT_ANNOTATIONS` Flag to enable rendering of freetext annotation on the page. |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/RenderParams#FLAG_RENDER_HIGHLIGHT_ANNOTATIONS` Flag to enable rendering of highlight annotation on the page. |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/RenderParams#FLAG_RENDER_STAMP_ANNOTATIONS` Flag to enable rendering of stamp annotation on the page. |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/RenderParams#FLAG_RENDER_TEXT_ANNOTATIONS` Flag to enable rendering of text annotation on the page. |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_DEFAULT` Mode to rely on the default behavior with respect to including PDF form content in rendered PDF bitmaps. |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_DISABLED` Mode to exclude PDF form content from rendered PDF bitmaps. |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_ENABLED` Mode to include PDF form content in rendered PDF bitmaps. |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_MODE_FOR_DISPLAY` Mode to render the content for display on a screen. |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_MODE_FOR_PRINT` Mode to render the content for printing. |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_IMAGE` Flag to exclude `https://developer.android.com/reference/android/graphics/pdf/component/PdfPageImageObject` in the rendered page bitmaps |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_NONE` Flag to include all the page objects in the rendered page bitmaps |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_PATH` Flag to exclude `https://developer.android.com/reference/android/graphics/pdf/component/PdfPagePathObject` in the rendered page bitmaps |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_TEXT` Flag to exclude `https://developer.android.com/reference/android/graphics/pdf/component/PdfPageTextObject` in the rendered page bitmaps |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/graphics/pdf/RenderParams#getRenderFlags()() ` Returns the bitmask of the render flags. |
| ` int` | ` https://developer.android.com/reference/android/graphics/pdf/RenderParams#getRenderFormContentMode()() ` Returns the mode for rendering PDF form content, one of: `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_ENABLED`, `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_DISABLED`, or `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_DEFAULT` |
| ` int` | ` https://developer.android.com/reference/android/graphics/pdf/RenderParams#getRenderMode()() ` Returns the render mode. |
| ` int` | ` https://developer.android.com/reference/android/graphics/pdf/RenderParams#getRenderPageObjectFlags()() ` Returns the bitmask of the render page object flags. |

### Inherited methods

From class `

https://developer.android.com/reference/java/lang/Object

` `


https://developer.android.com/reference/java/lang/Object` `
https://developer.android.com/reference/java/lang/Object#clone()()
`

Creates and returns a copy of this object.


`


boolean` `
https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj)
`

Indicates whether some other object is "equal to" this one.


`


void` `
https://developer.android.com/reference/java/lang/Object#finalize()()
`

Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.


`


final

https://developer.android.com/reference/java/lang/Class<?>` `
https://developer.android.com/reference/java/lang/Object#getClass()()
`

Returns the runtime class of this `Object`.


`


int` `
https://developer.android.com/reference/java/lang/Object#hashCode()()
`

Returns a hash code value for the object.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#notify()()
`

Wakes up a single thread that is waiting on this object's
monitor.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#notifyAll()()
`

Wakes up all threads that are waiting on this object's monitor.


`


https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Object#toString()()
`

Returns a string representation of the object.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos)
`

Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*, or until a
certain amount of real time has elapsed.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis)
`

Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*, or until a
certain amount of real time has elapsed.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#wait()()
`

Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*.


## Constants

### FLAG_RENDER_FREETEXT_ANNOTATIONS

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [S Extensions 18](https://developer.android.com/sdkExtensions)

```
public static final int FLAG_RENDER_FREETEXT_ANNOTATIONS
```

Flag to enable rendering of freetext annotation on the page.

<br />

**See also:**

- `https://developer.android.com/reference/android/graphics/pdf/RenderParams#getRenderFlags()`
- `https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#setRenderFlags(int)`

Constant Value:

16
(0x00000010)


### FLAG_RENDER_HIGHLIGHT_ANNOTATIONS

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public static final int FLAG_RENDER_HIGHLIGHT_ANNOTATIONS
```

Flag to enable rendering of highlight annotation on the page.

<br />

**See also:**

- `https://developer.android.com/reference/android/graphics/pdf/RenderParams#getRenderFlags()`
- `https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#setRenderFlags(int)`

Constant Value:

4
(0x00000004)


### FLAG_RENDER_STAMP_ANNOTATIONS

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [S Extensions 18](https://developer.android.com/sdkExtensions)

```
public static final int FLAG_RENDER_STAMP_ANNOTATIONS
```

Flag to enable rendering of stamp annotation on the page.

<br />

**See also:**

- `https://developer.android.com/reference/android/graphics/pdf/RenderParams#getRenderFlags()`
- `https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#setRenderFlags(int)`

Constant Value:

8
(0x00000008)


### FLAG_RENDER_TEXT_ANNOTATIONS

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public static final int FLAG_RENDER_TEXT_ANNOTATIONS
```

Flag to enable rendering of text annotation on the page.

<br />

**See also:**

- `https://developer.android.com/reference/android/graphics/pdf/RenderParams#getRenderFlags()`
- `https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#setRenderFlags(int)`

Constant Value:

2
(0x00000002)


### RENDER_FORM_CONTENT_DEFAULT

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [S Extensions 19](https://developer.android.com/sdkExtensions)

```
public static final int RENDER_FORM_CONTENT_DEFAULT
```

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

`https://developer.android.com/reference/android/graphics/pdf/PdfRenderer` will render form content by default if the application is targeting
SDK version `https://developer.android.com/reference/android/os/Build.VERSION_CODES#VANILLA_ICE_CREAM` or higher.

`https://developer.android.com/reference/android/graphics/pdf/PdfRendererPreV` will always render form content by default.

<br />

Constant Value:

3
(0x00000003)


### RENDER_FORM_CONTENT_DISABLED

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [S Extensions 19](https://developer.android.com/sdkExtensions)

```
public static final int RENDER_FORM_CONTENT_DISABLED
```

Mode to exclude PDF form content from rendered PDF bitmaps.

<br />

Constant Value:

2
(0x00000002)


### RENDER_FORM_CONTENT_ENABLED

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [S Extensions 19](https://developer.android.com/sdkExtensions)

```
public static final int RENDER_FORM_CONTENT_ENABLED
```

Mode to include PDF form content in rendered PDF bitmaps.

<br />

Constant Value:

1
(0x00000001)


### RENDER_MODE_FOR_DISPLAY

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public static final int RENDER_MODE_FOR_DISPLAY
```

Mode to render the content for display on a screen.

<br />

Constant Value:

1
(0x00000001)


### RENDER_MODE_FOR_PRINT

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public static final int RENDER_MODE_FOR_PRINT
```

Mode to render the content for printing.

<br />

Constant Value:

2
(0x00000002)


### RENDER_PAGE_OBJECT_EXCLUDE_IMAGE

Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [S Extensions 24](https://developer.android.com/sdkExtensions)

```
public static final int RENDER_PAGE_OBJECT_EXCLUDE_IMAGE
```

Flag to exclude `https://developer.android.com/reference/android/graphics/pdf/component/PdfPageImageObject` in the rendered page bitmaps

<br />

Constant Value:

4
(0x00000004)


### RENDER_PAGE_OBJECT_EXCLUDE_NONE

Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [S Extensions 24](https://developer.android.com/sdkExtensions)

```
public static final int RENDER_PAGE_OBJECT_EXCLUDE_NONE
```

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

<br />

Constant Value:

0
(0x00000000)


### RENDER_PAGE_OBJECT_EXCLUDE_PATH

Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [S Extensions 24](https://developer.android.com/sdkExtensions)

```
public static final int RENDER_PAGE_OBJECT_EXCLUDE_PATH
```

Flag to exclude `https://developer.android.com/reference/android/graphics/pdf/component/PdfPagePathObject` in the rendered page bitmaps

<br />

Constant Value:

2
(0x00000002)


### RENDER_PAGE_OBJECT_EXCLUDE_TEXT

Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [S Extensions 24](https://developer.android.com/sdkExtensions)

```
public static final int RENDER_PAGE_OBJECT_EXCLUDE_TEXT
```

Flag to exclude `https://developer.android.com/reference/android/graphics/pdf/component/PdfPageTextObject` in the rendered page bitmaps

<br />

Constant Value:

8
(0x00000008)


## Public methods

### getRenderFlags

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public int getRenderFlags ()
```

Returns the bitmask of the render flags.

<br />

| Returns ||
|---|---|
| `int` | Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/graphics/pdf/RenderParams#FLAG_RENDER_TEXT_ANNOTATIONS` - `https://developer.android.com/reference/android/graphics/pdf/RenderParams#FLAG_RENDER_HIGHLIGHT_ANNOTATIONS` - `https://developer.android.com/reference/android/graphics/pdf/RenderParams#FLAG_RENDER_STAMP_ANNOTATIONS` - `https://developer.android.com/reference/android/graphics/pdf/RenderParams#FLAG_RENDER_FREETEXT_ANNOTATIONS` |

### getRenderFormContentMode

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [S Extensions 19](https://developer.android.com/sdkExtensions)

```
public int getRenderFormContentMode ()
```

Returns the mode for rendering PDF form content, one of:
`https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_ENABLED`, `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_DISABLED`, or
`https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_DEFAULT`

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_ENABLED` - `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_DISABLED` - `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_DEFAULT` |

### getRenderMode

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public int getRenderMode ()
```

Returns the render mode.

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_MODE_FOR_DISPLAY` - `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_MODE_FOR_PRINT` |

### getRenderPageObjectFlags

Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [S Extensions 24](https://developer.android.com/sdkExtensions)

```
public int getRenderPageObjectFlags ()
```

Returns the bitmask of the render page object flags.

<br />

| Returns ||
|---|---|
| `int` | Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_PATH` - `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_IMAGE` - `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_TEXT` - `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_NONE` |

**See also:**

- `https://developer.android.com/`