nutrient/com.pspdfkit.annotations/WidgetAnnotation

WidgetAnnotation

open class WidgetAnnotation : LinkAnnotation

Represents the appearance of a field in interactive forms. For form elements with text, the text color comes from the color property of Annotation. Use formElement to access associated FormElement.

Types

Companion

object Companion

Constants for the WidgetAnnotation.

Properties

borderColor

@get:ColorInt

open override var borderColor: Int

Returns the border color of this annotation or Color.TRANSPARENT if no color is set. Note that alpha channel is not taken into account as per PDF specifications.

fontSize

@get:FloatRange(from = 0.0)

var fontSize: Float

The font size of this widget annotation in PDF points. If set to FONT_SIZE_AUTO, PSPDFKit will automatically adjust the font size of the annotation, so that the content fills the bounding box.

formElement

val formElement: FormElement?

Returns a form element for widget annotation.

formElementAsync

val formElementAsync: Maybe<FormElement>

Returns a form element for widget annotation, asynchronously.

type

open override val type: AnnotationType

Gets the annotation type of the annotation.

verticalTextAlignment

open override var verticalTextAlignment: VerticalTextAlignment

The vertical text alignment used by this widget annotation.