PdfDocument Class

Definition

Namespace:

PdfKit

Assembly:

Xamarin.iOS.dll

Class for working with PDF documents.

[Foundation.Register("PDFDocument", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 11, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public class PdfDocument : Foundation.NSObject, Foundation.INSCopying, IDisposable

type PdfDocument = class
    inherit NSObject
    interface INSCopying
    interface INativeObject
    interface IDisposable

Inheritance

Object

NSObject

PdfDocument

Attributes

RegisterAttribute IntroducedAttribute

Implements

INSCopying INativeObject IDisposable

Constructors

PdfDocument()	Creates a new PDF document object with default values.
PdfDocument(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
PdfDocument(NSData)	Creates a new PDF document object with the specified data.
PdfDocument(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.
PdfDocument(NSUrl)	Creates a new PDF document object from the data at the specified URL.

Properties

AllowsCommenting	Gets a Boolean value that tells whether the document allows comments.
AllowsContentAccessibility	Gets a Boolean value that tells whether the document allows content accessibility.
AllowsCopying	Gets a Boolean value that tells whether the document allows copying.
AllowsDocumentAssembly	Gets a Boolean value that tells whether the document allows document assembly.
AllowsDocumentChanges	Gets a Boolean value that tells whether the document allows changes.
AllowsFormFieldEntry	Gets a Boolean value that tells whether the document allows form field entry.
AllowsPrinting	Gets a Boolean value that tells whether the document allows printing.
Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
DebugDescription	A developer-meaningful description of this object. (Inherited from NSObject)
Delegate	An instance of the PdfKit.IPdfDocumentDelegate model class which acts as the class delegate.
Description	Description of the object, the Objective-C version of ToString. (Inherited from NSObject)
DidBeginFindNotification	Notification constant for DidBeginFind
DidBeginPageFindNotification	Notification constant for DidBeginPageFind
DidBeginPageWriteNotification	Notification constant for DidBeginPageWrite
DidBeginWriteNotification	Notification constant for DidBeginWrite
DidEndFindNotification	Notification constant for DidEndFind
DidEndPageFindNotification	Notification constant for DidEndPageFind
DidEndPageWriteNotification	Notification constant for DidEndPageWrite
DidEndWriteNotification	Notification constant for DidEndWrite
DidFindMatchNotification	Notification constant for DidFindMatch
DidUnlockNotification	Notification constant for DidUnlock
Document	Gets a Core Graphics PDF object for this PdfKit PDF object.
DocumentAttributes	Gets or sets the attribute dictionary.
DocumentUrl	Gets the URL of the PDF document.
GetClassForAnnotationType	Delegate invoked by the object to get a value.
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
IsDirectBinding	(Inherited from NSObject)
IsEncrypted	Gets a Boolean value that tells whether the document is encrypted.
IsFinding	Gets a Boolean value that tells whether the document is currently searching for text.
IsLocked	Gets a Boolean value that tells whether the document is locked.
IsProxy	(Inherited from NSObject)
MajorVersion	Gets the major version number of the document.
MinorVersion	Gets the minor version of the document.
OutlineRoot	Gets or sets the root outline object.
PageClass	Gets the class (Objective-C type) of pages in the document.
PageCount	Gets the number of pages in the document.
PageType	Gets the .NET type of page objects in this document.
PermissionsStatus
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
Self	(Inherited from NSObject)
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
Text	Gets a linefeed-separated, page-oriented string that contains the entire textual content of the PDF document.
WeakDelegate	An object that can respond to the delegate protocol for this type
Zone	(Inherited from NSObject)

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AwakeFromNib()	Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib(). (Inherited from NSObject)
BeginInvokeOnMainThread(Action)	(Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary)	(Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)	(Inherited from NSObject)
BindingInfo(String)	(Inherited from NSObject)
BindingOptionDescriptions(String)	(Inherited from NSObject)
BindingValueClass(String)	(Inherited from NSObject)
CancelFind()	Cancels an in-progress find operation.
CommitEditing()	(Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr)	(Inherited from NSObject)
ConformsToProtocol(IntPtr)	Invoked to determine if this object implements the specified protocol. (Inherited from NSObject)
Copy()	Performs a copy of the underlying Objective-C object. (Inherited from NSObject)
Copy(NSZone)	Performs a copy of the underlying Objective-C object.
DangerousAutorelease()	(Inherited from NSObject)
DangerousRelease()	(Inherited from NSObject)
DangerousRetain()	(Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates a change occurred to the indexes for a to-many relationship. (Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	Indicates that a change occurred on the specified key. (Inherited from NSObject)
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)	Releases the resources used by the PdfDocument object.
DoesNotRecognizeSelector(Selector)	Indicates that this object does not recognize the specified selector. (Inherited from NSObject)
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
ExchangePages(nint, nint)	Swaps the page at indexA with the one at indexB.
ExposedBindings()	(Inherited from NSObject)
Find(String, NSStringCompareOptions)	Searches for the specified text with the specified comparison options.
Find(String, PdfSelection, NSStringCompareOptions)	Searches for the specified text in a selection with the specified comparison options.
FindAsync(String, NSStringCompareOptions)	Asynchronously searches for the specified text with the specified comparison options.
FindAsync(String[], NSStringCompareOptions)	Asynchronously searches for the specified text with the specified comparison options.
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetDataRepresentation()	Returns an NSData object that contains the PDF data.
GetDataRepresentation(NSDictionary)	Returns an NSData object that contains the PDF data.
GetDictionaryOfValuesFromKeys(NSString[])	Retrieves the values of the specified keys. (Inherited from NSObject)
GetDocumentAttributes()	Returns a dictionary of the document's attributes.
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeField(String)	Obsolete. (Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
GetPage(nint)	Returns the page at the specified zero-based index.
GetPageIndex(PdfPage)	Returns the zero-based index for the specified page.
GetSelection(PdfPage, CGPoint, PdfPage, CGPoint)	Returns a selection for the region that is described by the specified parameters.
GetSelection(PdfPage, nint, PdfPage, nint)	Returns a selection for the region that is described by the specified parameters.
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(Inherited from NSObject)
InitializeHandle(IntPtr)	(Inherited from NSObject)
InsertPage(PdfPage, nint)	Inserts the provided page at the specified index.
Invoke(Action, Double)	(Inherited from NSObject)
Invoke(Action, TimeSpan)	(Inherited from NSObject)
InvokeOnMainThread(Action)	(Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject)
IsEqual(NSObject)	(Inherited from NSObject)
IsKindOfClass(Class)	(Inherited from NSObject)
IsMemberOfClass(Class)	(Inherited from NSObject)
MarkDirty()	Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject)
MutableCopy()	Creates a mutable copy of the specified NSObject. (Inherited from NSObject)
ObjectDidEndEditing(NSObject)	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	Indicates that the value at the specified keyPath relative to this object has changed. (Inherited from NSObject)
OutlineItem(PdfSelection)	Returns the outline item that represents the section where a selection resides.
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter. (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, NSString)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, String)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemovePage(nint)	Removes the page at the specified index.
RespondsToSelector(Selector)	Whether this object recognizes the specified selector. (Inherited from NSObject)
SelectEntireDocument()	Returns a selection that contains the entire document.
SetDocumentAttributes(PdfDocumentAttributes)	Assigns the document attributes.
SetNativeField(String, NSObject)	Obsolete. (Inherited from NSObject)
SetNilValueForKey(NSString)	Sets the value of the specified key to null. (Inherited from NSObject)
SetValueForKey(NSObject, NSString)	Sets the value of the property specified by the key to the specified value. (Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime. (Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	Sets the value of a property that can be reached using a keypath. (Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	Sets the values of this NSObject to those in the specified dictionary. (Inherited from NSObject)
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
Unbind(NSString)	(Inherited from NSObject)
Unbind(String)	(Inherited from NSObject)
Unlock(String)	Attempts to unlock the document with the specified password, returning true on success.
ValueForKey(NSString)	Returns the value of the property associated with the specified key. (Inherited from NSObject)
ValueForKeyPath(NSString)	Returns the value of a property that can be reached using a keypath. (Inherited from NSObject)
ValueForUndefinedKey(NSString)	Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates that the values of the specified indices in the specified key are about to change. (Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	Indicates that the value of the specified key is about to change. (Inherited from NSObject)
Write(NSUrl, NSDictionary)	Writes the document to the specified URL with the specified options.
Write(NSUrl, PdfDocumentWriteOptions)	Writes the document to the specified URL with the specified options.
Write(NSUrl)	Writes the document to the specified URL.
Write(String, NSDictionary)	Writes the document to the specified path with the specified options.
Write(String, PdfDocumentWriteOptions)	Writes the document to the specified path with the specified options.
Write(String)	Writes the document to the specified path.

Events

DidBeginDocumentFind	Event raised by the object.
DidMatchString	Event raised by the object.
DidUnlock	Event raised by the object.
FindFinished	Event raised by the object.
MatchFound	Event raised by the object.
PageFindFinished	Event raised by the object.
PageFindStarted	Event raised by the object.

Extension Methods

GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject)	Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.