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

# Builder

*** ** * ** ***

```
class Builder
```

|---|---|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||
| ↳ | [android.graphics.pdf.RenderParams.Builder](https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams.Builder#) |

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

## Summary

| Public constructors ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams.Builder#Builder(kotlin.Int)(renderMode: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` Create a builder for constructing a `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams` object with the render mode. |

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

## Public constructors

### Builder

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

```
Builder(renderMode: Int)
```

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

| Parameters ||
|---|---|
| `renderMode` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): render mode for the content. Value is one of the following: - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_MODE_FOR_DISPLAY:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_MODE_FOR_PRINT:kotlin.Int` |

## Public methods

### build

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

```
fun build(): RenderParams
```

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

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams` | the newly constructed `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams` object. This value cannot be `null`. |

### setRenderFlags

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

```
fun setRenderFlags(renderFlags: Int): RenderParams.Builder
```

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

| Parameters ||
|---|---|
| `renderFlags` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): 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/kotlin/android/graphics/pdf/RenderParams#FLAG_RENDER_TEXT_ANNOTATIONS:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#FLAG_RENDER_HIGHLIGHT_ANNOTATIONS:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#FLAG_RENDER_STAMP_ANNOTATIONS:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#FLAG_RENDER_FREETEXT_ANNOTATIONS:kotlin.Int` |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams.Builder#` | This value cannot be `null`. |

**See Also**

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

### setRenderFlags

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

```
fun setRenderFlags(
    renderFlags: Int, 
    mask: Int
): RenderParams.Builder
```

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

When a render flag is enabled, it will be displayed on the updated `https://developer.android.com/reference/kotlin/android/graphics/Bitmap.html#` 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)`

| Parameters ||
|---|---|
| `renderFlags` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): the render flag, or the logical OR of multiple render flags. One or more of: - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#FLAG_RENDER_TEXT_ANNOTATIONS:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#FLAG_RENDER_HIGHLIGHT_ANNOTATIONS:kotlin.Int` . Value is either `0` or a combination of the following: - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#FLAG_RENDER_TEXT_ANNOTATIONS:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#FLAG_RENDER_HIGHLIGHT_ANNOTATIONS:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#FLAG_RENDER_STAMP_ANNOTATIONS:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#FLAG_RENDER_FREETEXT_ANNOTATIONS:kotlin.Int` |
| `mask` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): Value is either `0` or a combination of the following: - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#FLAG_RENDER_TEXT_ANNOTATIONS:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#FLAG_RENDER_HIGHLIGHT_ANNOTATIONS:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#FLAG_RENDER_STAMP_ANNOTATIONS:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#FLAG_RENDER_FREETEXT_ANNOTATIONS:kotlin.Int` |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams.Builder#` | This value cannot be `null`. |

**See Also**

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

### setRenderFormContentMode

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

```
fun setRenderFormContentMode(renderFormContentMode: Int): RenderParams.Builder
```

Sets the mode to include or exclude form content in rendered PDF bitmaps. One of: `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_ENABLED:kotlin.Int`, `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_DISABLED:kotlin.Int`, or `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_DEFAULT:kotlin.Int`.

In `https://developer.android.com/reference/kotlin/android/graphics/pdf/PdfRenderer` form content is rendered by default for applications targeting `https://developer.android.com/reference/kotlin/android/os/Build.VERSION_CODES.html#VANILLA_ICE_CREAM:kotlin.Int` 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/kotlin/android/graphics/pdf/PdfRendererPreV` form content is always rendered by default. This option can be used to disable this behavior.

| Parameters ||
|---|---|
| `renderFormContentMode` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): Value is one of the following: - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_ENABLED:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_DISABLED:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_FORM_CONTENT_DEFAULT:kotlin.Int` |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams.Builder#` | This value cannot be `null`. |

### setRenderPageObjectFlags

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

```
fun setRenderPageObjectFlags(flags: Int): RenderParams.Builder
```

Sets the state of the render flag for page objects. Can be one of or Bitwise OR of `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_PATH:kotlin.Int` , `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_IMAGE:kotlin.Int`, `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_TEXT:kotlin.Int`

| Parameters ||
|---|---|
| `flags` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): The bitmask of the flags which denote which type of page objects to exclude from the page bitmap or `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_NONE:kotlin.Int` to include all types of page objects. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_PATH:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_IMAGE:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_TEXT:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams#RENDER_PAGE_OBJECT_EXCLUDE_NONE:kotlin.Int` |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/graphics/pdf/RenderParams.Builder#` | This value cannot be `null`. |