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: [Ctors](https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#pubctors) \| [Methods](https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#inhmethods)

# RenderParams.Builder

*** ** * ** ***


`
public
static
final

class
RenderParams.Builder
`


`

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


`

`


`

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

<br />

*** ** * ** ***

Builder for constructing `https://developer.android.com/reference/android/graphics/pdf/RenderParams`.

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#Builder(int)(int renderMode) ` Create a builder for constructing a `https://developer.android.com/reference/android/graphics/pdf/RenderParams` object with the render mode. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/graphics/pdf/RenderParams` | ` https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#build()() ` Builds the `https://developer.android.com/reference/android/graphics/pdf/RenderParams` after the optional values has been set. |
| ` https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder` | ` https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#setRenderFlags(int,%20int)(int renderFlags, int mask) ` Sets the state of the render flag specified by the mask. |
| ` https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder` | ` https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#setRenderFlags(int)(int renderFlags) ` Sets the state of the render flag. |
| ` https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder` | ` https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#setRenderFormContentMode(int)(int renderFormContentMode) ` Sets the mode to include or exclude form content in rendered PDF bitmaps. |
| ` https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder` | ` https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#setRenderPageObjectFlags(int)(int flags) ` Sets the state of the render flag for page objects. |

### 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*.


## Public constructors

### Builder

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 Builder (int renderMode)
```

Create a builder for constructing a `https://developer.android.com/reference/android/graphics/pdf/RenderParams` object with the render mode.

<br />

| Parameters ||
|---|---|
| `renderMode` | `int`: render mode for the content. 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` |

## Public methods

### build

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 RenderParams build ()
```

Builds the `https://developer.android.com/reference/android/graphics/pdf/RenderParams` after the optional values has been set.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/pdf/RenderParams` | the newly constructed `https://developer.android.com/reference/android/graphics/pdf/RenderParams` object. This value cannot be `null`. <br /> |

### setRenderFlags

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 RenderParams.Builder setRenderFlags (int renderFlags, 
                int mask)
```

Sets the state of the render flag specified by the mask. To change all render flags at
once, see `https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#setRenderFlags(int)`.


When a render flag is enabled, it will be displayed on the updated
`https://developer.android.com/reference/android/graphics/Bitmap` of the renderer.


Multiple indicator types may be enabled or disabled by passing the logical OR of the
desired flags. If multiple flags are specified, they
will all be set to the same enabled state.


For example, to enable the render text annotations flag:
`setRenderFlags(FLAG_RENDER_TEXT_ANNOTATIONS, FLAG_RENDER_TEXT_ANNOTATIONS)`


To disable the render text annotations flag:
`setRenderFlags(0, FLAG_RENDER_TEXT_ANNOTATIONS)`

<br />

| Parameters ||
|---|---|
| `renderFlags` | `int`: the render flag, or the logical OR of multiple render flags. One or more of: - `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` . 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` |
| `mask` | `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` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder` | This value cannot be `null`. <br /> |

**See also:**

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

### setRenderFlags

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 RenderParams.Builder setRenderFlags (int renderFlags)
```

Sets the state of the render flag.
See `https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder#setRenderFlags(int,%20int)` for usage information.

<br />

| Parameters ||
|---|---|
| `renderFlags` | `int`: the bitmask of the render flag should be enabled, or `0` to disable all flags. 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` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder` | This value cannot be `null`. <br /> |

**See also:**

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

### setRenderFormContentMode

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 RenderParams.Builder setRenderFormContentMode (int renderFormContentMode)
```

Sets the mode to include or exclude form content in rendered PDF bitmaps. 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`.

In `https://developer.android.com/reference/android/graphics/pdf/PdfRenderer` form content is rendered by default for applications targeting
`https://developer.android.com/reference/android/os/Build.VERSION_CODES#VANILLA_ICE_CREAM` or higher. This option can be
used to enable this behavior when targeting lower SDK versions, or to disable this
behavior when targeting higher SDK versions.

In `https://developer.android.com/reference/android/graphics/pdf/PdfRendererPreV` form content is always rendered by default. This option can
be used to disable this behavior.

<br />

| Parameters ||
|---|---|
| `renderFormContentMode` | `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` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder` | This value cannot be `null`. <br /> |

### setRenderPageObjectFlags

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 RenderParams.Builder setRenderPageObjectFlags (int flags)
```

Sets the state of the render flag for page objects.
Can be one of or Bitwise OR of
`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`

<br />

| Parameters ||
|---|---|
| `flags` | `int`: The bitmask of the flags which denote which type of page objects to exclude from the page bitmap or `https://developer.android.com/reference/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_NONE` to include all types of page objects. 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` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/pdf/RenderParams.Builder` | This value cannot be `null`. <br /> |