Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

PdfAnnotationOptions Members

Contains settings that the PDF viewer applies to annotations.

#Constructors

Name Description
PdfAnnotationOptions() Initializes a new instance of the PdfAnnotationOptions class.

#Fields
Show Inherited Hide Inherited

Name Description
AllowAddCircleProperty static Identifies the AllowAddCircle bindable property.
AllowAddFreeTextProperty static Identifies the AllowAddFreeText bindable property.
AllowAddInkProperty static Identifies the AllowAddInk bindable property.
AllowAddSquareProperty static Identifies the AllowAddSquare bindable property.
AllowAddStickyNoteProperty static Identifies the AllowAddStickyNote bindable property.
AllowHighlightProperty static Identifies the AllowHighlight bindable property.
AllowSquiggleProperty static Identifies the AllowSquiggle bindable property.
AllowStrikethroughProperty static Identifies the AllowStrikethrough bindable property.
AllowUnderlineProperty static Identifies the AllowUnderline bindable property.
AuthorProperty static Identifies the Author bindable property.
AutomationIdProperty static Bindable property for AutomationId. Inherited from Element.
BindingContextProperty static Bindable property for BindingContext. Inherited from BindableObject.
CircleColorProperty static Identifies the CircleColor bindable property.
CircleLineWidthProperty static Identifies the CircleLineWidth bindable property.
CircleSubjectProperty static Identifies the CircleSubject bindable property.
ClassIdProperty static Bindable property for ClassId. Inherited from Element.
FreeTextColorProperty static Identifies the FreeTextColor bindable property.
FreeTextFontSizeProperty static Identifies the FreeTextFontSize bindable property.
FreeTextSubjectProperty static Identifies the FreeTextSubject bindable property.
HighlightColorProperty static Identifies the HighlightColor bindable property.
HighlightSubjectProperty static Identifies the HighlightSubject bindable property.
InkColorProperty static Identifies the InkColor bindable property.
InkLineWidthProperty static Identifies the InkLineWidth bindable property.
InkSubjectProperty static Identifies the InkSubject bindable property.
SquareColorProperty static Identifies the SquareColor bindable property.
SquareLineWidthProperty static Identifies the SquareLineWidth bindable property.
SquareSubjectProperty static Identifies the SquareSubject bindable property.
SquiggleColorProperty static Identifies the SquiggleColor bindable property.
SquiggleSubjectProperty static Identifies the SquiggleSubject bindable property.
StickyNoteColorProperty static Identifies the StickyNoteColor bindable property.
StickyNoteSubjectProperty static Identifies the StickyNoteSubject bindable property.
StrikethroughColorProperty static Identifies the StrikethroughColor bindable property.
StrikethroughSubjectProperty static Identifies the StrikethroughSubject bindable property.
UnderlineColorProperty static Identifies the UnderlineColor bindable property.
UnderlineSubjectProperty static Identifies the UnderlineSubject bindable property.

#Properties
Show Inherited Hide Inherited

Name Description
AllowAddCircle Gets or sets whether the Add Circle functionality is available. This is a bindable property.
AllowAddFreeText Gets or sets whether the Add Free Text functionality is available. This is a bindable property.
AllowAddInk Gets or sets whether the Add Ink functionality is available. This is a bindable property.
AllowAddSquare Gets or sets whether the Add Square functionality is available. This is a bindable property.
AllowAddStickyNote Gets or sets whether the Add Sticky Note functionality is available. This is a bindable property.
AllowHighlight Gets or sets whether to allow users to highlight the selected text with a rounded rectangle. This is a bindable property.
AllowSquiggle Gets or sets whether to allow users to underline the selected text with a squiggle line. This is a bindable property.
AllowStrikethrough Gets or sets whether to allow users to strikethrough the selected text with a straight line. This is a bindable property.
AllowUnderline Gets or sets whether to allow users to underline the selected text with a straight line. This is a bindable property.
Author Gets or sets the annotation author. This is a bindable property.
AutomationId Gets or sets a value that allows the automation framework to find and interact with this element. Inherited from Element.
BindingContext

Gets or sets an object that contains the properties that will be targeted by the bound properties that belong to this BindableObject. This is a bindable property.

Inherited from BindableObject.
CircleColor Gets or sets the circle annotation outline color. This is a bindable property.
CircleLineWidth Gets or sets the circle annotation’s outline width. This is a bindable property.
CircleSubject Gets or sets the subject for comments assigned to circle annotations.
ClassId Gets or sets a value used to identify a collection of semantically similar elements. Inherited from Element.
Dispatcher

Gets the dispatcher that was available when this bindable object was created, otherwise tries to find the nearest available dispatcher (probably the window’s/app’s).

Inherited from BindableObject.
EffectControlProvider For internal use by .NET MAUI. Inherited from Element.
Effects Gets or sets the styles and properties that will be applied to the element during runtime. Inherited from Element.
FreeTextColor Gets or sets the text annotation color. This is a bindable property.
FreeTextFontSize Gets or sets the text annotation’s font size. This is a bindable property.
FreeTextSubject Gets or sets the subject for comments assigned to free text annotations.
HighlightColor Gets or sets the highlight color. This is a bindable property.
HighlightSubject Gets or sets the subject for comments assigned to highlights.
Id Gets a value that can be used to uniquely identify an element throughout the run of your application. Inherited from Element.
InkColor Gets or sets the color that is used for free-hand drawing. This is a bindable property.
InkLineWidth Gets or sets the ink line width. This is a bindable property.
InkSubject Gets or sets the subject for comments assigned to free-hand inked drawing annotations.
LogicalChildren For internal use by the Microsoft.Maui.Controls platform. Inherited from Element.
Parent Gets or sets the parent Element of this element. Inherited from Element.
RealParent For internal use by .NET MAUI. Inherited from Element.
SquareColor Gets or sets the square annotation outline color. This is a bindable property.
SquareLineWidth Gets or sets the square annotation’s outline width. This is a bindable property.
SquareSubject Gets or sets the subject for comments assigned to square annotations.
SquiggleColor Gets or sets the color of a wavy line used to underline the selected text.
SquiggleSubject Gets or sets the subject for comments assigned to wavy underlines.
StickyNoteColor Gets or sets the fill color of sticky notes. This is a bindable property.
StickyNoteSubject Gets or sets the subject for comments assigned to circle annotations.
StrikethroughColor Gets or sets the color of a line used to strike out the selected text.
StrikethroughSubject Gets or sets the subject for comments assigned to strikethrough text annotations.
StyleId Gets or sets a user defined value to uniquely identify the element. Inherited from Element.
UnderlineColor Gets or sets the color of a line used to underline the selected text.
UnderlineSubject Gets or sets the subject for comments assigned to strikethrough text annotations.

#Methods
Show Inherited Hide Inherited

Name Description
ApplyBindings() protected Applies all the current bindings to BindingContext. Inherited from BindableObject.
ClearValue(BindableProperty) Clears any value that is previously set for a bindable property. Inherited from BindableObject.
ClearValue(BindablePropertyKey) Clears any value that is previously set for a bindable property, identified by its key. Inherited from BindableObject.
CoerceValue(BindableProperty)

Coerces the value of the specified bindable property. This is done by invoking BindableProperty.CoerceValueDelegate of the specified bindable property.

Inherited from BindableObject.
CoerceValue(BindablePropertyKey)

Coerces the value of the specified bindable property. This is done by invoking BindableProperty.CoerceValueDelegate of the specified bindable property.

Inherited from BindableObject.
EffectIsAttached(String) For internal use by .NET MAUI. Inherited from Element.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from System.Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from System.Object.
FindByName(String) Returns the element that has the specified name. Inherited from Element.
GetHashCode() Serves as the default hash function. Inherited from System.Object.
GetType() Gets the Type of the current instance. Inherited from System.Object.
GetValue(BindableProperty) Returns the value that is contained in the given bindable property. Inherited from BindableObject.
IsSet(BindableProperty) Determines whether or not a bindable property exists and has a value set. Inherited from BindableObject.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from System.Object.
IElementController.SetValueFromRenderer(BindableProperty, Object) For internal use by .NET MAUI. Inherited from Element.
OnBindingContextChanged() protected Invoked whenever the binding context of the element changes. Implement this method to add class handling for this event. Inherited from Element.
OnChildAdded(Element) protected Raises the ChildAdded event. Implement this method to add class handling for this event. Inherited from Element.
OnChildRemoved(Element, Int32) protected Raises the ChildRemoved event. Implement this method to add class handling for this event Inherited from Element.
OnParentSet() protected Raises the (internal) ParentSet event. Implement this method in order to add behavior when the element is added to a parent. Inherited from Element.
OnPropertyChanging(String) protected Raises the PropertyChanging event. Inherited from BindableObject.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from System.Object.
RemoveBinding(BindableProperty) Removes a previously set binding from a bindable property. Inherited from BindableObject.
RemoveDynamicResource(BindableProperty) Removes a previously set dynamic resource. Inherited from Element.
SetBinding(BindableProperty, BindingBase) Assigns a binding to a bindable property. Inherited from BindableObject.
SetDynamicResource(BindableProperty, String) Sets the BindableProperty property of this element to be updated via the DynamicResource with the provided key. Inherited from Element.
SetInheritedBindingContext(BindableObject, Object) static Sets the inherited context to a nested element. Inherited from BindableObject.
SetValue(BindableProperty, Object) Sets the value of the specified bindable property. Inherited from BindableObject.
SetValue(BindablePropertyKey, Object) Sets the value of the specified bindable property. Inherited from BindableObject.
SetValueCore(BindableProperty, Object, SetValueFlags) For internal use by the Microsoft.Maui.Controls platform. Inherited from BindableObject.
SetValueFromRenderer(BindableProperty, Object) For internal use by .NET MAUI. Inherited from Element.
SetValueFromRenderer(BindablePropertyKey, Object) For internal use by .NET MAUI. Inherited from Element.
ToString() Returns a string that represents the current object. Inherited from System.Object.
UnapplyBindings() protected Removes all current bindings from the current context. Inherited from BindableObject.

#Events
Show Inherited Hide Inherited

Name Description
BindingContextChanged Occurs when the value of the BindingContext property changes. Inherited from BindableObject.
ChildAdded Raised whenever a child element is added to the element. Inherited from Element.
ChildRemoved Raised whenever a child element is removed from the element. Inherited from Element.
DescendantAdded Raised whenever a child element is added to the element’s subtree. Inherited from Element.
DescendantRemoved Raised whenever a child element is removed from the elements subtree. Inherited from Element.
PropertyChanged Occurs when a property value changes. Inherited from BindableObject.
PropertyChanging Occurs when a property value is changing. Inherited from BindableObject.
See Also