Class
MobilePDFViewer
Description
Displays PDF content.
Properties
Name |
Type |
Read-Only |
Shared |
---|---|---|---|
✓ |
|||
✓ |
|||
✓ |
|||
✓ |
|||
✓ |
|||
✓ |
|||
✓ |
|||
✓ |
|||
✓ |
Methods
Name |
Parameters |
Returns |
Shared |
---|---|---|---|
constraint As iOSLayoutConstraint |
|||
child As MobileUIControl |
|||
index As Integer |
|||
index As Integer |
|||
constraint As iOSLayoutConstraint |
|||
child As MobileUIControl |
|||
Enumerations
MobilePDFViewer.DisplayModes
DisplayModes
The differen ways in which pages can be displayed.
Name |
---|
SinglePageContinuous |
SinglePage |
TwoUpContinuous |
TwoUp |
Property descriptions
MobilePDFViewer.AccessibilityHint
AccessibilityHint As String
The accessibility hint is a longer description that is read aloud when VoiceOver is enabled.
Me.AccessibilityHint = "Click to calculate the value and display the next screen."
Important
This property is not currently supported for Android.
MobilePDFViewer.AccessibilityLabel
AccessibilityLabel As String
The accessibility label of of a control is a short name that is read aloud when VoiceOver is enabled.
Me.AccessibilityLabel = "Calculate the value."
MobilePDFViewer.BackgroundColor
BackgroundColor As ColorGroup
The color of the background of the thumbnail viewer section if displayed.
MobilePDFViewer.Content
Content As String
The text (if any) on the pages.
This property is read-only.
MobilePDFViewer.ControlCount
ControlCount As Integer
The number of child controls in the control.
This property is read-only.
Important
This property is supported for iOS only.
MobilePDFViewer.DisplayMode
DisplayMode As MobilePDFViewer.DisplayModes
The layout format used to display pages.
MobilePDFViewer.Document
Document As FolderItem
The PDF file being displayed.
MobilePDFViewer.Enabled
Enabled As Boolean
Indicates whether the control is enabled or disabled.
Disable the control:
PDFViewer1.Enabled = False
MobilePDFViewer.HasThumbnails
HasThumbnails As Boolean
Controls whether or not the thumbnail pane is displayed.
This must be set either using the Inspector or in the Opening event.
MobilePDFViewer.Height
Height As Integer
The height of the control.
This property is read-only on iOS.
MobilePDFViewer.Left
Left As Integer
The left position of the control.
This property is read-only on iOS.
MobilePDFViewer.LockBottom
LockBottom As Boolean
Determines whether the bottom edge of the control should stay at a set distance from the bottom edge of the parent control, if there is one, or the owning screen.
Important
This property is not currently supported for iOS. Use constraints instead.
This property can be set in the control's Inspector. The following example sets it in code.
Me.LockBottom = True
MobilePDFViewer.LockLeft
LockLeft As Boolean
Determines whether the left edge of the control should stay at a set distance from the left edge of the parent control, if there is one, or the owning screen.
LockLeft and Locktop default to True when you add a new control to a screen. Existing controls will be altered only if LockRight and/or LockBottom are not set. LockLeft has no effect unless LockRight is True.
Important
This property is not currently supported for iOS. Use constraints instead.
This property can be set in the control's Inspector. The following example sets it in code.
Me.LockLeft = True
MobilePDFViewer.LockRight
LockRight As Boolean
Determines whether the right edge of the control should stay at a set distance from the right edge of the parent control, if there is one, or the owning screen.
Important
This property is not currently supported for iOS. Use constraints instead.
This property can be set in the control's Inspector. The following example sets it in code.
Me.LockRight = True
MobilePDFViewer.LockTop
LockTop As Boolean
Determines whether the top edge of the control should stay at a set distance from the top edge of the parent control, if there is one, or the owning screen.
LockTop and LockLeft default to True when you add a control to a screen. Existing controls will be altered only if LockRight and/or LockBottom are not set. LockTop has no effect unless LockBottom is True.
Important
This property is not currently supported for iOS. Use constraints instead.
This property can be set in the control's Inspector. The following example sets it in code.
Me.LockTop = True
MobilePDFViewer.Name
Name As String
The name of the control.
This property is read-only.
MobilePDFViewer.Page
Page As Integer
The number of the currently displayed page.
MobilePDFViewer.PageCount
PageCount As Integer
The total number of pages in the document.
This property is read-only.
MobilePDFViewer.Parent
Parent As MobileUIControl
The parent (sometimes called a "Super") class of the control.
This property is read-only.
MobilePDFViewer.TintColor
TintColor As ColorGroup
The tint color of the control. Not supported for MobilePDFViewer.
MobilePDFViewer.Top
Top As Integer
The top position of the control.
This property is read-only on iOS.
MobilePDFViewer.Visible
Visible As Boolean
Indicates whether the control is visible.
MobilePDFViewer.Width
Width As Integer
The width of the control.
This property is read-only on iOS.
Method descriptions
MobilePDFViewer.AddConstraint
AddConstraint(constraint As iOSLayoutConstraint)
Adds a constraint to the control.
This constraint is used by child controls that have been added to this control.
Important
This is supported for iOS only.
MobilePDFViewer.AddControl
AddControl(child As MobileUIControl)
Adds a child control to the control.
Important
This is supported for iOS only.
MobilePDFViewer.ClearFocus
ClearFocus
Removes the focus from the control.
TextField1.ClearFocus
MobilePDFViewer.ControlAt
ControlAt(index As Integer) As MobileUIControl
Gets the child control at the specified index.
Important
This is supported for iOS only.
MobilePDFViewer.Controls
Controls As Iterable
Allows you to iterate through all the controls that have been added to this control.
Important
This is supported for iOS only.
MobilePDFViewer.Handle
Handle As Ptr
The handle to the underlying native OS control.
Important
This is supported for iOS only.
MobilePDFViewer.PictureOfPageAt
PictureOfPageAt(index As Integer) As Picture
Returns the page at the index passed as a Picture.
Important
This is supported for iOS only.
MobilePDFViewer.Refresh
Refresh
Marks the control so that it will be redrawn during the next event loop.
Call Refresh to force a Canvas to redraw itself:
Canvas1.Refresh
MobilePDFViewer.RemoveConstraint
RemoveConstraint(constraint As iOSLayoutConstraint)
Removes a constraint from the control.
Important
This is supported for iOS only.
MobilePDFViewer.RemoveControl
RemoveControl(child As MobileUIControl)
Removes the control from the control.
Important
This is supported for iOS only.
MobilePDFViewer.SetFocus
SetFocus
Sets the focus to the control.
Event descriptions
MobilePDFViewer.Closing
Closing
Called when the control's layout is closing.
MobilePDFViewer.Opening
Opening
Called when the control's layout is opening.
This is where you typically put initialization code.
This example in the Opening event of a label sets its text to "Hello":
Me.Text = "Hello"
Compatibility
iOS projects on the iOS operating system.
See also
MobileUIControl parent class