PdfSharp.Pdf.PdfViewerPreferences Class Reference
Represents the PDF document viewer preferences dictionary. More...
Inheritance diagram for PdfSharp.Pdf.PdfViewerPreferences:
Classes | |
| class | Keys |
| Predefined keys of this dictionary. | |
Properties | |
| bool | HideToolbar [get, set] |
| Gets or sets a value indicating whether to hide the viewer application’s tool bars when the document is active. More... | |
| bool | HideMenubar [get, set] |
| Gets or sets a value indicating whether to hide the viewer application’s menu bar when the document is active. More... | |
| bool | HideWindowUI [get, set] |
| Gets or sets a value indicating whether to hide user interface elements in the document’s window (such as scroll bars and navigation controls), leaving only the document’s contents displayed. More... | |
| bool | FitWindow [get, set] |
| Gets or sets a value indicating whether to resize the document’s window to fit the size of the first displayed page. More... | |
| bool | CenterWindow [get, set] |
| Gets or sets a value indicating whether to position the document’s window in the center of the screen. More... | |
| bool | DisplayDocTitle [get, set] |
| Gets or sets a value indicating whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary. If false, the title bar should instead display the name of the PDF file containing the document. More... | |
| PdfReadingDirection? | Direction [get, set] |
| The predominant reading order for text: LeftToRight or RightToLeft (including vertical writing systems, such as Chinese, Japanese, and Korean). This entry has no direct effect on the document’s contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up. Default value: LeftToRight. More... | |
 Properties inherited from PdfSharp.Pdf.PdfDictionary | |
| DictionaryElements | Elements [get] |
| Gets the hashtable containing the elements of this dictionary. More... | |
| PdfStream | Stream [get, set] |
| Gets or sets the PDF stream belonging to this dictionary. Returns null if the dictionary has no stream. To create the stream, call the CreateStream function. More... | |
| Properties inherited from PdfSharp.Pdf.PdfObject | |
| virtual PdfDocument | Owner [get] |
| Gets the PdfDocument this object belongs to. More... | |
| bool | IsIndirect [get] |
| Indicates whether the object is an indirect object. More... | |
| PdfObjectInternals | Internals [get] |
| Gets the PdfInternals object of this document, that grants access to some internal structures which are not part of the public interface of PdfDocument. More... | |
| PdfReference | Reference [get, set] |
| Gets the indirect reference of this object. If the value is null, this object is a direct object. More... | |
Additional Inherited Members | |
| Public Member Functions inherited from PdfSharp.Pdf.PdfDictionary | |
| PdfDictionary () | |
| Initializes a new instance of the PdfDictionary class. More... | |
| PdfDictionary (PdfDocument document) | |
| Initializes a new instance of the PdfDictionary class. More... | |
| new PdfDictionary | Clone () |
| Creates a copy of this dictionary. Direct values are deep copied. Indirect references are not modified. More... | |
| IEnumerator | GetEnumerator () |
| Returns an enumerator that iterates through a collection. More... | |
| override string | ToString () |
| Returns a string with the content of this object in a readable form. Useful for debugging purposes only. More... | |
| PdfStream | CreateStream (byte[] value) |
| Creates the stream of this dictionary and initializes it with the specified byte array. The function must not be called if the dictionary already has a stream. More... | |
| Public Member Functions inherited from PdfSharp.Pdf.PdfObject | |
| new PdfObject | Clone () |
| Creates a copy of this object. The clone does not belong to a document, i.e. its owner and its iref are null. More... | |
| Public Member Functions inherited from PdfSharp.Pdf.PdfItem | |
| PdfItem | Clone () |
| Creates a copy of this object. More... | |
| Protected Member Functions inherited from PdfSharp.Pdf.PdfDictionary | |
| PdfDictionary (PdfDictionary dict) | |
| Initializes a new instance from an existing dictionary. Used for object type transformation. More... | |
| override object | Copy () |
| This function is useful for importing objects from external documents. The returned object is not yet complete. irefs refer to external objects and directed objects are cloned but their document property is null. A cloned dictionary or array needs a 'fix-up' to be a valid object. More... | |
| Protected Member Functions inherited from PdfSharp.Pdf.PdfObject | |
| PdfObject () | |
| Initializes a new instance of the PdfObject class. More... | |
| PdfObject (PdfDocument document) | |
| Initializes a new instance of the PdfObject class. More... | |
| PdfObject (PdfObject obj) | |
| Initializes a new instance from an existing object. Used for object type transformation. More... | |
| override object | Copy () |
| Implements the copy mechanism. Must be overridden in derived classes. More... | |
| Protected Attributes inherited from PdfSharp.Pdf.PdfDictionary | |
| DictionaryElements | elements |
| The elements of the dictionary. More... | |
Detailed Description
Represents the PDF document viewer preferences dictionary.
Property Documentation
◆ CenterWindow
|
getset |
Gets or sets a value indicating whether to position the document’s window in the center of the screen.
◆ Direction
|
getset |
The predominant reading order for text: LeftToRight or RightToLeft (including vertical writing systems, such as Chinese, Japanese, and Korean). This entry has no direct effect on the document’s contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up. Default value: LeftToRight.
◆ DisplayDocTitle
|
getset |
Gets or sets a value indicating whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary. If false, the title bar should instead display the name of the PDF file containing the document.
◆ FitWindow
|
getset |
Gets or sets a value indicating whether to resize the document’s window to fit the size of the first displayed page.
◆ HideMenubar
|
getset |
Gets or sets a value indicating whether to hide the viewer application’s menu bar when the document is active.
◆ HideToolbar
|
getset |
Gets or sets a value indicating whether to hide the viewer application’s tool bars when the document is active.
◆ HideWindowUI
|
getset |
Gets or sets a value indicating whether to hide user interface elements in the document’s window (such as scroll bars and navigation controls), leaving only the document’s contents displayed.
The documentation for this class was generated from the following file:
- PdfSharp.Pdf/PdfViewerPreferences.cs
