# HighlightAnnotation

Artifact: [androidx.pdf:pdf-core](https://developer.android.com/jetpack/androidx/releases/pdf) [View Source](https://cs.android.com/search?q=file:androidx/pdf/annotation/content/HighlightAnnotation.kt+class:androidx.pdf.annotation.content.HighlightAnnotation) Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

*** ** * ** ***


```
class HighlightAnnotation : PdfAnnotation
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.pdf.annotation.content.PdfAnnotation](https://developer.android.com/reference/kotlin/androidx/pdf/annotation/content/PdfAnnotation) ||
|   | ↳ | [androidx.pdf.annotation.content.HighlightAnnotation](https://developer.android.com/reference/kotlin/androidx/pdf/annotation/content/HighlightAnnotation) |

*** ** * ** ***

Represents a Highlight Annotation in a PDF document.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/pdf/annotation/content/HighlightAnnotation#HighlightAnnotation(kotlin.Int,kotlin.collections.List,kotlin.Int)(pageNum: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, bounds: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/android/graphics/RectF.html>, color: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/annotation/content/HighlightAnnotation#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/annotation/content/HighlightAnnotation#hashCode()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/android/graphics/RectF.html>` | `https://developer.android.com/reference/kotlin/androidx/pdf/annotation/content/HighlightAnnotation#bounds()` The list of bounding `https://developer.android.com/reference/android/graphics/RectF.html` of the annotation denoting areas on the page which are highlighted. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/annotation/content/HighlightAnnotation#color()` The color of the highlight. |

### Inherited properties

From [androidx.pdf.annotation.content.PdfAnnotation](https://developer.android.com/reference/kotlin/androidx/pdf/annotation/content/PdfAnnotation) `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/pdf/annotation/content/PdfAnnotation#pageNum()`

The page number (0-indexed) where this annotation is located.

## Public constructors

### HighlightAnnotation

```
HighlightAnnotation(pageNum: Int, bounds: List<RectF>, color: Int)
```

## Public functions

### equals

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

### hashCode

```
open fun hashCode(): Int
```

## Public properties

### bounds

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
val bounds: List<RectF>
```

The list of bounding `https://developer.android.com/reference/android/graphics/RectF.html` of the annotation denoting areas on the page which are highlighted.

### color

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
val color: Int
```

The color of the highlight.