PdfViewer Methods

Allows you to display PDF files in .NET MAUI apps.

Name	Description
AddCircleAnnotation(Int32, PdfRectangle)	Adds a circle contained within rectangular boundaries on a page with the given index.
AddFreeTextAnnotation(Int32, PdfRectangle, String)	Adds a text annotation contained within rectangular boundaries on a page with the given index.
AddInkAnnotation(Int32, IList<IList<PdfPoint>>)	Adds a free-hand drawing on a page with the given index.
AddSignature(Int32, IList<IList<PdfPoint>>)	Adds a signature defined by a collection of points on the given page.
AddSquareAnnotation(Int32, PdfRectangle)	Adds a rectangle with the specified boundaries on a page with the given index.
AddStickyNoteAnnotation(PdfDocumentPosition, String)	Adds a sticky note annotation.
ApplyBindings() protected	Applies all the current bindings to BindingContext. Inherited from BindableObject.
BatchBegin()	Signals the start of a batch of changes to the elements properties. This can benefit performance if a bigger number of property values are changed. Inherited from VisualElement.
BatchCommit()	Signals the end of a batch of commands to the element and that those commands should now be committed. Inherited from VisualElement.
ChangeVisualState() protected	Changes the current visual state based on this elements current property values. Inherited from VisualElement.
ClearSelection()	Resets the selection.
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.
CloseDocument()	Closes the current document.
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. | | ColorTo(Color, Color, Int32) | Changes background and border colors with a smooth animation effect. The ColorTo method returns the Task that ends when animation completes. Inherited from DXViewBase. | | CopySelection() | Copies the selected content to the clipboard. | | DeleteAnnotation(IPdfViewerAnnotation) | Removes the given annotation from the PDF viewer annotation collection. | | DeleteSignature(PdfHandwrittenSignature) | Removes the given signature. | | 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. | | ExportFormFieldData(Stream, PdfFormDataFormat) | Exports field data to a stream in the specified format. | | FindByName(String) | Returns the element that has the specified name. Inherited from Element. | | Focus() | Attempts to set focus to this element. Inherited from VisualElement. | | FocusNextFormField() | Goes to the next field in the document. If no field is focused, this method does not focus any fields. | | FocusPreviousFormField() | Goes to the previous field in the document. If no field is focused, this method does not focus any fields. | | GetChildElements(Point) | Gets the child elements that are visually beneath the specified point. Inherited from View. | | GetHashCode() | Serves as the default hash function. Inherited from System.Object. | | GetSelectedContent() | Returns an object that contains the selected content. | | 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. | | HighlightSelectedText(Color) | Highlights selected text with a filled rectangle. | | ImportFormFieldData(Stream) | Imports field data from a stream in the specified format. | | InvalidateMeasure() protected | Marks the current measure of an element as invalidated. Inherited from VisualElement. | | InvalidateMeasureNonVirtual(InvalidationTrigger) | Invalidates the measure of an element. Inherited from VisualElement. | | IsSet(BindableProperty) | Determines whether or not a bindable property exists and has a value set. Inherited from BindableObject. | | Measure(Double, Double, MeasureFlags) | Returns the minimum size that an element needs in order to be displayed on the device. Inherited from VisualElement. | | 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 View changes. Inherited from View. | | OnChildAdded(Element) protected | Invoked when a child object is added to this element. Inherited from VisualElement. | | OnChildRemoved(Element, Int32) protected | Invoked when a child object is removed from this element. Inherited from VisualElement. | | OnChildrenReordered() protected | Raises the ChildrenReordered event. Inherited from VisualElement. | | OnMeasure(Double, Double) protected | Method that is called when a layout measurement happens. Inherited from VisualElement. | | OnPropertyChanging(String) protected | Raises the PropertyChanging event. Inherited from BindableObject. | | PrintDocumentAsync(String) | Invokes the system print dialog. | | Redo() | Reapplies the last undone action in the PDF viewer. | | 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. | | SaveDocumentAsync(Stream) | Saves the current PDF document to a stream. | | SelectNextAnnotation() | Selects the next annotation in the current document. | | SelectPreviousAnnotation() | Selects the previous annotation in the Annotations collection. | | SetBinding(BindableProperty, BindingBase) | Assigns a binding to a bindable property. Inherited from BindableObject. | | SetDocumentSourceAsync(PdfDocumentSource) | Opens the PDF document passed in method parameters. | | 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. | | ShareDocumentAsync(String) | Invokes the share UI that prompts the user to choose an app to share with. | | ShowOpenFileDialogAsync() | Invokes the platform-based file explorer. | | ShowSaveFileDialogAsync(String) | Invokes the system file picker dialog to save the current PDF document. | | SizeAllocated(Double, Double) protected | Method that is called during a layout cycle to signal the start of a sub-tree layout. Inherited from VisualElement. | | SquiggleSelectedText(Color) | Underlines selected text with a squiggle line. | | StrikethroughSelectedText(Color) | Applies strikethrough to selected text. | | 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. | | UnderlineSelectedText(Color) | Underlines the selected text with a straight line. | | Undo() | Cancels the previous action. | | Unfocus() | Unsets keyboard focus on this element. Inherited from VisualElement. |