PdfViewer Members
#Constructors
Name | Description |
---|---|
Pdf |
Initializes a new instance of the Pdf |
#Fields
Name | Description |
---|---|
Active |
Identifies the Active |
Allow |
Identifies the Allow |
Allow |
Identifies the Allow |
Allow |
Identifies the Allow |
Allow |
Identifies the Allow |
Anchor |
Bindable property for Anchor |
Anchor |
Bindable property for Anchor |
Annotation |
Identifies the Annotation |
Annotations |
Identifies the Annotations bindable property. |
Automation |
Bindable property for Automation |
Available |
Identifies the Available |
Background |
Bindable property for Background |
Background |
Bindable property for Background.
Inherited from Visual |
Behaviors |
Bindable property for Behaviors.
Inherited from Visual |
Binding |
Bindable property for Binding |
Border |
Identifies the Border |
Border |
Identifies the Border |
Class |
Bindable property for Class |
Clip |
Bindable property for Clip.
Inherited from Visual |
Corner |
Identifies the Corner |
Current |
Identifies the Current |
Display |
Identifies the Display |
Document |
Identifies the Document |
Flow |
Bindable property for Flow |
Form |
Identifies the Form |
Has |
Identifies the Has |
Height |
Bindable property for Height.
Inherited from Visual |
Height |
Bindable property for Height |
Highlight |
Identifies the Highlight |
Horizontal |
Bindable property for Horizontal |
Input |
Bindable property for Input |
Is |
Identifies the Is |
Is |
Bindable property for Is |
Is |
Bindable property for Is |
Is |
Bindable property for Is |
Is |
Identifies the Is |
Is |
Identifies the Is |
Is |
Identifies the Is |
Is |
Bindable property for Is |
Margin |
Bindable property for Margin. Inherited from View. |
Max |
Identifies the Max |
Minimum |
Bindable property for Minimum |
Minimum |
Bindable property for Minimum |
Min |
Identifies the Min |
Navigation |
Bindable property for Navigation.
Inherited from Visual |
Opacity |
Bindable property for Opacity.
Inherited from Visual |
Padding |
Identifies the Padding bindable property.
Inherited from DXView |
Page |
Identifies the Page |
property |
Represents the view’s internal Property |
Rotation |
Bindable property for Rotation.
Inherited from Visual |
Rotation |
Bindable property for Rotation |
Rotation |
Bindable property for Rotation |
Scale |
Bindable property for Scale.
Inherited from Visual |
Scale |
Bindable property for Scale |
Scale |
Bindable property for Scale |
Search |
Identifies the Search |
Search |
Identifies the Search |
Search |
Identifies the Search |
Selected |
Identifies the Selected |
Selected |
Identifies the Selected |
Selection |
Identifies the Selection |
Show |
Identifies the Show |
Show |
Identifies the Show |
Show |
Identifies the Show |
Signature |
Identifies the Signature |
Signatures |
Identifies the Signatures bindable property. |
Style |
Bindable property for Style.
Inherited from Visual |
Translation |
Bindable property for Translation |
Translation |
Bindable property for Translation |
Triggers |
Bindable property for Triggers.
Inherited from Visual |
Vertical |
Bindable property for Vertical |
Visual |
Bindable property for Visual.
Inherited from Visual |
Width |
Bindable property for Width.
Inherited from Visual |
Width |
Bindable property for Width |
XProperty static |
Bindable property for X.
Inherited from Visual |
YProperty static |
Bindable property for Y.
Inherited from Visual |
Zoom |
Identifies the Zoom |
#Properties
Name | Description |
---|---|
Active |
Returns the PDF viewer’s current mode. |
Allow |
Gets or sets whether the Add Signature functionality is available. This is a bindable property. |
Allow |
Gets or sets whether users can select document content in the PDF viewer. This is a bindable property. |
Allow |
Gets or sets whether you can copy the selected content to the clipboard. |
Allow |
Gets or sets whether interactive fields can be edited. This is a bindable property. |
Anchor |
Gets or sets the X component of the center point for any transform operation, relative to the bounds of the element. This is a bindable property.
Inherited from Visual |
Anchor |
Gets or sets the Y component of the center point for any transform operation, relative to the bounds of the element. This is a bindable property.
Inherited from Visual |
Annotation |
Gets or sets annotation settings. This is a bindable property. |
Annotations | Returns a collection of annotations that exist in the current document. |
Automation |
Gets or sets a value that allows the automation framework to find and interact with this element. Inherited from Element. |
Available |
Gets or sets available document display modes depending on the device type (phone or tablet). |
Background |
Gets or sets the Brush which will be used to fill the background of an element. This is a bindable property.
Inherited from Visual |
Background |
Gets or sets the Color which will fill the background of an element. This is a bindable property.
Inherited from Visual |
Batched |
Gets a value that indicates there are batched changes done for this element.
Inherited from Visual |
Behaviors |
Gets the list of Behavior objects associated to this element. This is a read-only bindable property.
Inherited from Visual |
Binding |
Gets or sets an object that contains the properties that will be targeted by the bound properties that belong to this Bindable |
Border |
Gets or sets the border color of a DXView |
Border |
Gets or sets the border thickness of a DXView |
Bounds |
Gets the bounds of the element in device-independent units.
Inherited from Visual |
class |
Gets or sets the style classes for the element.
Inherited from Navigable |
Class |
Gets or sets a value used to identify a collection of semantically similar elements. Inherited from Element. |
Clip |
Specifies the clipping region for an element. This is a bindable property.
Inherited from Visual |
Commands | Returns the collection of PDF viewer commands. |
Corner |
Gets or sets the corner radius of a DXView |
Current |
Gets or sets the number of the page that is currently displayed in the PDF viewer. This is a bindable property. |
Desired |
Gets the size that this element computed during the measure pass of the layout process.
Inherited from Visual |
Disable |
Gets a value that indicates that layout for this element is disabled.
Inherited from Visual |
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 Bindable |
Display |
Gets or sets how the PDF viewer displays document pages. This is a bindable property. |
Document |
Gets or sets the PDF document source (a string path, URI, or stream). |
Effect |
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. |
Flow |
Gets or sets the layout flow direction. This is a bindable property.
Inherited from Visual |
Form |
Gets or sets the fill color to highlight fields. This is a bindable property. |
Frame |
Gets or sets the frame this element resides in on screen.
Inherited from Visual |
Gesture |
The collection of gesture recognizers associated with this view. Inherited from View. |
Has |
Returns whether the current document has any image or text content selected. |
Height |
Gets the current rendered height of this element. This is a read-only bindable property.
Inherited from Visual |
Height |
Gets or sets the desired height override of this element. This is a bindable property.
Inherited from Visual |
Highlight |
Gets or sets whether to highlight form fields. This is a bindable property. |
Horizontal |
Gets or sets the Layout |
Id | Gets a value that can be used to uniquely identify an element throughout the run of your application. Inherited from Element. |
Input |
Gets or sets a value indicating whether this element responds to hit testing during user interaction. This is a bindable property.
Inherited from Visual |
Is |
Gets or sets whether the DXView |
Is |
Gets or sets a value indicating whether this element is enabled in the user interface. This is a bindable property.
Inherited from Visual |
Is |
Gets a value indicating whether this element is focused currently. This is a bindable property.
Inherited from Visual |
Is |
Returns whether the PDF viewer currently shows the Outlines view. This is a bindable property. |
Is |
Gets or sets a value that indicates whether this elements’s platform equivalent element is enabled.
Inherited from Visual |
Is |
Gets or sets whether you can change the current document in the Pdf |
Is |
Returns whether the PDF viewer currently shows the Thumbnails view. This is a bindable property. |
Is |
Gets or sets a value that determines whether this element will be visible on screen and take up space in layouts. This is a bindable property.
Inherited from Visual |
Logical |
For internal use by the Microsoft. |
Margin | Gets or set the margin for the view. Inherited from View. |
Max |
Gets or sets the maximum zoom factor. This is a bindable property. |
Minimum |
Gets or sets the minimum height the element will request during layout. This is a bindable property.
Inherited from Visual |
Minimum |
Gets or sets the minimum width the element will request during layout. This is a bindable property.
Inherited from Visual |
Min |
Gets or sets the minimum zoom factor. This is a bindable property. |
Navigation |
Gets the object responsible for handling stack-based navigation.
Inherited from Navigable |
Navigation |
Gets the cast of Navigation to a Navigation |
Opacity |
Gets or sets the opacity value applied to the element when it is rendered. The range of this value is 0 to 1; values outside this range will be set to the nearest valid value. This is a bindable property.
Inherited from Visual |
Padding |
Gets or sets the amount of space around the DXView |
Page |
Returns the total number of pages in the current document. |
Parent | Gets or sets the parent Element of this element. Inherited from Element. |
Real |
For internal use by .NET MAUI. Inherited from Element. |
Resources |
Gets or sets the local resource dictionary.
Inherited from Visual |
Rotation |
Gets or sets the rotation (in degrees) about the Z-axis (affine rotation) when the element is rendered. This is a bindable property.
Inherited from Visual |
Rotation |
Gets or sets the rotation (in degrees) about the X-axis (perspective rotation) when the element is rendered. This is a bindable property.
Inherited from Visual |
Rotation |
Gets or sets the rotation (in degrees) about the Y-axis (perspective rotation) when the element is rendered. This is a bindable property.
Inherited from Visual |
Scale |
Gets or sets the scale factor applied to the element. This is a bindable property.
Inherited from Visual |
Scale |
Gets or sets a scale value to apply to the X direction. This is a bindable property.
Inherited from Visual |
Scale |
Gets or sets a scale value to apply to the Y direction. This is a bindable property.
Inherited from Visual |
Search |
Gets or sets whether to consider uppercase and lowercase letters as separate cases. This is a bindable property. |
Search |
Gets or sets the color that is used to highlight search results in the PDF document. |
Search |
Gets or sets whether to consider whole words when searching the given string. This is a bindable property. |
Selected |
Gets or sets the currently selected annotation. This is a bindable property. |
Selected |
Gets or sets the selected signature. This is a bindable property. |
Selection |
Gets or sets the selection area’s fill color. This is a bindable property. |
Show |
Gets or sets whether to show the edit toolbar that contains commands to add annotations, highlight text, free-hand draw, and add signatures. |
Show |
Gets or sets whether to show the page counter. This is a bindable property. |
Show |
Gets or sets whether the built-in PDF viewer toolbar is visible. This is a bindable property. |
Signature |
Gets or sets the signature color. This is a bindable property. |
Signatures | Returns a collection of signatures. |
Signature |
Returns the storage of predefined signatures. |
Style |
Gets or sets the unique Style for this element.
Inherited from Navigable |
Style |
Gets or sets the style classes for the element.
Inherited from Navigable |
Style |
Gets or sets a user defined value to uniquely identify the element. Inherited from Element. |
Translation |
Gets or sets the X translation delta of the element. This is a bindable property.
Inherited from Visual |
Translation |
Gets or sets the Y translation delta of the element. This is a bindable property.
Inherited from Visual |
Triggers |
Gets the list of Trigger |
Vertical |
Gets or sets the Layout |
Visual |
Gets or sets a IVisual implementation that overrides the visual appearance of an element. This is a bindable property.
Inherited from Visual |
Width |
Gets the current width of this element. This is a read-only bindable property.
Inherited from Visual |
Width |
Gets or sets the desired width override of this element. This is a bindable property.
Inherited from Visual |
X |
Gets the current X position of this element. This is a read-only bindable property.
Inherited from Visual |
Y |
Gets the current Y position of this element. This is a read-only bindable property.
Inherited from Visual |
Zoom |
Gets or sets the current zoom factor. This is a bindable property. |
#Methods
Name | Description |
---|---|
Add |
Adds a circle contained within rectangular boundaries on a page with the given index. |
Add |
Adds a text annotation contained within rectangular boundaries on a page with the given index. |
Add |
Adds a free-hand drawing on a page with the given index. |
Add |
Adds a signature defined by a collection of points on the given page. |
Add |
Adds a rectangle with the specified boundaries on a page with the given index. |
Add |
Adds a sticky note annotation. |
Apply |
Applies all the current bindings to Binding |
Batch |
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 Visual |
Batch |
Signals the end of a batch of commands to the element and that those commands should now be committed.
Inherited from Visual |
Change |
Changes the current visual state based on this elements current property values.
Inherited from Visual |
Clear |
Resets the selection. |
Clear |
Clears any value that is previously set for a bindable property.
Inherited from Bindable |
Clear |
Clears any value that is previously set for a bindable property, identified by its key.
Inherited from Bindable |
Close |
Closes the current document. |
Coerce |
Coerces the value of the specified bindable property.
This is done by invoking Bindable |
Coerce |
Coerces the value of the specified bindable property.
This is done by invoking Bindable |
Color |
Changes background and border colors with a smooth animation effect. The Color method returns the Task that ends when animation completes.
Inherited from DXView |
Copy |
Copies the selected content to the clipboard. |
Delete |
Removes the given annotation from the PDF viewer annotation collection. |
Delete |
Removes the given signature. |
Effect |
For internal use by .NET MAUI. Inherited from Element. |
Equals |
Determines whether the specified object instances are considered equal.
Inherited from System. |
Equals |
Determines whether the specified object is equal to the current object.
Inherited from System. |
Export |
Exports field data to a stream in the specified format. |
Find |
Returns the element that has the specified name. Inherited from Element. |
Focus() |
Attempts to set focus to this element.
Inherited from Visual |
Focus |
Goes to the next field in the document. If no field is focused, this method does not focus any fields. |
Focus |
Goes to the previous field in the document. If no field is focused, this method does not focus any fields. |
Get |
Gets the child elements that are visually beneath the specified point .
Inherited from View. |
Get |
Serves as the default hash function.
Inherited from System. |
Get |
Returns an object that contains the selected content. |
Get |
Gets the Type of the current instance.
Inherited from System. |
Get |
Returns the value that is contained in the given bindable property.
Inherited from Bindable |
Highlight |
Highlights selected text with a filled rectangle. |
Import |
Imports field data from a stream in the specified format. |
Invalidate |
Marks the current measure of an element as invalidated.
Inherited from Visual |
Invalidate |
Invalidates the measure of an element.
Inherited from Visual |
Is |
Determines whether or not a bindable property exists and has a value set.
Inherited from Bindable |
Measure |
Returns the minimum size that an element needs in order to be displayed on the device.
Inherited from Visual |
Memberwise |
Creates a shallow copy of the current Object.
Inherited from System. |
IElement |
For internal use by .NET MAUI. Inherited from Element. |
On |
Invoked whenever the binding context of the View changes. Inherited from View. |
On |
Invoked when a child object is added to this element.
Inherited from Visual |
On |
Invoked when a child object is removed from this element.
Inherited from Visual |
On |
Raises the Children |
On |
Method that is called when a layout measurement happens.
Inherited from Visual |
On |
Raises the Property |
Print |
Invokes the system print dialog. |
Redo() | Reapplies the last undone action in the PDF viewer. |
Reference |
Determines whether the specified Object instances are the same instance.
Inherited from System. |
Remove |
Removes a previously set binding from a bindable property.
Inherited from Bindable |
Remove |
Removes a previously set dynamic resource. Inherited from Element. |
Save |
Saves the current PDF document to a stream. |
Select |
Selects the next annotation in the current document. |
Select |
Selects the previous annotation in the Annotations collection. |
Set |
Assigns a binding to a bindable property.
Inherited from Bindable |
Set |
Opens the PDF document passed in method parameters. |
Set |
Sets the Bindable |
Set |
Sets the inherited context to a nested element.
Inherited from Bindable |
Set |
Sets the value of the specified bindable property.
Inherited from Bindable |
Set |
Sets the value of the specified bindable property.
Inherited from Bindable |
Set |
For internal use by the Microsoft. |
Set |
For internal use by .NET MAUI. Inherited from Element. |
Set |
For internal use by .NET MAUI. Inherited from Element. |
Share |
Invokes the share UI that prompts the user to choose an app to share with. |
Show |
Invokes the platform-based file explorer. |
Show |
Invokes the system file picker dialog to save the current PDF document. |
Size |
Method that is called during a layout cycle to signal the start of a sub-tree layout.
Inherited from Visual |
Squiggle |
Underlines selected text with a squiggle line. |
Strikethrough |
Applies strikethrough to selected text. |
To |
Returns a string that represents the current object.
Inherited from System. |
Unapply |
Removes all current bindings from the current context.
Inherited from Bindable |
Underline |
Underlines the selected text with a straight line. |
Undo() | Cancels the previous action. |
Unfocus() |
Unsets keyboard focus on this element.
Inherited from Visual |
#Events
Name | Description |
---|---|
Annotation |
Occurs after an annotation‘s settings are changed. |
Annotation |
Occurs before an annotation‘s settings are changed. |
Annotation |
Occurs after a new annotation is added to a PDF document page. |
Annotation |
Occurs before a newly-created annotation is added to a PDF document page. |
Annotation |
Occurs after an annotation is removed on a PDF document page. |
Annotation |
Occurs before an annotation is removed on a PDF document page. |
Annotation |
Occurs when an annotation is selected. |
Batch |
Occurs when a batch of property changes have been committed by calling Batch |
Binding |
Occurs when the value of the Binding |
Child |
Raised whenever a child element is added to the element. Inherited from Element. |
Child |
Raised whenever a child element is removed from the element. Inherited from Element. |
Children |
Occurs when the order of this element’s children changes.
Inherited from Visual |
Content |
Occurs when the selection area is adjusted in the current document. |
Descendant |
Raised whenever a child element is added to the element’s subtree. Inherited from Element. |
Descendant |
Raised whenever a child element is removed from the elements subtree. Inherited from Element. |
Document |
Occurs after the PDF viewer loads the PDF document. |
Focus |
Occurs when a focus change is requested.
Inherited from Visual |
Focused |
Occurs when this element is focused.
Inherited from Visual |
Form |
Occurs once a user taps a field and before an editor is shown in-place of the field. |
Form |
Occurs after changes are applied to a form field. |
Form |
Occurs before changes are applied to a form field. |
Measure |
Occurs when the current measure of an element has been invalidated.
Inherited from Visual |
Page |
Occurs when a user taps a point on the PDF viewer’s page area. |
Password |
Occurs each time the PDF viewer requests a user to enter a password to open a protected PDF file. |
Property |
Occurs when a property value changes.
Inherited from Bindable |
Property |
Occurs when a property value is changing.
Inherited from Bindable |
Referenced |
Occurs when a user taps a push-button in the current PDF document to open another PDF document. |
Signature |
Occurs after a signature property’s value is changed. |
Signature |
Occurs after a new signature is added to a page. |
Signature |
Occurs before a signature is added so you can cancel adding the signature. |
Signature |
Occurs after a signature is deleted. |
Signature |
Occurs before a signature is deleted so you can cancel the deletion action. |
Signature |
Occurs if a signature is selected or deselected. |
Size |
Occurs when the size of an element changed.
Inherited from Visual |
Tap |
Fires when a user taps a DXControl |
Tap |
Fires when a user taps a DXControl |
Tap |
Fires when a user taps a DXControl |
Unfocused |
Occurs when this element is unfocused.
Inherited from Visual |
Uri |
Occurs when a user taps a push-button in the current PDF document to open a link. |