--- title: "Annotation Configuration" canonical_url: "https://www.nutrient.io/guides/android/samples/annotation-configuration-kotlin/" md_url: "https://www.nutrient.io/guides/android/samples/annotation-configuration-kotlin.md" last_updated: "2026-05-15T19:10:04.916Z" description: "Customize default properties and editable properties for each annotation type." --- # Annotation Configuration Customize default properties and editable properties for each annotation type. [Get Started](https://www.nutrient.io/sdk/android/getting-started.md) [All Samples](https://www.nutrient.io/guides/android/samples.md) [Download](https://www.nutrient.io/guides/android/downloads.md) [Launch Demo](https://www.nutrient.io/demo/) --- ```kotlin /* * Copyright © 2020-2026 PSPDFKit GmbH. All rights reserved. * * The PSPDFKit Sample applications are licensed with a modified BSD license. * Please see License for details. This notice may not be removed from this file. */ package com.pspdfkit.catalog.examples.kotlin import android.content.Context import android.graphics.Color import android.graphics.Typeface import android.net.Uri import androidx.annotation.UiThread import com.pspdfkit.annotations.AnnotationType import com.pspdfkit.annotations.configuration.AnnotationProperty import com.pspdfkit.annotations.configuration.FreeTextAnnotationConfiguration import com.pspdfkit.annotations.configuration.InkAnnotationConfiguration import com.pspdfkit.annotations.configuration.MarkupAnnotationConfiguration import com.pspdfkit.catalog.R import com.pspdfkit.catalog.SdkExample import com.pspdfkit.catalog.tasks.ExtractAssetTask import com.pspdfkit.configuration.activity.PdfActivityConfiguration import com.pspdfkit.document.PdfDocument import com.pspdfkit.ui.PdfActivity import com.pspdfkit.ui.PdfActivityIntentBuilder import com.pspdfkit.ui.PdfFragment import com.pspdfkit.ui.fonts.Font import com.pspdfkit.ui.special_mode.controller.AnnotationTool import com.pspdfkit.ui.special_mode.controller.AnnotationToolVariant import java.util.EnumSet /** * This example shows how to change the annotation configuration in a [PdfActivity] or [PdfFragment]. */ class AnnotationConfigurationExample(context: Context) : SdkExample(context, R.string.annotationConfigurationExampleTitle, R.string.annotationConfigurationExampleDescription) { override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) { // Extract the example document from the app's assets. ExtractAssetTask.extract(WELCOME_DOC, title, context) { documentFile -> // To start the AnnotationConfigurationExampleActivity create a launch intent using the builder. val intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile)).configuration(configuration.build()).activityClass(AnnotationConfigurationExampleActivity::class).build() context.startActivity(intent) } } } /** * Annotation configurations can be used to define the default properties of annotations created * with annotation tools inside a [PdfFragment], as well as the available annotation properties that * can be modified when creating or editing annotations in the fragment. * * The annotation configuration is local to a specific [PdfFragment] instance, and therefore has to * be configured per [PdfFragment] instance. To change the annotation configuration, it is necessary * to extend [PdfActivity] and call the approriate APIs on the hosted fragment. */ class AnnotationConfigurationExampleActivity : PdfActivity() { @UiThread override fun onDocumentLoaded(document: PdfDocument) { super.onDocumentLoaded(document) // Configurations can be defined for any given annotation type... configureFreeTextAnnotationType() //... or for particular annotation tools and their tool variants. configureInkTool() // This example shows how to disable the annotation inspector for highlight annotations. configureHighlightWithNoEditableProperties() } private fun configureFreeTextAnnotationType() { // The annotation configuration can be configured through `PdfFragment` for each annotation type. requirePdfFragment().annotationConfiguration.put( AnnotationType.FREETEXT, FreeTextAnnotationConfiguration.builder(this) // Configure which color is used when creating free-text annotations..setDefaultColor(Color.rgb(0, 0, 0)) // Configure which colors are going to be available in the color picker..setAvailableColors( listOf( Color.rgb(255, 255, 255), Color.rgb(224, 224, 224), Color.rgb(158, 158, 158), Color.rgb(66, 66, 66), Color.rgb(0, 0, 0), ), ) // Configure the custom font to use.setForceDefaults(true).setDefaultFont(Font("Meddon", Typeface.SANS_SERIF)) // Configure the default text size (in pt)..setDefaultTextSize(24f) // Only the color property will be editable in the annotation inspector..setSupportedProperties(EnumSet.of(AnnotationProperty.COLOR, AnnotationProperty.FONT)) // Disable the annotation preview for free-text annotation..setPreviewEnabled(false).build(), ) } private fun configureInkTool() { // In addition to defining configurations per annotation type, you can specify different // configurations based on the annotation tool that is used to create annotations. For example, // multiple tools exist that can create ink annotations, such as the `AnnotationTool.INK` or // the `AnnotationTool.SIGNATURE`, and each of them can have a different configuration which // defines default properties, and the set of modifiable properties. requirePdfFragment().annotationConfiguration.put( AnnotationTool.INK, InkAnnotationConfiguration.builder(this) // Configure which color is used when creating ink annotations..setDefaultColor(Color.rgb(252, 237, 140)) // Configure which colors are going to be available in the color picker..setAvailableColors( listOf( Color.rgb(244, 67, 54), // RED Color.rgb(139, 195, 74), // LIGHT GREEN Color.rgb(33, 150, 243), // BLUE Color.rgb(252, 237, 140), // YELLOW Color.rgb(233, 30, 99), // PINK ), ) // Configure thickness picker range and default thickness..setDefaultThickness(5f).setMinThickness(1f).setMaxThickness(20f) // When `true` attributes like default color are always used as default when // creating annotations. When `false` last edited value is used, value from // configuration is used only when creating annotation for the first time..setForceDefaults(true).setPreviewEnabled(false).build(), ) // Annotation configuration can be also specified for the annotation tool variant. requirePdfFragment().annotationConfiguration.put( AnnotationTool.INK, AnnotationToolVariant.fromPreset(AnnotationToolVariant.Preset.HIGHLIGHTER), InkAnnotationConfiguration.builder(this) // Configure which color is used when creating ink annotations..setDefaultColor(Color.rgb(252, 237, 140)) // Configure which colors are going to be available in the color picker..setAvailableColors( listOf( Color.rgb(244, 67, 54), // RED Color.rgb(139, 195, 74), // LIGHT GREEN Color.rgb(33, 150, 243), // BLUE Color.rgb(252, 237, 140), // YELLOW Color.rgb(233, 30, 99), // PINK ), ) // Configure thickness picker range and default thickness..setDefaultThickness(5f).setMinThickness(1f).setMaxThickness(20f).setForceDefaults(true).setPreviewEnabled(false).build(), ) } /** * Shows how to disable annotation inspector for highlight annotation. */ private fun configureHighlightWithNoEditableProperties() { requirePdfFragment().annotationConfiguration.put( AnnotationType.HIGHLIGHT, MarkupAnnotationConfiguration.builder(this, AnnotationType.HIGHLIGHT) // Makes yellow default highlight color..setDefaultColor(Color.rgb(252, 237, 140)) // Configure no supported properties. This disables annotation inspector..setSupportedProperties(EnumSet.noneOf(AnnotationProperty::class.java)).build(), ) } } ``` This code sample is an example that illustrates how to use our SDK. Please adapt it to your specific use case. --- ## Related pages - [Application Policy](/guides/android/samples/application-policy-kotlin.md) - [Custom Form Highlight Color](/guides/android/samples/custom-form-highlight-color-java.md) - [Custom Page Templates](/guides/android/samples/custom-page-templates-java.md) - [Digital Signature (Basic)](/guides/android/samples/digital-signature-basic-kotlin.md) - [Disabled Annotation Property](/guides/android/samples/disabled-annotation-property-java.md) - [Image Document](/guides/android/samples/image-document-kotlin.md) - [Compose Image Document](/guides/android/samples/compose-image-document-kotlin.md) - [Inline Multimedia](/guides/android/samples/inline-multimedia-kotlin.md) - [JavaScript Form Filling](/guides/android/samples/javascript-form-filling-kotlin.md) - [Overlay Visibility](/guides/android/samples/overlay-visibility-kotlin.md) - [PdfFragment](/guides/android/samples/pdffragment-kotlin.md) - [Reader View](/guides/android/samples/reader-view-kotlin.md) - [Playground](/guides/android/samples/playground-kotlin.md) - [JavaScript Calculator](/guides/android/samples/javascript-calculator-kotlin.md) - [Text Field Suggestions](/guides/android/samples/text-field-suggestions-kotlin.md) - [Thumbnail Bar Modes](/guides/android/samples/thumbnail-bar-modes-kotlin.md) - [Signature Storage Database](/guides/android/samples/signature-storage-database-kotlin.md) - [Selection Customization](/guides/android/samples/selection-customization-java.md) - [Password Protected PDF](/guides/android/samples/password-protected-pdf-kotlin.md) - [Scientific Paper](/guides/android/samples/scientific-paper-kotlin.md) - [Try Instant](/guides/android/samples/try-instant-kotlin.md) - [Merge Documents](/guides/android/samples/merge-documents-kotlin.md) - [Annotation Rendering](/guides/android/samples/annotation-rendering-kotlin.md) - [Custom Data Provider](/guides/android/samples/custom-data-provider-kotlin.md) - [Annotations with Transparency](/guides/android/samples/annotations-with-transparency-kotlin.md) - [Annotation Flags](/guides/android/samples/annotation-flags-kotlin.md) - [AI Assistant (Multiple Documents, ViewPager)](/guides/android/samples/ai-assistant-multiple-documents-viewpager-kotlin.md) - [Custom Sharing Menu](/guides/android/samples/custom-sharing-menu-java.md) - [Add LTV to Existing Signature](/guides/android/samples/add-ltv-to-existing-signature-kotlin.md) - [Custom Toolbar Grouping](/guides/android/samples/custom-toolbar-grouping-java.md) - [Custom Layout](/guides/android/samples/custom-layout-kotlin.md) - [Custom ActionBar Actions](/guides/android/samples/custom-actionbar-actions-kotlin.md) - [Custom Activity Toolbars](/guides/android/samples/custom-activity-toolbars-java.md) - [Custom Note Hinter](/guides/android/samples/custom-note-hinter-kotlin.md) - [Custom Main Toolbar](/guides/android/samples/custom-main-toolbar-kotlin.md) - [Annotation Selection Styling](/guides/android/samples/annotation-selection-styling-kotlin.md) - [Custom Search UI (Compose)](/guides/android/samples/custom-search-ui-compose-kotlin.md) - [Document Switcher](/guides/android/samples/document-switcher-java.md) - [File Annotation Creation](/guides/android/samples/file-annotation-creation-kotlin.md) - [Dynamic Pages on Scroll](/guides/android/samples/dynamic-pages-on-scroll-kotlin.md) - [Custom Activity Form Editing](/guides/android/samples/custom-activity-form-editing-java.md) - [Custom Stamp Annotations](/guides/android/samples/custom-stamp-annotations-java.md) - [Custom Outline Provider](/guides/android/samples/custom-outline-provider-kotlin.md) - [Compose Navigation](/guides/android/samples/compose-navigation-kotlin.md) - [Fragment Runtime Configuration](/guides/android/samples/fragment-runtime-configuration-kotlin.md) - [Annotation Overlay](/guides/android/samples/annotation-overlay-java.md) - [Instant Document JSON](/guides/android/samples/instant-document-json-kotlin.md) - [DocumentView Composable](/guides/android/samples/documentview-composable-kotlin.md) - [Form Creation](/guides/android/samples/form-creation-kotlin.md) - [Document Download](/guides/android/samples/document-download-kotlin.md) - [JavaScript Actions](/guides/android/samples/javascript-actions-kotlin.md) - [Instant JSON Attachment](/guides/android/samples/instant-json-attachment-kotlin.md) - [Digital Signature (Manual)](/guides/android/samples/digital-signature-manual-kotlin.md) - [Digital Signature (Third-Party)](/guides/android/samples/digital-signature-third-party-kotlin.md) - [Inline Search](/guides/android/samples/inline-search-java.md) - [Form Filling](/guides/android/samples/form-filling-kotlin.md) - [Form Click Intercept (Compose)](/guides/android/samples/form-click-intercept-compose-kotlin.md) - [Document Sharing](/guides/android/samples/document-sharing-java.md) - [Custom Download Dialog](/guides/android/samples/custom-download-dialog-java.md) - [Download Progress](/guides/android/samples/download-progress-kotlin.md) - [Popup Toolbar Customization](/guides/android/samples/popup-toolbar-customization-kotlin.md) - [Custom Sharing Dialog](/guides/android/samples/custom-sharing-dialog-java.md) - [PDF from Image](/guides/android/samples/pdf-from-image-kotlin.md) - [Digital Signature (Two-Step)](/guides/android/samples/digital-signature-two-step-kotlin.md) - [Remote URL](/guides/android/samples/remote-url-kotlin.md) - [PdfUiFragment](/guides/android/samples/pdfuifragment-kotlin.md) - [Runtime Configuration](/guides/android/samples/runtime-configuration-kotlin.md) - [Sound Extraction](/guides/android/samples/sound-extraction-kotlin.md) - [Document from Canvas](/guides/android/samples/document-from-canvas-kotlin.md) - [Tabbed Documents](/guides/android/samples/tabbed-documents-kotlin.md) - [Watermarks](/guides/android/samples/watermarks-kotlin.md) - [Programmatic Zoom](/guides/android/samples/programmatic-zoom-kotlin.md) - [Signature Parcelize](/guides/android/samples/signature-parcelize-kotlin.md) - [OCR](/guides/android/samples/ocr-kotlin.md) - [Vertical Scrollbar](/guides/android/samples/vertical-scrollbar-java.md) - [Split View](/guides/android/samples/split-view-java.md) - [XFDF Import/Export](/guides/android/samples/xfdf-import-export-kotlin.md) - [UI View Modes](/guides/android/samples/ui-view-modes-kotlin.md) - [LTV Signature](/guides/android/samples/ltv-signature-kotlin.md) - [Bookmark Highlighting](/guides/android/samples/bookmark-highlighting-kotlin.md) - [Custom Annotation Inspector](/guides/android/samples/custom-annotation-inspector-java.md) - [Annotation Sidebar](/guides/android/samples/annotation-sidebar-kotlin.md) - [AI Assistant (Single Document)](/guides/android/samples/ai-assistant-single-document-kotlin.md) - [AI Assistant (Multiple Documents, Compose)](/guides/android/samples/ai-assistant-multiple-documents-compose-kotlin.md) - [Document Comparison](/guides/android/samples/document-comparison-kotlin.md) - [Document Processing](/guides/android/samples/document-processing-kotlin.md) - [Custom Annotation Creation Toolbar](/guides/android/samples/custom-annotation-creation-toolbar-java.md) - [Custom Electronic Signature](/guides/android/samples/custom-electronic-signature-java.md) - [E-Learning](/guides/android/samples/e-learning-kotlin.md) - [Electronic + Digital Signing](/guides/android/samples/electronic-digital-signing-kotlin.md) - [Generate PDF Report](/guides/android/samples/generate-pdf-report-kotlin.md) - [Multimedia Annotations](/guides/android/samples/multimedia-annotations-kotlin.md) - [Forms with JavaScript](/guides/android/samples/forms-with-javascript-kotlin.md) - [External Document](/guides/android/samples/external-document-kotlin.md) - [Overlay Views](/guides/android/samples/overlay-views-kotlin.md) - [Kiosk Grid](/guides/android/samples/kiosk-grid-kotlin.md) - [Search Indexing](/guides/android/samples/search-indexing-kotlin.md) - [Annotation Creation](/guides/android/samples/annotation-creation-kotlin.md) - [Filterable Thumbnail Grid](/guides/android/samples/filterable-thumbnail-grid-kotlin.md) - [Tabbed Documents (Persistent)](/guides/android/samples/tabbed-documents-persistent-kotlin.md) - [Measurement Tools](/guides/android/samples/measurement-tools-kotlin.md) - [HTML-to-PDF Conversion](/guides/android/samples/html-to-pdf-conversion-kotlin.md) - [AES Encrypted File](/guides/android/samples/aes-encrypted-file-java.md) - [Construction Floor Plan](/guides/android/samples/construction-floor-plan-kotlin.md) - [Hide and Reveal Areas](/guides/android/samples/hide-and-reveal-areas-kotlin.md) - [Multiple Documents (Compose Pager)](/guides/android/samples/multiple-documents-compose-pager-kotlin.md) - [Screen Reader](/guides/android/samples/screen-reader-java.md) - [Custom Search UI (Views)](/guides/android/samples/custom-search-ui-views-java.md)