PdfDocument Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Class for working with PDF documents.
[Foundation.Register("PDFDocument", true)]
public class PdfDocument : Foundation.NSObject, Foundation.INSCopying, IDisposable[<Foundation.Register("PDFDocument", true)>]
type PdfDocument = class
inherit NSObject
interface INSCopying
interface INativeObject
interface IDisposable- Inheritance
- Attributes
- Implements
Constructors
| Name | Description |
|---|---|
| PdfDocument() |
Creates a new PDF document object with default values. |
| PdfDocument(NativeHandle) |
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
| Name | Description |
|---|---|
| AccessibilityAttributedUserInputLabels | (Inherited from NSObject) |
| AccessibilityRespondsToUserInteraction | (Inherited from NSObject) |
| AccessibilityTextualContext | (Inherited from NSObject) |
| AccessibilityUserInputLabels | (Inherited from NSObject) |
| AccessPermissions | |
| 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 Objective-C class handle for this class. |
| DebugDescription | (Inherited from NSObject) |
| Delegate |
An instance of the PdfKit.IPdfDocumentDelegate model class which acts as the class delegate. |
| Description | (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. |
| ExposedBindings | (Inherited from NSObject) |
| FoundSelectionKey |
Represents the value associated with the constant 'PDFDocumentFoundSelectionKey'. |
| GetClassForAnnotationClass | |
| GetClassForAnnotationType |
Delegate invoked by the object to get a value. |
| Handle |
Handle (pointer) to the unmanaged object representation. (Inherited from NSObject) |
| IsDirectBinding |
Gets or sets a value indicating whether this instance uses direct Objective-C binding. (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. |
| PageIndexKey |
Represents the value associated with the constant 'PDFDocumentPageIndexKey'. |
| PageType |
Gets the .NET type of page objects in this document. |
| PermissionsStatus | |
| RetainCount | (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
| Name | Description |
|---|---|
| AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) | (Inherited from NSObject) |
| AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) | (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() | (Inherited from NSObject) |
| BeginInvokeOnMainThread(Action) |
Invokes the specified action asynchronously on the main UI thread. (Inherited from NSObject) |
| BeginInvokeOnMainThread(Selector, NSObject) |
Invokes asynchronously the specified code on the main UI thread. (Inherited from NSObject) |
| Bind(NSString, NSObject, String, NSBindingOptions) | (Inherited from NSObject) |
| Bind(NSString, NSObject, String, NSDictionary) | (Inherited from NSObject) |
| CancelFind() |
Cancels an in-progress find operation. |
| CommitEditing() | (Inherited from NSObject) |
| CommitEditing(NSObject, Selector, IntPtr) | (Inherited from NSObject) |
| ConformsToProtocol(NativeHandle) | (Inherited from NSObject) |
| Copy() | (Inherited from NSObject) |
| Copy(NSZone) |
Performs a copy of the underlying Objective-C object. |
| DangerousAutorelease() |
Calls the 'autorelease' selector on this object. (Inherited from NSObject) |
| DangerousRelease() |
Calls the 'release' selector on this object. (Inherited from NSObject) |
| DangerousRetain() |
Calls the 'retain' selector on this object. (Inherited from NSObject) |
| DidChange(NSKeyValueChange, NSIndexSet, NSString) | (Inherited from NSObject) |
| DidChange(NSString, NSKeyValueSetMutationKind, NSSet) | (Inherited from NSObject) |
| DidChangeValue(String) | (Inherited from NSObject) |
| Dispose() |
Releases the resources used by the NSObject object. (Inherited from NSObject) |
| Dispose(Boolean) | |
| DoesNotRecognizeSelector(Selector) | (Inherited from NSObject) |
| Equals(NSObject) |
Determines whether the specified NSObject is equal to the current NSObject. (Inherited from NSObject) |
| Equals(Object) |
Determines whether the specified object is equal to the current NSObject. (Inherited from NSObject) |
| ExchangePages(IntPtr, IntPtr) |
Swaps the page at |
| 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[]) | (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) |
| GetNativeHash() | (Inherited from NSObject) |
| GetPage(IntPtr) |
Returns the page at the specified zero-based index. |
| GetPageIndex(PdfPage) |
Returns the zero-based index for the specified page. |
| GetPrintOperation(NSPrintInfo, PdfPrintScalingMode, Boolean) | |
| GetSelection(PdfPage, CGPoint, PdfPage, CGPoint, PdfSelectionGranularity) | |
| GetSelection(PdfPage, CGPoint, PdfPage, CGPoint) |
Returns a selection for the region that is described by the specified parameters. |
| GetSelection(PdfPage, IntPtr, PdfPage, IntPtr) |
Returns a selection for the region that is described by the specified parameters. |
| Init() |
Initializes the object by calling the Objective-C |
| InitializeHandle(NativeHandle, String) | (Inherited from NSObject) |
| InitializeHandle(NativeHandle) | (Inherited from NSObject) |
| InsertPage(PdfPage, IntPtr) |
Inserts the provided |
| Invoke(Action, Double) |
Invokes the specified action after the specified delay. (Inherited from NSObject) |
| Invoke(Action, TimeSpan) |
Invokes the specified action after the specified delay. (Inherited from NSObject) |
| InvokeOnMainThread(Action) |
Invokes the specified action synchronously on the main UI thread. (Inherited from NSObject) |
| InvokeOnMainThread(Selector, NSObject) |
Invokes synchronously 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() | (Inherited from NSObject) |
| ObjectDidEndEditing(NSObject) | (Inherited from NSObject) |
| ObserveValue(NSString, NSObject, NSDictionary, IntPtr) | (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) | (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) | (Inherited from NSObject) |
| RemoveObserver(NSObject, NSString) | (Inherited from NSObject) |
| RemoveObserver(NSObject, String, IntPtr) | (Inherited from NSObject) |
| RemoveObserver(NSObject, String) | (Inherited from NSObject) |
| RemovePage(IntPtr) |
Removes the page at the specified |
| RespondsToSelector(Selector) | (Inherited from NSObject) |
| SelectEntireDocument() |
Returns a selection that contains the entire document. |
| SetDocumentAttributes(PdfDocumentAttributes) |
Assigns the document attributes. |
| SetNilValueForKey(NSString) | (Inherited from NSObject) |
| SetValueForKey(NSObject, NSString) | (Inherited from NSObject) |
| SetValueForKeyPath(NativeHandle, NSString) |
Sets the value for the property identified by a given key path to a given value. (Inherited from NSObject) |
| SetValueForKeyPath(NSObject, NSString) | (Inherited from NSObject) |
| SetValueForUndefinedKey(NSObject, NSString) | (Inherited from NSObject) |
| SetValuesForKeysWithDictionary(NSDictionary) | (Inherited from NSObject) |
| ToString() |
Returns a string representation of the value of the current instance. (Inherited from NSObject) |
| Unbind(NSString) | (Inherited from NSObject) |
| Unlock(String) |
Attempts to unlock the document with the specified |
| ValueForKey(NSString) | (Inherited from NSObject) |
| ValueForKeyPath(NSString) | (Inherited from NSObject) |
| ValueForUndefinedKey(NSString) | (Inherited from NSObject) |
| WillChange(NSKeyValueChange, NSIndexSet, NSString) | (Inherited from NSObject) |
| WillChange(NSString, NSKeyValueSetMutationKind, NSSet) | (Inherited from NSObject) |
| WillChangeValue(String) | (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
| Name | Description |
|---|---|
| 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. |