Class SfPdfViewer

Represents a view control that displays PDF documents.

Inheritance
System.Object
SfPdfViewer
Implements
System.IDisposable
Android.Views.View.IOnTouchListener
Android.Runtime.IJavaObject
Java.Interop.IJavaPeerable
Namespace: Syncfusion.SfPdfViewer.Android
Assembly: Syncfusion.SfPdfViewer.Android.dll
Syntax
public class SfPdfViewer : FrameLayout, IDisposable, View.IOnTouchListener, IJavaObject, IJavaPeerable

Constructors

SfPdfViewer(Context)

Initializes a new instance of the SfPdfViewer class with the specified context.

Declaration
public SfPdfViewer(Context context)
Parameters
Type Name Description
Android.Content.Context context

Contains information about the application environment.

SfPdfViewer(Context, IAttributeSet)

Initializes a new instance of the SfPdfViewer class with the specified context and attributes.

Declaration
public SfPdfViewer(Context context, IAttributeSet attrs)
Parameters
Type Name Description
Android.Content.Context context

Contains information about the application’s environment.
Android.Util.IAttributeSet attrs

Collection of attributes as found associated with a tag in an XML document.

SfPdfViewer(Context, IAttributeSet, Int32)

Initializes a new instance of the SfPdfViewer class with the specified context and attributes.

Declaration
public SfPdfViewer(Context context, IAttributeSet attributeSet, int definedStyle)
Parameters
Type Name Description
Android.Content.Context context

Contains information about the application’s environment.
Android.Util.IAttributeSet attributeSet

Collection of attributes as found associated with a tag in an XML document.
System.Int32 definedStyle

The value indicating the defined style.

SfPdfViewer(Context, IAttributeSet, Int32, Int32)

Initializes a new instance of the SfPdfViewer class with the specified context and attributes.

Declaration
public SfPdfViewer(Context context, IAttributeSet attribute, int defaultStyleAttribute, int defaultStyleResource)
Parameters
Type Name Description
Android.Content.Context context

Contains information about the application’s environment.
Android.Util.IAttributeSet attribute

Collection of attributes as found associated with a tag in an XML document.
System.Int32 defaultStyleAttribute

The default style
System.Int32 defaultStyleResource

The default resource

Properties

AllowHyperlinkNavigation

Gets or sets a value indicating whether to perform hyperlink navigation.

Declaration
public bool AllowHyperlinkNavigation { get; set; }
Property Value
Type Description
System.Boolean

Default value is true.

AnnotationMode

Gets or sets the type of annotation to be drawn in SfPdfViewer.

Declaration
public AnnotationMode AnnotationMode { get; set; }
Property Value
Type Description
AnnotationMode

The annotation mode that provides type of annotation to be drawn in SfPdfViewer.

Annotations

Gets or sets the collection of annotations present in the PDF.

Declaration
public ObservableCollection<IAnnotation> Annotations { get; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<IAnnotation>

AnnotationSettings

Gets or sets the default appearance of text markup annotation.

Declaration
public AnnotationSettings AnnotationSettings { get; set; }
Property Value
Type Description
AnnotationSettings

BookmarkNavigationEnabled

Gets or sets the value that indicates whether bookmark navigation is enabled

Declaration
public bool BookmarkNavigationEnabled { get; set; }
Property Value
Type Description
System.Boolean

BookmarkPaneVisible

Gets or sets the value that indicates whether the bookmark pane is visible

Declaration
public bool BookmarkPaneVisible { get; set; }
Property Value
Type Description
System.Boolean

CanRedo

Gets a value indicating whether to notify whether we can perform redo operation in SfPdfViewer.

Declaration
public bool CanRedo { get; }
Property Value
Type Description
System.Boolean

The value that specifies whether the redo operation can be perform or not.

CanRedoInk

Gets the flag to notify whether we can perform Ink Session redo operation in SfPdfViewer.

Declaration
public bool CanRedoInk { get; }
Property Value
Type Description
System.Boolean

The flag that specifies whether the Ink Session redo operation can be perform or not in sfpdfviewer.

CanUndo

Gets a value indicating whether the value to notify whether we can perform undo operation in SfPdfViewer.

Declaration
public bool CanUndo { get; }
Property Value
Type Description
System.Boolean

The value that specifies whether the undo operation can be perform or not.

CanUndoInk

Gets the flag to notify whether we can perform Ink Session undo operation in SfPdfViewer.

Declaration
public bool CanUndoInk { get; }
Property Value
Type Description
System.Boolean

The flag that specifies whether the Ink Session undo operation can be perform or not in sfpdfviewer.

ClientRectangle

Gets the rectangle that represents the client area (viewport) of the control, without the non-client elements such as toolbars and scroll bars.

Declaration
public Rect ClientRectangle { get; }
Property Value
Type Description
Android.Graphics.Rect

CurrentSearchTextOccurrence

Gets the current search text occurrence

Declaration
public int CurrentSearchTextOccurrence { get; }
Property Value
Type Description
System.Int32

CustomPdfRenderer

Gets or sets the third party PDF renderer to be used to render PDF document in SfPdfViewer

Declaration
public ICustomPdfRenderer CustomPdfRenderer { get; set; }
Property Value
Type Description
ICustomPdfRenderer

EnableDocumentLinkAnnotation

Enable or disable the DocumentLinkAnnotation of the PDF document

Declaration
public bool EnableDocumentLinkAnnotation { get; set; }
Property Value
Type Description
System.Boolean

EnableFormFilling

If set to true enables the display, editing and saving of form fields. If set to false, the form fields are not even displayed at all. Default value is true.

Declaration
public bool EnableFormFilling { get; set; }
Property Value
Type Description
System.Boolean

EnableScrollHead

Gets or sets the value that indicates whether ScrollHead is enabled

Declaration
public bool EnableScrollHead { get; set; }
Property Value
Type Description
System.Boolean

FormSettings

Gets or sets the settings that customize the rendering of form field elements.

Declaration
public FormSettings FormSettings { get; set; }
Property Value
Type Description
FormSettings

HorizontalOffset

Gets or sets the current horizontal scroll position of SfPdfViewer.

Declaration
public float HorizontalOffset { get; set; }
Property Value
Type Description
System.Single

IsPageFlipEnabled

Gets or sets a value that indicates whether the pages can be flipped whenPageViewMode is set to PageViewMode.PageByPage

Declaration
public bool IsPageFlipEnabled { get; set; }
Property Value
Type Description
System.Boolean

IsPasswordViewEnabled

Gets or sets a flag value that indicates whether password UI view should be enabled or disabled.

Declaration
public bool IsPasswordViewEnabled { get; set; }
Property Value
Type Description
System.Boolean

false Password UI view is disabled; otherwise, true.The default value is true.

IsTextSearchEnabled

Gets or sets a value indicates whether text search is enabled.

Declaration
public bool IsTextSearchEnabled { get; set; }
Property Value
Type Description
System.Boolean

false if text search is disabled; otherwise, true.The default value is true.

IsTextSelectionEnabled

Gets or sets a value that indicates whether text selection is enabled.

Declaration
public bool IsTextSelectionEnabled { get; set; }
Property Value
Type Description
System.Boolean

false if text selection is disabled; otherwise, true.The default value is true.

IsXFAForm

Gets a value which indicates whether the loaded PDF contains XFA form which cannot be viewed in SfPdfViewer.

Declaration
public bool IsXFAForm { get; }
Property Value
Type Description
System.Boolean

MaximumZoomPercentage

Gets or Sets the maximum zoom percentage.

Declaration
public float MaximumZoomPercentage { get; set; }
Property Value
Type Description
System.Single

A float that represent the maximum extent to which the document can be magnified. The default value is 400.

MinimumZoomPercentage

Gets or Sets the minimum zoom percentage.

Declaration
public float MinimumZoomPercentage { get; set; }
Property Value
Type Description
System.Single

A float that represent the minimum extent to which the document can be magnified. The default value is 100.

PageCount

Gets the total page count of the PDF document loaded to SfPdfViewer.

Declaration
public int PageCount { get; }
Property Value
Type Description
System.Int32

An integer that provides the total number of pages in the loaded PDF document.

PageNumber

Gets or sets the number of the current page being displayed in SfPdfViewer.

Declaration
public int PageNumber { get; set; }
Property Value
Type Description
System.Int32

PageViewMode

Gets or sets the value indicating whether the SfPdfViewer is in continuous reading mode or page-by-page reading mode. Default value is Continuous.

Declaration
public PageViewMode PageViewMode { get; set; }
Property Value
Type Description
PageViewMode

PreserveSignaturePadOrientation

If set to true, device orientation is maintained when signature mode begins. If set to false, orientation is changed to Landscape. Default value is false. This property is applicable only to phone.

Declaration
public bool PreserveSignaturePadOrientation { get; set; }
Property Value
Type Description
System.Boolean

SelectedAnnotation

Gets the selected annotation.

Declaration
public IAnnotation SelectedAnnotation { get; }
Property Value
Type Description
IAnnotation

The selected annotation allows the user to customize appearance of the selected annotation.

SelectedText

Gets the text selected in the page of the PDF document

Declaration
public string SelectedText { get; }
Property Value
Type Description
System.String

A string that provides the text that is being selected.

SelectionMode

Gets or sets the selection mode in SfPdfViewer is made by annotation or not

Declaration
public SelectionMode SelectionMode { get; set; }
Property Value
Type Description
SelectionMode

ShowPageNumber

Gets or sets the value to toggling visibility of page number label while scrolling in PDF viewer control.

Declaration
public bool ShowPageNumber { get; set; }
Property Value
Type Description
System.Boolean

The flag that specifies the visibility of the page number label while scrolling in PDF viewer control.

TextSearchSettings

Gets or sets the TextSearchSettings associated with the text search operations.

Declaration
public TextSearchSettings TextSearchSettings { get; set; }
Property Value
Type Description
TextSearchSettings

The text search settings allows the user to customize the color in which the highlighted matches are filled.

TextSelectionSettings

Gets or sets the TextSelectionSettings associated with text selection.

Declaration
public TextSelectionSettings TextSelectionSettings { get; set; }
Property Value
Type Description
TextSelectionSettings

The text selection settings allows the user to customize the color in which selection is made, color of the bubble head and so on.

Toolbar

Gets or sets the properties of toolbar in SfPdfViewer

Declaration
public Toolbar Toolbar { get; set; }
Property Value
Type Description
Toolbar

TotalSearchTextOccurrences

Gets the total search text occurances

Declaration
public int TotalSearchTextOccurrences { get; }
Property Value
Type Description
System.Int32

VerticalOffset

Gets or sets the current vertical scroll position of SfPdfViewer.

Declaration
public float VerticalOffset { get; set; }
Property Value
Type Description
System.Single

ZoomPercentage

Gets or sets the current zoom percentage of SfPdfViewer.

Declaration
public float ZoomPercentage { get; set; }
Property Value
Type Description
System.Single

Methods

add_AnnotationMovedOrResized(AnnotationMovedOrResizedEventHandler)

Declaration
public void add_AnnotationMovedOrResized(AnnotationMovedOrResizedEventHandler value)
Parameters
Type Name Description
AnnotationMovedOrResizedEventHandler value

add_CanRedoInkModified(CanRedoInkModifiedEventHandler)

Declaration
public void add_CanRedoInkModified(CanRedoInkModifiedEventHandler value)
Parameters
Type Name Description
CanRedoInkModifiedEventHandler value

add_CanRedoModified(CanRedoModifiedEventHandler)

Declaration
public void add_CanRedoModified(CanRedoModifiedEventHandler value)
Parameters
Type Name Description
CanRedoModifiedEventHandler value

add_CanUndoInkModified(CanUndoInkModifiedEventHandler)

Declaration
public void add_CanUndoInkModified(CanUndoInkModifiedEventHandler value)
Parameters
Type Name Description
CanUndoInkModifiedEventHandler value

add_CanUndoModified(CanUndoModifiedEventHandler)

Declaration
public void add_CanUndoModified(CanUndoModifiedEventHandler value)
Parameters
Type Name Description
CanUndoModifiedEventHandler value

add_DocumentLoaded(DocumentLoadedEventHandler)

Declaration
public void add_DocumentLoaded(DocumentLoadedEventHandler value)
Parameters
Type Name Description
DocumentLoadedEventHandler value

add_DocumentSaveInitiated(DocumentSaveInitiatedEventHandler)

Declaration
public void add_DocumentSaveInitiated(DocumentSaveInitiatedEventHandler value)
Parameters
Type Name Description
DocumentSaveInitiatedEventHandler value

add_FreeTextAnnotationAdded(FreeTextAnnotationAddedEventHandler)

Declaration
public void add_FreeTextAnnotationAdded(FreeTextAnnotationAddedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationAddedEventHandler value

add_FreeTextAnnotationDeselected(FreeTextAnnotationDeselectedEventHandler)

Declaration
public void add_FreeTextAnnotationDeselected(FreeTextAnnotationDeselectedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationDeselectedEventHandler value

add_FreeTextAnnotationEdited(FreeTextAnnotationEditedEventHandler)

Declaration
public void add_FreeTextAnnotationEdited(FreeTextAnnotationEditedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationEditedEventHandler value

add_FreeTextAnnotationLongPressed(FreeTextAnnotationLongPressedEventHandler)

Declaration
public void add_FreeTextAnnotationLongPressed(FreeTextAnnotationLongPressedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationLongPressedEventHandler value

add_FreeTextAnnotationMovedOrResized(FreeTextAnnotationMovedOrResizedEventHandler)

Declaration
public void add_FreeTextAnnotationMovedOrResized(FreeTextAnnotationMovedOrResizedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationMovedOrResizedEventHandler value

add_FreeTextAnnotationRemoved(FreeTextAnnotationRemovedEventHandler)

Declaration
public void add_FreeTextAnnotationRemoved(FreeTextAnnotationRemovedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationRemovedEventHandler value

add_FreeTextAnnotationSelected(FreeTextAnnotationSelectedEventHandler)

Declaration
public void add_FreeTextAnnotationSelected(FreeTextAnnotationSelectedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationSelectedEventHandler value

add_FreeTextAnnotationTapped(FreeTextAnnotationTappedEventHandler)

Declaration
public void add_FreeTextAnnotationTapped(FreeTextAnnotationTappedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationTappedEventHandler value

add_FreeTextPopupAppearing(FreeTextPopupAppearingEventHandler)

Declaration
public void add_FreeTextPopupAppearing(FreeTextPopupAppearingEventHandler value)
Parameters
Type Name Description
FreeTextPopupAppearingEventHandler value

add_FreeTextPopupDisappeared(FreeTextPopupDisappearedEventHandler)

Declaration
public void add_FreeTextPopupDisappeared(FreeTextPopupDisappearedEventHandler value)
Parameters
Type Name Description
FreeTextPopupDisappearedEventHandler value

add_HyperlinkClicked(HyperlinkClickedEventHandler)

Declaration
public void add_HyperlinkClicked(HyperlinkClickedEventHandler value)
Parameters
Type Name Description
HyperlinkClickedEventHandler value

add_InkAdded(InkAddedEventHandler)

Declaration
public void add_InkAdded(InkAddedEventHandler value)
Parameters
Type Name Description
InkAddedEventHandler value

add_InkDeselected(InkDeselectedEventHandler)

Declaration
public void add_InkDeselected(InkDeselectedEventHandler value)
Parameters
Type Name Description
InkDeselectedEventHandler value

add_InkEdited(InkEditedEventHandler)

Declaration
public void add_InkEdited(InkEditedEventHandler value)
Parameters
Type Name Description
InkEditedEventHandler value

add_InkRemoved(InkRemovedEventHandler)

Declaration
public void add_InkRemoved(InkRemovedEventHandler value)
Parameters
Type Name Description
InkRemovedEventHandler value

add_InkSelected(InkSelectedEventHandler)

Declaration
public void add_InkSelected(InkSelectedEventHandler value)
Parameters
Type Name Description
InkSelectedEventHandler value

add_InkTapped(InkTappedEventHandler)

Declaration
public void add_InkTapped(InkTappedEventHandler value)
Parameters
Type Name Description
InkTappedEventHandler value

add_PageChanged(PageChangedEventHandler)

Declaration
public void add_PageChanged(PageChangedEventHandler value)
Parameters
Type Name Description
PageChangedEventHandler value

add_RedoPerformed(RedoEventHandler)

Declaration
public void add_RedoPerformed(RedoEventHandler value)
Parameters
Type Name Description
RedoEventHandler value

add_SearchCompleted(TextSearchCompletedEventHandler)

Declaration
public void add_SearchCompleted(TextSearchCompletedEventHandler value)
Parameters
Type Name Description
TextSearchCompletedEventHandler value

add_SearchInitiated(TextSearchInitiatedEventHandler)

Declaration
public void add_SearchInitiated(TextSearchInitiatedEventHandler value)
Parameters
Type Name Description
TextSearchInitiatedEventHandler value

add_ShapeAnnotationAdded(ShapeAnnotationAddedEventHandler)

Declaration
public void add_ShapeAnnotationAdded(ShapeAnnotationAddedEventHandler value)
Parameters
Type Name Description
ShapeAnnotationAddedEventHandler value

add_ShapeAnnotationDeselected(ShapeAnnotationDeselectedEventHandler)

Declaration
public void add_ShapeAnnotationDeselected(ShapeAnnotationDeselectedEventHandler value)
Parameters
Type Name Description
ShapeAnnotationDeselectedEventHandler value

add_ShapeAnnotationEdited(ShapeAnnotationEditedEventHandler)

Declaration
public void add_ShapeAnnotationEdited(ShapeAnnotationEditedEventHandler value)
Parameters
Type Name Description
ShapeAnnotationEditedEventHandler value

add_ShapeAnnotationRemoved(ShapeAnnotationRemovedEventHandler)

Declaration
public void add_ShapeAnnotationRemoved(ShapeAnnotationRemovedEventHandler value)
Parameters
Type Name Description
ShapeAnnotationRemovedEventHandler value

add_ShapeAnnotationSelected(ShapeAnnotationSelectedEventHandler)

Declaration
public void add_ShapeAnnotationSelected(ShapeAnnotationSelectedEventHandler value)
Parameters
Type Name Description
ShapeAnnotationSelectedEventHandler value

add_ShapeAnnotationTapped(ShapeAnnotationTappedEventHandler)

Declaration
public void add_ShapeAnnotationTapped(ShapeAnnotationTappedEventHandler value)
Parameters
Type Name Description
ShapeAnnotationTappedEventHandler value

add_TextMarkupAdded(TextMarkupAddedEventHandler)

Declaration
public void add_TextMarkupAdded(TextMarkupAddedEventHandler value)
Parameters
Type Name Description
TextMarkupAddedEventHandler value

add_TextMarkupDeselected(TextMarkupDeselectedEventHandler)

Declaration
public void add_TextMarkupDeselected(TextMarkupDeselectedEventHandler value)
Parameters
Type Name Description
TextMarkupDeselectedEventHandler value

add_TextMarkupEdited(TextMarkupEditedEventHandler)

Declaration
public void add_TextMarkupEdited(TextMarkupEditedEventHandler value)
Parameters
Type Name Description
TextMarkupEditedEventHandler value

add_TextMarkupLongPressed(TextMarkupLongPressedEventHandler)

Declaration
public void add_TextMarkupLongPressed(TextMarkupLongPressedEventHandler value)
Parameters
Type Name Description
TextMarkupLongPressedEventHandler value

add_TextMarkupRemoved(TextMarkupRemovedEventHandler)

Declaration
public void add_TextMarkupRemoved(TextMarkupRemovedEventHandler value)
Parameters
Type Name Description
TextMarkupRemovedEventHandler value

add_TextMarkupSelected(TextMarkupSelectedEventHandler)

Declaration
public void add_TextMarkupSelected(TextMarkupSelectedEventHandler value)
Parameters
Type Name Description
TextMarkupSelectedEventHandler value

add_TextMarkupTapped(TextMarkupTappedEventHandler)

Declaration
public void add_TextMarkupTapped(TextMarkupTappedEventHandler value)
Parameters
Type Name Description
TextMarkupTappedEventHandler value

add_TextMatchFound(TextMatchFoundEventHandler)

Declaration
public void add_TextMatchFound(TextMatchFoundEventHandler value)
Parameters
Type Name Description
TextMatchFoundEventHandler value

add_TextSelectionCompleted(TextSelectionEventHandler)

Declaration
public void add_TextSelectionCompleted(TextSelectionEventHandler value)
Parameters
Type Name Description
TextSelectionEventHandler value

add_UndoPerformed(UndoEventHandler)

Declaration
public void add_UndoPerformed(UndoEventHandler value)
Parameters
Type Name Description
UndoEventHandler value

add_UnhandledConditionOccurred(UnhandledConditionEventHandler)

Declaration
public void add_UnhandledConditionOccurred(UnhandledConditionEventHandler value)
Parameters
Type Name Description
UnhandledConditionEventHandler value

AddAnnotation(IAnnotation)

Adds an annotation to the specified page.

Declaration
public void AddAnnotation(IAnnotation annotation)
Parameters
Type Name Description
IAnnotation annotation

The annotation to be added.

AddHandwrittenSignature(HandwrittenSignature, Dictionary<Int32, List<Point>>)

Declaration
public void AddHandwrittenSignature(HandwrittenSignature signature, Dictionary<int, List<Point>> positionCollection)
Parameters
Type Name Description
HandwrittenSignature signature
System.Collections.Generic.Dictionary<System.Int32, System.Collections.Generic.List<System.Drawing.Point>> positionCollection

AddHandwrittenSignature(HandwrittenSignature, Point, Int32)

Declaration
public void AddHandwrittenSignature(HandwrittenSignature signature, Point position, int pageNumber = -1)
Parameters
Type Name Description
HandwrittenSignature signature
System.Drawing.Point position
System.Int32 pageNumber

AddHandwrittenSignature(HandwrittenSignature, Int32)

Declaration
public void AddHandwrittenSignature(HandwrittenSignature signature, int pageNumber = -1)
Parameters
Type Name Description
HandwrittenSignature signature
System.Int32 pageNumber

AddStamp(View, Int32)

To include the custom Stamp to the page

Declaration
public void AddStamp(View customView, int pageNumber)
Parameters
Type Name Description
Android.Views.View customView
System.Int32 pageNumber

AddStamp(View, Int32, Point)

To include the custom Stamp to the page

Declaration
public void AddStamp(View customView, int pageNumber, Point position)
Parameters
Type Name Description
Android.Views.View customView
System.Int32 pageNumber
Android.Graphics.Point position

AddStamp(View, Int32, Rect)

To include the custom Stamp to the page

Declaration
public void AddStamp(View customView, int pageNumber, Rect bounds)
Parameters
Type Name Description
Android.Views.View customView
System.Int32 pageNumber
Android.Graphics.Rect bounds

CancelSearch()

Cancels the text search operation.

Declaration
public void CancelSearch()

ClearAllAnnotations()

Delete all the annotations in the whole document.

Declaration
public void ClearAllAnnotations()

ClearAllAnnotations(Int32)

Delete all the annotations in the given page.

Declaration
public void ClearAllAnnotations(int pageIndex)
Parameters
Type Name Description
System.Int32 pageIndex

ClearUndoRedoStack()

Declaration
public void ClearUndoRedoStack()

ConvertClientPointToPagePoint(PointF, Int32)

Converts a point from the client area coordinates to PDF page coordinates.

Declaration
public PointF ConvertClientPointToPagePoint(PointF clientPoint, int pageNumber)
Parameters
Type Name Description
Android.Graphics.PointF clientPoint

The client point to convert. The client point coordinates start from the top-left corner of the ClientRectangle.
System.Int32 pageNumber

The page number corresponding to the client point. The page number can be obtained using the method.
Returns
Type Description
Android.Graphics.PointF

ConvertPagePointToClientPoint(PointF, Int32)

Converts a point from PDF page coordinates to client area coordinates.

Declaration
public PointF ConvertPagePointToClientPoint(PointF pagePoint, int pageNumber)
Parameters
Type Name Description
Android.Graphics.PointF pagePoint

The PDF page point to convert. The page point coordinates start from the top-left corner of the page corresponding to the given page number.
System.Int32 pageNumber

The page number corresponding to the page point.
Returns
Type Description
Android.Graphics.PointF

ConvertPagePointToScrollPoint(PointF, Int32)

Converts a point from the PDF page coordinates to the scroll area coordinates of the SfPdfViewer control.

Declaration
public PointF ConvertPagePointToScrollPoint(PointF pagePoint, int pageNumber)
Parameters
Type Name Description
Android.Graphics.PointF pagePoint

The PDF page point to convert. The page point coordinates start from the top-left corner of the page corresponding to the given page number.
System.Int32 pageNumber

The page number corresponding to the page point.
Returns
Type Description
Android.Graphics.PointF
Remarks

The scroll coordinates start at the top-left of the first page and end at the bottom-right of the last page. The scroll coordinates are subject to change when ZoomPercentage changes.

DeselectAnnotation(IAnnotation)

Deselects the specified annotation. Calling this method has no effect if the given annotation is not selected.

Declaration
public void DeselectAnnotation(IAnnotation annotation)
Parameters
Type Name Description
IAnnotation annotation

The annotation to be deselected. .

Dispose(Boolean)

Dispose the objects allocated for SfPdfViewer

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

bool

EditFreeTextAnnotation()

Edits the selected free text annotation in the PDF document

Declaration
public void EditFreeTextAnnotation()

EndInkSession(Boolean)

Save or Unsave the ink of the current session.

Declaration
public void EndInkSession(bool save)
Parameters
Type Name Description
System.Boolean save

ExportAnnotations(AnnotationDataFormat)

Exports the annotation data into the specified format.

Declaration
public Stream ExportAnnotations(AnnotationDataFormat format)
Parameters
Type Name Description
AnnotationDataFormat format

The format in which the exported data are going to be saved.
Returns
Type Description
System.IO.Stream

ExportAnnotations(List<IAnnotation>, AnnotationDataFormat)

Exports the given collection of annotations in the specified format.

Declaration
public Stream ExportAnnotations(List<IAnnotation> annotations, AnnotationDataFormat format)
Parameters
Type Name Description
System.Collections.Generic.List<IAnnotation> annotations

The list of annotations to be exported.
AnnotationDataFormat format

The format in which the annotations data has to be exported.
Returns
Type Description
System.IO.Stream
Remarks

The method exports only the annotations that are contained in the given collection and ignores the other annotations in the PDF.

ExportAsImage(Int32)

Exports the page with the given index as an image.

Declaration
public Stream ExportAsImage(int pageIndex)
Parameters
Type Name Description
System.Int32 pageIndex

Index of the page to be exported.
Returns
Type Description
System.IO.Stream

ExportAsImage(Int32, Int32)

Exports the pages with indices in the given range as images.

Declaration
public Stream[] ExportAsImage(int pageStartIndex, int pageEndIndex)
Parameters
Type Name Description
System.Int32 pageStartIndex

Start index in the range of pages to be exported.
System.Int32 pageEndIndex

End index in the range of pages to be exported.
Returns
Type Description
System.IO.Stream[]

ExportAsImage(Int32, Int32, Single)

Exports the pages with indices in the given range as images and scales the images by the given factor.

Declaration
public Stream[] ExportAsImage(int pageStartIndex, int pageEndIndex, float scaleFactor)
Parameters
Type Name Description
System.Int32 pageStartIndex

Start index in the range of pages to be exported.
System.Int32 pageEndIndex

End index in the range of pages to be exported.
System.Single scaleFactor

The factor by which the images’ dimensions are to be scaled.
Returns
Type Description
System.IO.Stream[]

ExportAsImage(Int32, Single)

Exports the page with the given index as an image and scales the image by the given factor.

Declaration
public Stream ExportAsImage(int pageIndex, float scaleFactor)
Parameters
Type Name Description
System.Int32 pageIndex

Index of the page to be exported.
System.Single scaleFactor

The factor by which the image dimensions are to be scaled.
Returns
Type Description
System.IO.Stream

ExportAsImageAsync(Int32, Int32, Single, CancellationToken)

Exports the pages with indices in the given range as images asynchronously and scales the images by the given factor.

Declaration
public Task<Stream[]> ExportAsImageAsync(int pageStartIndex, int pageEndIndex, float scaleFactor, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.Int32 pageStartIndex

Start index in the range of pages to be exported.
System.Int32 pageEndIndex

End index in the range of pages to be exported.
System.Single scaleFactor

The factor by which the images’ dimensions are to be scaled.
System.Threading.CancellationToken cancellationToken

A cancellation token to receive notice of cancellation.
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream[]>

ExportAsImageAsync(Int32, Int32, CancellationToken)

Exports the pages with indices in the given range as images asynchrously.

Declaration
public Task<Stream[]> ExportAsImageAsync(int pageStartIndex, int pageEndIndex, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.Int32 pageStartIndex

Start index in the range of pages to be exported.
System.Int32 pageEndIndex

End index in the range of pages to be exported.
System.Threading.CancellationToken cancellationToken

A cancellation token to receive notice of cancellation.
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream[]>

ExportAsImageAsync(Int32, Single, CancellationToken)

Exports the page with the given index as an image asynchronously and scales the image by the given factor.

Declaration
public Task<Stream> ExportAsImageAsync(int pageIndex, float scaleFactor, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.Int32 pageIndex

Index of the page to be exported.
System.Single scaleFactor

The factor by which the image dimensions are to be scaled.
System.Threading.CancellationToken cancellationToken

A cancellation token to receive notice of cancellation.
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream>

ExportAsImageAsync(Int32, CancellationToken)

Exports the page with the given index as an image asynchrously.

Declaration
public Task<Stream> ExportAsImageAsync(int pageIndex, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.Int32 pageIndex

Index of the page to be exported.
System.Threading.CancellationToken cancellationToken

A cancellation token to receive notice of cancellation.
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream>

ExportFormData(DataFormat, String)

Exports the form field values into the specified format.

Declaration
public Stream ExportFormData(DataFormat format, string name)
Parameters
Type Name Description
DataFormat format

The format in which the exported data are going to be saved.
System.String name

Name of the PDF file whose form fields the exported forms data file fills.
Returns
Type Description
System.IO.Stream

GetPageNumberFromClientPoint(PointF)

Gets the page number corresponding to the client point.

Declaration
public int GetPageNumberFromClientPoint(PointF clientPoint)
Parameters
Type Name Description
Android.Graphics.PointF clientPoint

The client point corresponding to the page number. The client point coordinates start from the top-left corner of the ClientRectangle.
Returns
Type Description
System.Int32

GoToBookmark(PdfBookmark)

Navigates the PdfViewer to the location specified by the given bookmark destination

Declaration
public void GoToBookmark(PdfBookmark bookmark)
Parameters
Type Name Description
PdfBookmark bookmark

The bookmark to navigate to

GoToNextPage()

Navigates to the next page of the PDF document.

Declaration
public void GoToNextPage()

GoToPage(Int32)

Navigates to the specified page of the PDF document.

Declaration
public void GoToPage(int pageNumber)
Parameters
Type Name Description
System.Int32 pageNumber

The number of the page to navigate to.

GoToPreviousPage()

Navigates to the previous page of the PDF document.

Declaration
public void GoToPreviousPage()

ImportAnnotations(Stream, AnnotationDataFormat)

Imports the annotation data in the specified format into the PDF.

Declaration
public void ImportAnnotations(Stream inputStream, AnnotationDataFormat format)
Parameters
Type Name Description
System.IO.Stream inputStream

Stream read from the annotation data file.
AnnotationDataFormat format

The format of the annotation data file from which the inputStream is read.

ImportFormData(Stream, DataFormat)

Imports the form data in the specified format into the form fields of the PDF.

Declaration
public void ImportFormData(Stream inputStream, DataFormat format)
Parameters
Type Name Description
System.IO.Stream inputStream

Stream read from the form data file.
DataFormat format

The format of the form data file from which the inputStream is read.

LoadDocument(Stream)

Loads a PDF document to SfPdfViewer from the specified data stream.

Declaration
public void LoadDocument(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream

The stream that contains the data of the PDF document.

LoadDocument(Stream, String)

Declaration
public void LoadDocument(Stream stream, string password)
Parameters
Type Name Description
System.IO.Stream stream
System.String password

LoadDocumentAsync(Stream, String, CancellationTokenSource)

Loads the PDF document from the specified stream with password asynchronously. It has the same effect as the LoadDocument(Stream, String) method.

Declaration
public Task<Task> LoadDocumentAsync(Stream documentStream, string password, CancellationTokenSource cancellationTokenSource)
Parameters
Type Name Description
System.IO.Stream documentStream
System.String password
System.Threading.CancellationTokenSource cancellationTokenSource
Returns
Type Description
System.Threading.Tasks.Task<System.Threading.Tasks.Task>

LoadDocumentAsync(Stream, CancellationTokenSource)

Loads the PDF document from the specified stream asynchronously. It has the same effect as the LoadDocument(Stream) method.

Declaration
public Task<Task> LoadDocumentAsync(Stream documentStream, CancellationTokenSource cancellationTokenSource)
Parameters
Type Name Description
System.IO.Stream documentStream
System.Threading.CancellationTokenSource cancellationTokenSource
Returns
Type Description
System.Threading.Tasks.Task<System.Threading.Tasks.Task>

OnDetachedFromWindow()

Gets or sets a value that indicates whether text selection is enabled.

Declaration
protected override void OnDetachedFromWindow()

OnLayout(Boolean, Int32, Int32, Int32, Int32)

Declaration
protected override void OnLayout(bool changed, int left, int top, int right, int bottom)
Parameters
Type Name Description
System.Boolean changed
System.Int32 left
System.Int32 top
System.Int32 right
System.Int32 bottom

PerformRedo()

Performs redo operation.

Declaration
public void PerformRedo()

PerformUndo()

Performs undo operation.

Declaration
public void PerformUndo()

Print()

Prints the PDF.

Declaration
public void Print()

Print(String)

Prints the PDF with given file name.

Declaration
public void Print(string fileName)
Parameters
Type Name Description
System.String fileName

The name with which the printed PDF will be saved.

RedoInk()

Perform ink session redo operation.

Declaration
public void RedoInk()

remove_AnnotationMovedOrResized(AnnotationMovedOrResizedEventHandler)

Declaration
public void remove_AnnotationMovedOrResized(AnnotationMovedOrResizedEventHandler value)
Parameters
Type Name Description
AnnotationMovedOrResizedEventHandler value

remove_CanRedoInkModified(CanRedoInkModifiedEventHandler)

Declaration
public void remove_CanRedoInkModified(CanRedoInkModifiedEventHandler value)
Parameters
Type Name Description
CanRedoInkModifiedEventHandler value

remove_CanRedoModified(CanRedoModifiedEventHandler)

Declaration
public void remove_CanRedoModified(CanRedoModifiedEventHandler value)
Parameters
Type Name Description
CanRedoModifiedEventHandler value

remove_CanUndoInkModified(CanUndoInkModifiedEventHandler)

Declaration
public void remove_CanUndoInkModified(CanUndoInkModifiedEventHandler value)
Parameters
Type Name Description
CanUndoInkModifiedEventHandler value

remove_CanUndoModified(CanUndoModifiedEventHandler)

Declaration
public void remove_CanUndoModified(CanUndoModifiedEventHandler value)
Parameters
Type Name Description
CanUndoModifiedEventHandler value

remove_DocumentLoaded(DocumentLoadedEventHandler)

Declaration
public void remove_DocumentLoaded(DocumentLoadedEventHandler value)
Parameters
Type Name Description
DocumentLoadedEventHandler value

remove_DocumentSaveInitiated(DocumentSaveInitiatedEventHandler)

Declaration
public void remove_DocumentSaveInitiated(DocumentSaveInitiatedEventHandler value)
Parameters
Type Name Description
DocumentSaveInitiatedEventHandler value

remove_FreeTextAnnotationAdded(FreeTextAnnotationAddedEventHandler)

Declaration
public void remove_FreeTextAnnotationAdded(FreeTextAnnotationAddedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationAddedEventHandler value

remove_FreeTextAnnotationDeselected(FreeTextAnnotationDeselectedEventHandler)

Declaration
public void remove_FreeTextAnnotationDeselected(FreeTextAnnotationDeselectedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationDeselectedEventHandler value

remove_FreeTextAnnotationEdited(FreeTextAnnotationEditedEventHandler)

Declaration
public void remove_FreeTextAnnotationEdited(FreeTextAnnotationEditedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationEditedEventHandler value

remove_FreeTextAnnotationLongPressed(FreeTextAnnotationLongPressedEventHandler)

Declaration
public void remove_FreeTextAnnotationLongPressed(FreeTextAnnotationLongPressedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationLongPressedEventHandler value

remove_FreeTextAnnotationMovedOrResized(FreeTextAnnotationMovedOrResizedEventHandler)

Declaration
public void remove_FreeTextAnnotationMovedOrResized(FreeTextAnnotationMovedOrResizedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationMovedOrResizedEventHandler value

remove_FreeTextAnnotationRemoved(FreeTextAnnotationRemovedEventHandler)

Declaration
public void remove_FreeTextAnnotationRemoved(FreeTextAnnotationRemovedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationRemovedEventHandler value

remove_FreeTextAnnotationSelected(FreeTextAnnotationSelectedEventHandler)

Declaration
public void remove_FreeTextAnnotationSelected(FreeTextAnnotationSelectedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationSelectedEventHandler value

remove_FreeTextAnnotationTapped(FreeTextAnnotationTappedEventHandler)

Declaration
public void remove_FreeTextAnnotationTapped(FreeTextAnnotationTappedEventHandler value)
Parameters
Type Name Description
FreeTextAnnotationTappedEventHandler value

remove_FreeTextPopupAppearing(FreeTextPopupAppearingEventHandler)

Declaration
public void remove_FreeTextPopupAppearing(FreeTextPopupAppearingEventHandler value)
Parameters
Type Name Description
FreeTextPopupAppearingEventHandler value

remove_FreeTextPopupDisappeared(FreeTextPopupDisappearedEventHandler)

Declaration
public void remove_FreeTextPopupDisappeared(FreeTextPopupDisappearedEventHandler value)
Parameters
Type Name Description
FreeTextPopupDisappearedEventHandler value

remove_HyperlinkClicked(HyperlinkClickedEventHandler)

Declaration
public void remove_HyperlinkClicked(HyperlinkClickedEventHandler value)
Parameters
Type Name Description
HyperlinkClickedEventHandler value

remove_InkAdded(InkAddedEventHandler)

Declaration
public void remove_InkAdded(InkAddedEventHandler value)
Parameters
Type Name Description
InkAddedEventHandler value

remove_InkDeselected(InkDeselectedEventHandler)

Declaration
public void remove_InkDeselected(InkDeselectedEventHandler value)
Parameters
Type Name Description
InkDeselectedEventHandler value

remove_InkEdited(InkEditedEventHandler)

Declaration
public void remove_InkEdited(InkEditedEventHandler value)
Parameters
Type Name Description
InkEditedEventHandler value

remove_InkRemoved(InkRemovedEventHandler)

Declaration
public void remove_InkRemoved(InkRemovedEventHandler value)
Parameters
Type Name Description
InkRemovedEventHandler value

remove_InkSelected(InkSelectedEventHandler)

Declaration
public void remove_InkSelected(InkSelectedEventHandler value)
Parameters
Type Name Description
InkSelectedEventHandler value

remove_InkTapped(InkTappedEventHandler)

Declaration
public void remove_InkTapped(InkTappedEventHandler value)
Parameters
Type Name Description
InkTappedEventHandler value

remove_PageChanged(PageChangedEventHandler)

Declaration
public void remove_PageChanged(PageChangedEventHandler value)
Parameters
Type Name Description
PageChangedEventHandler value

remove_RedoPerformed(RedoEventHandler)

Declaration
public void remove_RedoPerformed(RedoEventHandler value)
Parameters
Type Name Description
RedoEventHandler value

remove_SearchCompleted(TextSearchCompletedEventHandler)

Declaration
public void remove_SearchCompleted(TextSearchCompletedEventHandler value)
Parameters
Type Name Description
TextSearchCompletedEventHandler value

remove_SearchInitiated(TextSearchInitiatedEventHandler)

Declaration
public void remove_SearchInitiated(TextSearchInitiatedEventHandler value)
Parameters
Type Name Description
TextSearchInitiatedEventHandler value

remove_ShapeAnnotationAdded(ShapeAnnotationAddedEventHandler)

Declaration
public void remove_ShapeAnnotationAdded(ShapeAnnotationAddedEventHandler value)
Parameters
Type Name Description
ShapeAnnotationAddedEventHandler value

remove_ShapeAnnotationDeselected(ShapeAnnotationDeselectedEventHandler)

Declaration
public void remove_ShapeAnnotationDeselected(ShapeAnnotationDeselectedEventHandler value)
Parameters
Type Name Description
ShapeAnnotationDeselectedEventHandler value

remove_ShapeAnnotationEdited(ShapeAnnotationEditedEventHandler)

Declaration
public void remove_ShapeAnnotationEdited(ShapeAnnotationEditedEventHandler value)
Parameters
Type Name Description
ShapeAnnotationEditedEventHandler value

remove_ShapeAnnotationRemoved(ShapeAnnotationRemovedEventHandler)

Declaration
public void remove_ShapeAnnotationRemoved(ShapeAnnotationRemovedEventHandler value)
Parameters
Type Name Description
ShapeAnnotationRemovedEventHandler value

remove_ShapeAnnotationSelected(ShapeAnnotationSelectedEventHandler)

Declaration
public void remove_ShapeAnnotationSelected(ShapeAnnotationSelectedEventHandler value)
Parameters
Type Name Description
ShapeAnnotationSelectedEventHandler value

remove_ShapeAnnotationTapped(ShapeAnnotationTappedEventHandler)

Declaration
public void remove_ShapeAnnotationTapped(ShapeAnnotationTappedEventHandler value)
Parameters
Type Name Description
ShapeAnnotationTappedEventHandler value

remove_TextMarkupAdded(TextMarkupAddedEventHandler)

Declaration
public void remove_TextMarkupAdded(TextMarkupAddedEventHandler value)
Parameters
Type Name Description
TextMarkupAddedEventHandler value

remove_TextMarkupDeselected(TextMarkupDeselectedEventHandler)

Declaration
public void remove_TextMarkupDeselected(TextMarkupDeselectedEventHandler value)
Parameters
Type Name Description
TextMarkupDeselectedEventHandler value

remove_TextMarkupEdited(TextMarkupEditedEventHandler)

Declaration
public void remove_TextMarkupEdited(TextMarkupEditedEventHandler value)
Parameters
Type Name Description
TextMarkupEditedEventHandler value

remove_TextMarkupLongPressed(TextMarkupLongPressedEventHandler)

Declaration
public void remove_TextMarkupLongPressed(TextMarkupLongPressedEventHandler value)
Parameters
Type Name Description
TextMarkupLongPressedEventHandler value

remove_TextMarkupRemoved(TextMarkupRemovedEventHandler)

Declaration
public void remove_TextMarkupRemoved(TextMarkupRemovedEventHandler value)
Parameters
Type Name Description
TextMarkupRemovedEventHandler value

remove_TextMarkupSelected(TextMarkupSelectedEventHandler)

Declaration
public void remove_TextMarkupSelected(TextMarkupSelectedEventHandler value)
Parameters
Type Name Description
TextMarkupSelectedEventHandler value

remove_TextMarkupTapped(TextMarkupTappedEventHandler)

Declaration
public void remove_TextMarkupTapped(TextMarkupTappedEventHandler value)
Parameters
Type Name Description
TextMarkupTappedEventHandler value

remove_TextMatchFound(TextMatchFoundEventHandler)

Declaration
public void remove_TextMatchFound(TextMatchFoundEventHandler value)
Parameters
Type Name Description
TextMatchFoundEventHandler value

remove_TextSelectionCompleted(TextSelectionEventHandler)

Declaration
public void remove_TextSelectionCompleted(TextSelectionEventHandler value)
Parameters
Type Name Description
TextSelectionEventHandler value

remove_UndoPerformed(UndoEventHandler)

Declaration
public void remove_UndoPerformed(UndoEventHandler value)
Parameters
Type Name Description
UndoEventHandler value

remove_UnhandledConditionOccurred(UnhandledConditionEventHandler)

Declaration
public void remove_UnhandledConditionOccurred(UnhandledConditionEventHandler value)
Parameters
Type Name Description
UnhandledConditionEventHandler value

RemoveAnnotation(IAnnotation)

Clears the selected annotation.

Declaration
public void RemoveAnnotation(IAnnotation annotation)
Parameters
Type Name Description
IAnnotation annotation

Selected annotation to be deleted

SaveDocument()

Saves the PDF document and returns it as stream.

Declaration
public Stream SaveDocument()
Returns
Type Description
System.IO.Stream

Saved PDF document as stream.

SaveDocument(Boolean)

Saves the PDF document and returns it as stream.

Declaration
public Stream SaveDocument(bool flattenFormFields)
Parameters
Type Name Description
System.Boolean flattenFormFields

Value indicating whether the form fields in the PDF are to be flattened while saving. Default value is false.
Returns
Type Description
System.IO.Stream

Saved PDF document as stream.

ScrollToOffset(Single, Single)

Scrolls the SfPdfViewer to a position relative to the horizontal offset and vertical offset values.

Declaration
public void ScrollToOffset(float horizontalOffset, float verticalOffset)
Parameters
Type Name Description
System.Single horizontalOffset

The value to which the control scrolls horizontally.
System.Single verticalOffset

The value to which the control scrolls vertically.

SearchNext()

Finds the next occurrence of the text being searched.

Declaration
public void SearchNext()

SearchNext(String)

Finds the next occurrence of the text being searched.

Declaration
public void SearchNext(string targetText)
Parameters
Type Name Description
System.String targetText

The text to be searched.

SearchPrevious()

Finds the previous occurrence of the text being searched.

Declaration
public void SearchPrevious()

SearchPrevious(String)

Finds the previous occurrence of the text being searched.

Declaration
public void SearchPrevious(string targetText)
Parameters
Type Name Description
System.String targetText

The text to be searched.

SearchText(String)

Finds all occurrences of the given text in the PDF document.

Declaration
public void SearchText(string targetText)
Parameters
Type Name Description
System.String targetText

The text to be searched.

SelectAnnotation(IAnnotation)

Selects the specified annotation.

Declaration
public void SelectAnnotation(IAnnotation annotation)
Parameters
Type Name Description
IAnnotation annotation

The annotation to be selected.

UndoInk()

Perform ink session undo operation.

Declaration
public void UndoInk()

Unload()

Unloads the PDF document from SfPdfViewer.

Declaration
public void Unload()

ZoomToRect(RectF)

Brings the given rectangular region to view and zooms in the document to fit the region in client area (view port).

Declaration
public void ZoomToRect(RectF rectangle)
Parameters
Type Name Description
Android.Graphics.RectF rectangle

Specifies the region in client coordinates that is to be brought to view.
Remarks

While zooming in to the given rectangular region, if the ZoomPercentage becomes either less than MinimumZoomPercentage or greater than MaximumZoomPercentage, the region will not be properly fit to the client area.

Events

AnnotationMovedOrResized

Occurs when ink is moved or resized.

Declaration
public event AnnotationMovedOrResizedEventHandler AnnotationMovedOrResized
Event Type
Type Description
AnnotationMovedOrResizedEventHandler

BookmarkNavigationOccurred

Occurs when a bookmark is navigated to

Declaration
public event EventHandler<BookmarkNavigationOccurredEventArgs> BookmarkNavigationOccurred
Event Type
Type Description
System.EventHandler<BookmarkNavigationOccurredEventArgs>

CanRedoInkModified

Occurs when can redo ink session property is modified

Declaration
public event CanRedoInkModifiedEventHandler CanRedoInkModified
Event Type
Type Description
CanRedoInkModifiedEventHandler

CanRedoModified

Occurs when can redo stack is modified

Declaration
public event CanRedoModifiedEventHandler CanRedoModified
Event Type
Type Description
CanRedoModifiedEventHandler

CanUndoInkModified

Occurs when can undo ink session property is modified

Declaration
public event CanUndoInkModifiedEventHandler CanUndoInkModified
Event Type
Type Description
CanUndoInkModifiedEventHandler

CanUndoModified

Occurs when can undo stack is modified

Declaration
public event CanUndoModifiedEventHandler CanUndoModified
Event Type
Type Description
CanUndoModifiedEventHandler

DocumentLoaded

Occurs when a PDF document is finished loading to SfPdfViewer.

Declaration
public event DocumentLoadedEventHandler DocumentLoaded
Event Type
Type Description
DocumentLoadedEventHandler

DocumentSaveInitiated

Occurs when saved the document

Declaration
public event DocumentSaveInitiatedEventHandler DocumentSaveInitiated
Event Type
Type Description
DocumentSaveInitiatedEventHandler

DoubleTapped

Occurs when double tapped.

Declaration
public event EventHandler<TouchInteractionEventArgs> DoubleTapped
Event Type
Type Description
System.EventHandler<TouchInteractionEventArgs>

FormFieldFocused

Occurs when text or signature form field is focused.

Declaration
public event EventHandler<FormFieldFocusedEventArgs> FormFieldFocused
Event Type
Type Description
System.EventHandler<FormFieldFocusedEventArgs>
Remarks

This event will not occur when form fields of other types are focused.

FormFieldUnfocused

Occurs when text or signature form field is unfocused.

Declaration
public event EventHandler<FormFieldUnfocusedEventArgs> FormFieldUnfocused
Event Type
Type Description
System.EventHandler<FormFieldUnfocusedEventArgs>
Remarks

This event will not occur when form fields of other types are unfocused.

FormFieldValueChanged

Occurs when the value of the form fields are changed.

Declaration
public event EventHandler<FormFieldValueChangedEventArgs> FormFieldValueChanged
Event Type
Type Description
System.EventHandler<FormFieldValueChangedEventArgs>

FreeTextAnnotationAdded

Occurs when free text annotation is added

Declaration
public event FreeTextAnnotationAddedEventHandler FreeTextAnnotationAdded
Event Type
Type Description
FreeTextAnnotationAddedEventHandler

FreeTextAnnotationDeselected

Occurs when free text annotation is deselected

Declaration
public event FreeTextAnnotationDeselectedEventHandler FreeTextAnnotationDeselected
Event Type
Type Description
FreeTextAnnotationDeselectedEventHandler

FreeTextAnnotationEdited

Occurs when free text annotation property is edited

Declaration
public event FreeTextAnnotationEditedEventHandler FreeTextAnnotationEdited
Event Type
Type Description
FreeTextAnnotationEditedEventHandler

FreeTextAnnotationLongPressed

Occurs when free text annotation is long pressed

Declaration
public event FreeTextAnnotationLongPressedEventHandler FreeTextAnnotationLongPressed
Event Type
Type Description
FreeTextAnnotationLongPressedEventHandler

FreeTextAnnotationMovedOrResized

Occurs when free text annotation is moved or resized

Declaration
public event FreeTextAnnotationMovedOrResizedEventHandler FreeTextAnnotationMovedOrResized
Event Type
Type Description
FreeTextAnnotationMovedOrResizedEventHandler

FreeTextAnnotationRemoved

Occurs when free text annotation is Removed

Declaration
public event FreeTextAnnotationRemovedEventHandler FreeTextAnnotationRemoved
Event Type
Type Description
FreeTextAnnotationRemovedEventHandler

FreeTextAnnotationSelected

Occurs when free text annotation is selected

Declaration
public event FreeTextAnnotationSelectedEventHandler FreeTextAnnotationSelected
Event Type
Type Description
FreeTextAnnotationSelectedEventHandler

FreeTextAnnotationTapped

Occurs when free text annotation is tapped

Declaration
public event FreeTextAnnotationTappedEventHandler FreeTextAnnotationTapped
Event Type
Type Description
FreeTextAnnotationTappedEventHandler

FreeTextPopupAppearing

Occurs when free text Popup is appearing

Declaration
public event FreeTextPopupAppearingEventHandler FreeTextPopupAppearing
Event Type
Type Description
FreeTextPopupAppearingEventHandler

FreeTextPopupDisappeared

Occurs when free text Popup is disappearing

Declaration
public event FreeTextPopupDisappearedEventHandler FreeTextPopupDisappeared
Event Type
Type Description
FreeTextPopupDisappearedEventHandler

HyperlinkClicked

Occurs when hyperlink click operation is performed.

Declaration
public event HyperlinkClickedEventHandler HyperlinkClicked
Event Type
Type Description
HyperlinkClickedEventHandler

InkAdded

Occurs when ink is added.

Declaration
public event InkAddedEventHandler InkAdded
Event Type
Type Description
InkAddedEventHandler

InkDeselected

Occurs when ink is deselected.

Declaration
public event InkDeselectedEventHandler InkDeselected
Event Type
Type Description
InkDeselectedEventHandler

InkEdited

Occurs when ink is edited.

Declaration
public event InkEditedEventHandler InkEdited
Event Type
Type Description
InkEditedEventHandler

InkRemoved

Occurs when ink is removed.

Declaration
public event InkRemovedEventHandler InkRemoved
Event Type
Type Description
InkRemovedEventHandler

InkSelected

Occurs when ink is selected.

Declaration
public event InkSelectedEventHandler InkSelected
Event Type
Type Description
InkSelectedEventHandler

InkTapped

Occurs when ink is tapped.

Declaration
public event InkTappedEventHandler InkTapped
Event Type
Type Description
InkTappedEventHandler

LongPressed

Occurs when long pressed.

Declaration
public event EventHandler<TouchInteractionEventArgs> LongPressed
Event Type
Type Description
System.EventHandler<TouchInteractionEventArgs>

PageChanged

Occurs when the value of PageNumber property changes.

Declaration
public event PageChangedEventHandler PageChanged
Event Type
Type Description
PageChangedEventHandler

PageViewModeChanged

Occurs when the PageViewMode property changes.

Declaration
public event EventHandler<PageViewModeChangedEventArgs> PageViewModeChanged
Event Type
Type Description
System.EventHandler<PageViewModeChangedEventArgs>

PasswordErrorOccurred

Occurs when Password Error encountered.

Declaration
public event EventHandler<PasswordErrorOccurredEventArgs> PasswordErrorOccurred
Event Type
Type Description
System.EventHandler<PasswordErrorOccurredEventArgs>

PasswordViewCancelButtonClicked

Occurs when password view cancel operation is performed.

Declaration
public event EventHandler PasswordViewCancelButtonClicked
Event Type
Type Description
System.EventHandler

RedoPerformed

Occurs when redo action performed.

Declaration
public event RedoEventHandler RedoPerformed
Event Type
Type Description
RedoEventHandler

SearchCompleted

Occurs when a text search operation is completed.

Declaration
public event TextSearchCompletedEventHandler SearchCompleted
Event Type
Type Description
TextSearchCompletedEventHandler

SearchInitiated

Occurs when a text search operation is initiated.

Declaration
public event TextSearchInitiatedEventHandler SearchInitiated
Event Type
Type Description
TextSearchInitiatedEventHandler

ShapeAnnotationAdded

Occurs when a shape annotation added.

Declaration
public event ShapeAnnotationAddedEventHandler ShapeAnnotationAdded
Event Type
Type Description
ShapeAnnotationAddedEventHandler

ShapeAnnotationDeselected

Occurs when a shape annotation deselected.

Declaration
public event ShapeAnnotationDeselectedEventHandler ShapeAnnotationDeselected
Event Type
Type Description
ShapeAnnotationDeselectedEventHandler

ShapeAnnotationEdited

Occurs when a shape annotation edited.

Declaration
public event ShapeAnnotationEditedEventHandler ShapeAnnotationEdited
Event Type
Type Description
ShapeAnnotationEditedEventHandler

ShapeAnnotationRemoved

Occurs when a shape annotation removed.

Declaration
public event ShapeAnnotationRemovedEventHandler ShapeAnnotationRemoved
Event Type
Type Description
ShapeAnnotationRemovedEventHandler

ShapeAnnotationSelected

Occurs when a shape annotation selected.

Declaration
public event ShapeAnnotationSelectedEventHandler ShapeAnnotationSelected
Event Type
Type Description
ShapeAnnotationSelectedEventHandler

ShapeAnnotationTapped

Occurs when a shape annotation tapped.

Declaration
public event ShapeAnnotationTappedEventHandler ShapeAnnotationTapped
Event Type
Type Description
ShapeAnnotationTappedEventHandler

StampAnnotationAdded

Occurs when a custom view added.

Declaration
public event EventHandler<StampAnnotationAddedEventArgs> StampAnnotationAdded
Event Type
Type Description
System.EventHandler<StampAnnotationAddedEventArgs>

StampAnnotationDeselected

Occurs when custom view is deselected.

Declaration
public event EventHandler<StampAnnotationDeselectedEventArgs> StampAnnotationDeselected
Event Type
Type Description
System.EventHandler<StampAnnotationDeselectedEventArgs>

StampAnnotationMovedOrResized

Occurs when a custom view moved or resized.

Declaration
public event EventHandler<StampAnnotationMovedOrResizedEventArgs> StampAnnotationMovedOrResized
Event Type
Type Description
System.EventHandler<StampAnnotationMovedOrResizedEventArgs>

StampAnnotationRemoved

Occurs when a custom view removed.

Declaration
public event EventHandler<StampAnnotationRemovedEventArgs> StampAnnotationRemoved
Event Type
Type Description
System.EventHandler<StampAnnotationRemovedEventArgs>

StampAnnotationSelected

Occurs when custom view is selected.

Declaration
public event EventHandler<StampAnnotationSelectedEventArgs> StampAnnotationSelected
Event Type
Type Description
System.EventHandler<StampAnnotationSelectedEventArgs>

StampAnnotationTapped

Occurs when custom view is tapped.

Declaration
public event EventHandler<StampAnnotationTappedEventArgs> StampAnnotationTapped
Event Type
Type Description
System.EventHandler<StampAnnotationTappedEventArgs>

Tapped

Occurs when tapped.

Declaration
public event EventHandler<TouchInteractionEventArgs> Tapped
Event Type
Type Description
System.EventHandler<TouchInteractionEventArgs>

TextMarkupAdded

Occurs when a text markup is added.

Declaration
public event TextMarkupAddedEventHandler TextMarkupAdded
Event Type
Type Description
TextMarkupAddedEventHandler

TextMarkupDeselected

Occurs when a text markup is deselected

Declaration
public event TextMarkupDeselectedEventHandler TextMarkupDeselected
Event Type
Type Description
TextMarkupDeselectedEventHandler

TextMarkupEdited

Occurs when a text markup is modified.

Declaration
public event TextMarkupEditedEventHandler TextMarkupEdited
Event Type
Type Description
TextMarkupEditedEventHandler

TextMarkupLongPressed

Occurs when a text markup is long pressed.

Declaration
public event TextMarkupLongPressedEventHandler TextMarkupLongPressed
Event Type
Type Description
TextMarkupLongPressedEventHandler

TextMarkupRemoved

Occurs when a text markup is removed

Declaration
public event TextMarkupRemovedEventHandler TextMarkupRemoved
Event Type
Type Description
TextMarkupRemovedEventHandler

TextMarkupSelected

Occurs when a text markup is selected

Declaration
public event TextMarkupSelectedEventHandler TextMarkupSelected
Event Type
Type Description
TextMarkupSelectedEventHandler

TextMarkupTapped

Occurs when a text markup is tapped

Declaration
public event TextMarkupTappedEventHandler TextMarkupTapped
Event Type
Type Description
TextMarkupTappedEventHandler

TextMatchFound

Occurs when a match for the searched text found.

Declaration
public event TextMatchFoundEventHandler TextMatchFound
Event Type
Type Description
TextMatchFoundEventHandler

TextSelectionCompleted

Occurs when text selection is completed.

Declaration
public event TextSelectionEventHandler TextSelectionCompleted
Event Type
Type Description
TextSelectionEventHandler

UndoPerformed

Occurs when undo action performed.

Declaration
public event UndoEventHandler UndoPerformed
Event Type
Type Description
UndoEventHandler

UnhandledConditionOccurred

Occurs when an unhandled condition occurs.

Declaration
public event UnhandledConditionEventHandler UnhandledConditionOccurred
Event Type
Type Description
UnhandledConditionEventHandler

Implements

System.IDisposable
Android.Views.View.IOnTouchListener
Android.Runtime.IJavaObject
Java.Interop.IJavaPeerable