You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

1086 lines
44 KiB

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Spire.PdfViewer.Forms</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Spire.PdfViewer.Forms.ZoomMode">
  8. <summary>
  9. </summary>
  10. </member>
  11. <member name="F:Spire.PdfViewer.Forms.ZoomMode.Default">
  12. <summary>
  13. </summary>
  14. </member>
  15. <member name="F:Spire.PdfViewer.Forms.ZoomMode.FitPage">
  16. <summary>
  17. </summary>
  18. </member>
  19. <member name="F:Spire.PdfViewer.Forms.ZoomMode.FitWidth">
  20. <summary>
  21. </summary>
  22. </member>
  23. <member name="M:Spire.PdfViewer.Forms.PdfViewer.SaveAsImage(System.Int32)">
  24. <summary>
  25. Saves page to image.
  26. </summary>
  27. <param name="pageNumber">Page number</param>
  28. <returns></returns>
  29. </member>
  30. <member name="M:Spire.PdfViewer.Forms.PdfViewer.SaveAsImage(System.Int32,System.Int32)">
  31. <summary>
  32. Saves page to image.
  33. </summary>
  34. <param name="startPageNumber">start page number</param>
  35. <param name="endPageNumber">end page number</param>
  36. <returns></returns>
  37. </member>
  38. <member name="M:Spire.PdfViewer.Forms.PdfViewer.GoToPage(System.Int32)">
  39. <summary>
  40. Jump to a specified page number.
  41. </summary>
  42. <param name="index">The number of the page to jump to.</param>
  43. </member>
  44. <member name="M:Spire.PdfViewer.Forms.PdfViewer.LoadFromStream(System.IO.Stream)">
  45. <summary>
  46. Load a PDF document from a Stream.
  47. </summary>
  48. <param name="stream">A Stream containing a PDF document.</param>
  49. </member>
  50. <member name="M:Spire.PdfViewer.Forms.PdfViewer.LoadFromFile(System.String)">
  51. <summary>
  52. Load a PDF document from a file.
  53. </summary>
  54. <param name="filePath">The name of the file that contains the PDF document.</param>
  55. </member>
  56. <member name="M:Spire.PdfViewer.Forms.PdfViewer.LoadFromFile(System.String,System.String)">
  57. <summary>
  58. Load a PDF document from a file.
  59. </summary>
  60. <param name="fileName">file name</param>
  61. <param name="password">password</param>
  62. </member>
  63. <member name="M:Spire.PdfViewer.Forms.PdfViewer.SaveToFile(System.String)">
  64. <summary>
  65. Save PDF documetns
  66. </summary>
  67. <param name="filePath"></param>
  68. </member>
  69. <member name="M:Spire.PdfViewer.Forms.PdfViewer.SaveToFile(System.IO.Stream)">
  70. <summary>
  71. Stream to save PDF document
  72. </summary>
  73. <param name="stream"></param>
  74. </member>
  75. <member name="M:Spire.PdfViewer.Forms.PdfViewer.PrintDoc">
  76. <summary>
  77. Print document.
  78. </summary>
  79. </member>
  80. <member name="M:Spire.PdfViewer.Forms.PdfViewer.Print">
  81. <summary>
  82. Print pdf document
  83. </summary>
  84. </member>
  85. <member name="M:Spire.PdfViewer.Forms.PdfViewer.CloseDocument">
  86. <summary>
  87. Close current pdf document.
  88. </summary>
  89. </member>
  90. <member name="M:Spire.PdfViewer.Forms.PdfViewer.EnableHandTool">
  91. <summary>
  92. Enable hand tool then can drag PDF document
  93. </summary>
  94. </member>
  95. <member name="M:Spire.PdfViewer.Forms.PdfViewer.EscapeHandTool">
  96. <summary>
  97. Escape hand tool
  98. </summary>
  99. </member>
  100. <member name="M:Spire.PdfViewer.Forms.PdfViewer.GetThumbnailControl">
  101. <summary>
  102. Gets PDF document thumnail control
  103. </summary>
  104. <returns></returns>
  105. </member>
  106. <member name="M:Spire.PdfViewer.Forms.PdfViewer.Rotate(Spire.PdfViewer.Forms.RotateAngle)">
  107. <summary>
  108. Rotate PDF document
  109. </summary>
  110. <param name="angle"></param>
  111. </member>
  112. <member name="M:Spire.PdfViewer.Forms.PdfViewer.GetBookmarkContainer">
  113. <summary>
  114. Gets PDF document root bookmark
  115. </summary>
  116. <returns></returns>
  117. </member>
  118. <member name="M:Spire.PdfViewer.Forms.PdfViewer.GetDocumentAttachments">
  119. <summary>
  120. Gets PDF document all of attachments
  121. </summary>
  122. <returns></returns>
  123. </member>
  124. <member name="M:Spire.PdfViewer.Forms.PdfViewer.GetDocumentAttachmentAnnotations">
  125. <summary>
  126. Gets PDF document all of attachment annotations
  127. </summary>
  128. <returns></returns>
  129. </member>
  130. <member name="M:Spire.PdfViewer.Forms.PdfViewer.SetViewerMode(Spire.PdfViewer.Forms.PdfViewerMode.PdfViewerMode)">
  131. <summary>
  132. Sets PdfViewer display mode
  133. </summary>
  134. <param name="mode"></param>
  135. </member>
  136. <member name="M:Spire.PdfViewer.Forms.PdfViewer.SetPageLayouMode(Spire.PdfViewer.Forms.PageLayoutMode)">
  137. <summary>
  138. Sets PDF document page display mode
  139. </summary>
  140. <param name="mode"></param>
  141. </member>
  142. <member name="F:Spire.PdfViewer.Forms.PdfViewer.m_Disposed">
  143. <summary>
  144. whether dispose mehtod has been called.
  145. </summary>
  146. </member>
  147. <member name="M:Spire.PdfViewer.Forms.PdfViewer.Dispose(System.Boolean)">
  148. <summary>
  149. Release resources(managed/unmanaged)
  150. Dispose(bool disposing) executes in two distinct scenarios.
  151. If disposing equals true,
  152. the method has been called directly or indirectly by a user'code.
  153. Managed and unmanaged resources can be disposed.
  154. if disposing equals false,
  155. the method has been called by the runtime from the finalizer and you
  156. should not reference other objects.Only unmanaged resources can be disposed.
  157. </summary>
  158. <param name="disposing"> </param>
  159. </member>
  160. <member name="P:Spire.PdfViewer.Forms.PdfViewer.FileName">
  161. <summary>
  162. Gets current opened pdf file name.
  163. </summary>
  164. </member>
  165. <member name="P:Spire.PdfViewer.Forms.PdfViewer.PageCount">
  166. <summary>
  167. Gets the current number of display pages for the content.
  168. </summary>
  169. </member>
  170. <member name="P:Spire.PdfViewer.Forms.PdfViewer.IsToolBarVisible">
  171. <summary>
  172. Gets or sets whether is visible of toolbar.
  173. </summary>
  174. </member>
  175. <member name="P:Spire.PdfViewer.Forms.PdfViewer.PrintDocument">
  176. <summary>
  177. Defines a reusable object that sends output to a printer, when printing from current document.
  178. </summary>
  179. </member>
  180. <member name="P:Spire.PdfViewer.Forms.PdfViewer.PrintSettings">
  181. <summary>
  182. Get the print settings.
  183. </summary>
  184. </member>
  185. <member name="P:Spire.PdfViewer.Forms.PdfViewer.CurrentPageNumber">
  186. <summary>
  187. Gets the page number for the currently displayed page.
  188. </summary>
  189. </member>
  190. <member name="P:Spire.PdfViewer.Forms.PdfViewer.IgnoreCase">
  191. <summary>
  192. the found text ignore case
  193. </summary>
  194. </member>
  195. <member name="P:Spire.PdfViewer.Forms.PdfViewer.FindTextHighLightColor">
  196. <summary>
  197. The found text to highlight
  198. </summary>
  199. </member>
  200. <member name="P:Spire.PdfViewer.Forms.PdfViewer.ViewerBackgroundColor">
  201. <summary>
  202. Set the PdfViewer background color
  203. </summary>
  204. </member>
  205. <member name="E:Spire.PdfViewer.Forms.PdfViewer.PageNumberChanged">
  206. <summary>
  207. Occurs current page number changed.
  208. </summary>
  209. </member>
  210. <member name="E:Spire.PdfViewer.Forms.PdfViewer.DocumentOpened">
  211. <summary>
  212. Occurs after a document is opened.
  213. </summary>
  214. </member>
  215. <member name="E:Spire.PdfViewer.Forms.PdfViewer.DocumentClosed">
  216. <summary>
  217. Occurs after a document is closed.
  218. </summary>
  219. </member>
  220. <member name="E:Spire.PdfViewer.Forms.PdfViewer.ImageRender">
  221. <summary>
  222. Occurs before renderinge a image.
  223. </summary>
  224. </member>
  225. <member name="E:Spire.PdfViewer.Forms.PdfViewer.ZoomChanged">
  226. <summary>
  227. Occurs zoom changed.
  228. </summary>
  229. </member>
  230. <member name="F:Spire.PdfViewer.Forms.PdfViewerToolbar.m_Disposed">
  231. <summary>
  232. whether dispose mehtod has been called.
  233. </summary>
  234. </member>
  235. <member name="M:Spire.PdfViewer.Forms.PdfViewerToolbar.Dispose(System.Boolean)">
  236. <summary>
  237. Release resources(managed/unmanaged)
  238. Dispose(bool disposing) executes in two distinct scenarios.
  239. If disposing equals true,
  240. the method has been called directly or indirectly by a user'code.
  241. Managed and unmanaged resources can be disposed.
  242. if disposing equals false,
  243. the method has been called by the runtime from the finalizer and you
  244. should not reference other objects.Only unmanaged resources can be disposed.
  245. </summary>
  246. <param name="disposing"></param>
  247. </member>
  248. <member name="T:Spire.PdfViewer.Forms.PdfThumbnails.PdfDocumentThumbnail">
  249. <summary>
  250. PDF document thumbnail control
  251. </summary>
  252. </member>
  253. <member name="F:Spire.PdfViewer.Forms.PdfThumbnails.PdfDocumentThumbnail.components">
  254. <summary>
  255. Required designer variable.
  256. </summary>
  257. </member>
  258. <member name="M:Spire.PdfViewer.Forms.PdfThumbnails.PdfDocumentThumbnail.Dispose(System.Boolean)">
  259. <summary>
  260. Clean up any resources being used.
  261. </summary>
  262. <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
  263. </member>
  264. <member name="M:Spire.PdfViewer.Forms.PdfThumbnails.PdfDocumentThumbnail.InitializeComponent">
  265. <summary>
  266. Required method for Designer support - do not modify
  267. the contents of this method with the code editor.
  268. </summary>
  269. </member>
  270. <member name="M:Spire.PdfViewer.Forms.PdfThumbnails.PdfDocumentThumbnail.m_viewer_DocumentLoaded(System.Object,System.EventArgs)">
  271. <summary>
  272. Raises the Load event.
  273. </summary>
  274. <param name="sender">The source of the event.</param>
  275. <param name="e">A EventArgs that contains the event data.</param>
  276. </member>
  277. <member name="M:Spire.PdfViewer.Forms.PdfThumbnails.PdfDocumentThumbnail.m_viewer_PageNumberChanged(System.Object,System.EventArgs)">
  278. <summary>
  279. Raises the PageNumberChanged event.
  280. </summary>
  281. <param name="sender">The source of the event.</param>
  282. <param name="e">A EventArgs that contains the event data.</param>
  283. </member>
  284. <member name="M:Spire.PdfViewer.Forms.PdfThumbnails.PdfDocumentThumbnail.OnPaint(System.Windows.Forms.PaintEventArgs)">
  285. <summary>
  286. Raises the Paint event.
  287. </summary>
  288. <param name="e">A args that contains event data.</param>
  289. </member>
  290. <member name="M:Spire.PdfViewer.Forms.PdfThumbnails.PdfDocumentThumbnail.OnMouseClick(System.Windows.Forms.MouseEventArgs)">
  291. <summary>
  292. Raises the MouseClick event.
  293. </summary>
  294. <param name="e">A MouseEventArgs that contains event data.</param>
  295. </member>
  296. <member name="M:Spire.PdfViewer.Forms.PdfThumbnails.PdfDocumentThumbnail.OnResize(System.EventArgs)">
  297. <summary>
  298. Raises the Size Changed event.
  299. </summary>
  300. <param name="e">A args that contains event data.</param>
  301. </member>
  302. <member name="P:Spire.PdfViewer.Forms.PdfThumbnails.PdfDocumentThumbnail.ZoomPercent">
  303. <summary>
  304. thumnail zoom percentage
  305. </summary>
  306. </member>
  307. <member name="F:Spire.PdfViewer.Forms.PdfDocumentTextStyle.Regular">
  308. <summary>
  309. Regular text style.
  310. </summary>
  311. </member>
  312. <member name="F:Spire.PdfViewer.Forms.PdfDocumentTextStyle.Bold">
  313. <summary>
  314. Bold text style.
  315. </summary>
  316. </member>
  317. <member name="F:Spire.PdfViewer.Forms.PdfDocumentTextStyle.Italic">
  318. <summary>
  319. Italic text style.
  320. </summary>
  321. </member>
  322. <member name="F:Spire.PdfViewer.Drawing.PdfDocumentLoader.s_instance">
  323. <summary>
  324. static Object
  325. </summary>
  326. </member>
  327. <member name="M:Spire.PdfViewer.Drawing.PdfDocumentLoader.Load(System.IO.Stream)">
  328. <summary>
  329. Load from Stream
  330. </summary>
  331. <param name="stream"></param>
  332. <returns></returns>
  333. </member>
  334. <member name="M:Spire.PdfViewer.Drawing.PdfDocumentLoader.Load(System.String)">
  335. <summary>
  336. Load from file
  337. </summary>
  338. <param name="filePath"></param>
  339. <returns></returns>
  340. </member>
  341. <member name="P:Spire.PdfViewer.Drawing.PdfDocumentLoader.Instance">
  342. <summary>
  343. Get Instance
  344. </summary>
  345. </member>
  346. <member name="T:Spire.PdfViewer.DocumentOpenedEventHandler">
  347. <summary>
  348. Provides document opened events
  349. </summary>
  350. <param name="sender"></param>
  351. <param name="args"></param>
  352. </member>
  353. <member name="T:Spire.PdfViewer.DocumentClosedEventHandler">
  354. <summary>
  355. Provides document closed events
  356. </summary>
  357. <param name="sender"></param>
  358. <param name="args"></param>
  359. </member>
  360. <member name="T:Spire.PdfViewer.PageNumberChangedEventHandler">
  361. <summary>
  362. Provides page number changed events.
  363. </summary>
  364. <param name="sender"></param>
  365. <param name="args"></param>
  366. </member>
  367. <member name="T:Spire.PdfViewer.ZoomChangedEventHandler">
  368. <summary>
  369. Provides zoom changed events
  370. </summary>
  371. <param name="sender"></param>
  372. <param name="zoomFactor"></param>
  373. </member>
  374. <member name="T:Spire.PdfViewer.Forms.PdfDocumentAttachmentAnnotation">
  375. <summary>
  376. PDF document attachment annotation
  377. </summary>
  378. </member>
  379. <member name="M:Spire.PdfViewer.Forms.PdfDocumentAttachmentAnnotation.SaveAs(System.String)">
  380. <summary>
  381. Exported attachment annotaion data to file
  382. </summary>
  383. <param name="filePath"></param>
  384. </member>
  385. <member name="P:Spire.PdfViewer.Forms.PdfDocumentAttachmentAnnotation.FileName">
  386. <summary>
  387. Attachment file name
  388. </summary>
  389. </member>
  390. <member name="P:Spire.PdfViewer.Forms.PdfDocumentAttachmentAnnotation.Text">
  391. <summary>
  392. Attachment annotation Text
  393. </summary>
  394. </member>
  395. <member name="P:Spire.PdfViewer.Forms.PdfDocumentAttachmentAnnotation.PageIndex">
  396. <summary>
  397. Attachment annotation page index
  398. </summary>
  399. </member>
  400. <member name="P:Spire.PdfViewer.Forms.PdfDocumentAttachmentAnnotation.Location">
  401. <summary>
  402. Attachment annotaion location in page
  403. </summary>
  404. </member>
  405. <member name="P:Spire.PdfViewer.Forms.PdfDocumentAttachmentAnnotation.Color">
  406. <summary>
  407. Attachment annotation text color
  408. </summary>
  409. </member>
  410. <member name="P:Spire.PdfViewer.Forms.PdfDocumentAttachmentAnnotation.Icon">
  411. <summary>
  412. Attachment annotation icon
  413. </summary>
  414. </member>
  415. <member name="P:Spire.PdfViewer.Forms.PdfDocumentAttachmentAnnotation.Data">
  416. <summary>
  417. Attachment annotaion file data
  418. </summary>
  419. </member>
  420. <member name="T:Spire.PdfViewer.Forms.PdfDocumentBookmarkContainer">
  421. <summary>
  422. Root bookmark of PDF document
  423. </summary>
  424. </member>
  425. <member name="M:Spire.PdfViewer.Forms.PdfDocumentBookmark.Convert(Spire.Pdf.Bookmarks.PdfBookmark,Spire.PdfViewer.Forms.PdfDocumentViewer)">
  426. <summary>
  427. Convert Spire.Pdf.Bookmarks.Pdfbookmark to Spire.PdfViewer.Forms.PdfDocumentBookmark.
  428. </summary>
  429. <param name="bookMark">Spire.Pdf.Bookmarks.Pdfbookmark</param>
  430. <param name="viewer">Pdf document viewer.</param>
  431. <returns>Spire.PdfViewer.Forms.PdfDocumentBookmark.</returns>
  432. </member>
  433. <member name="P:Spire.PdfViewer.Forms.PdfDocumentBookmark.Title">
  434. <summary>
  435. The title of current bookmark.
  436. </summary>
  437. </member>
  438. <member name="P:Spire.PdfViewer.Forms.PdfDocumentBookmark.Style">
  439. <summary>
  440. Bookmark style
  441. </summary>
  442. </member>
  443. <member name="P:Spire.PdfViewer.Forms.PdfDocumentBookmark.Color">
  444. <summary>
  445. The color of bookmark.
  446. </summary>
  447. </member>
  448. <member name="P:Spire.PdfViewer.Forms.PdfDocumentBookmark.Id">
  449. <summary>
  450. Bookmark order.
  451. </summary>
  452. </member>
  453. <member name="P:Spire.PdfViewer.Forms.PdfDocumentBookmark.Destination">
  454. <summary>
  455. Bookmark to go to destination
  456. </summary>
  457. </member>
  458. <member name="P:Spire.PdfViewer.Forms.PdfDocumentBookmark.Previous">
  459. <summary>
  460. Previous sibling bookmark of current bookmark.
  461. </summary>
  462. </member>
  463. <member name="P:Spire.PdfViewer.Forms.PdfDocumentBookmark.Next">
  464. <summary>
  465. Next sibling bookmark of current bookmark.
  466. </summary>
  467. </member>
  468. <member name="P:Spire.PdfViewer.Forms.PdfDocumentBookmark.Children">
  469. <summary>
  470. All children object of current bookmark.
  471. </summary>
  472. </member>
  473. <member name="F:Spire.PdfViewer.Forms.PdfNotificationBar.m_Disposed">
  474. <summary>
  475. whether dispose mehtod has been called.
  476. </summary>
  477. </member>
  478. <member name="M:Spire.PdfViewer.Forms.PdfNotificationBar.Dispose(System.Boolean)">
  479. <summary>
  480. Release resources(managed/unmanaged)
  481. Dispose(bool disposing) executes in two distinct scenarios.
  482. If disposing equals true,
  483. the method has been called directly or indirectly by a user'code.
  484. Managed and unmanaged resources can be disposed.
  485. if disposing equals false,
  486. the method has been called by the runtime from the finalizer and you
  487. should not reference other objects.Only unmanaged resources can be disposed.
  488. </summary>
  489. <param name="disposing"></param>
  490. </member>
  491. <member name="T:Spire.PdfViewer.Forms.PdfViewerMode.PdfViewerMode">
  492. <summary>
  493. PdfDocumentViewer display mode
  494. </summary>
  495. </member>
  496. <member name="M:Spire.PdfViewer.Forms.VirtualizingPagePanel.GetPageIndexesAtPosition(System.Single,System.Single,Spire.PdfViewer.Forms.PageLayoutMode)">
  497. <summary>
  498. Get pages by vertical scrolling position,zoom factor,page layout mode.
  499. </summary>
  500. <param name="vScrollPosition">The vertical scrolling position.</param>
  501. <param name="zoomFactor">The zoom factor.</param>
  502. <param name="pageMode">The page layout mode.</param>
  503. <returns></returns>
  504. </member>
  505. <member name="M:Spire.PdfViewer.Forms.VirtualizingPagePanel.Initialize">
  506. <summary>
  507. Initialize.
  508. </summary>
  509. </member>
  510. <member name="M:Spire.PdfViewer.Forms.VirtualizingPagePanel.Initialize(System.Single)">
  511. <summary>
  512. Initialize.
  513. </summary>
  514. <param name="zoomFactor">The zoom factor.</param>
  515. </member>
  516. <member name="M:Spire.PdfViewer.Forms.VirtualizingPagePanel.AdjustPageBoundes(Spire.PdfViewer.Forms.PageLayoutMode,System.Single)">
  517. <summary>
  518. Adjust page bounds when switch page layout mode.
  519. </summary>
  520. <param name="pageMode">The page layout mode.</param>
  521. <param name="zoomFactor">The zoom factor.</param>
  522. </member>
  523. <member name="P:Spire.PdfViewer.Forms.VirtualizingPagePanel.FindText">
  524. <summary>
  525. Set find text
  526. </summary>
  527. </member>
  528. <member name="P:Spire.PdfViewer.Forms.VirtualizingPagePanel.FindTextHighLightColor">
  529. <summary>
  530. find text color
  531. </summary>
  532. </member>
  533. <member name="F:Spire.PdfViewer.Forms.PdfDocumentViewer.m_EastAsianFont">
  534. <summary>
  535. Gets or Sets a bool value . This value represents very supportive of East Asian text
  536. </summary>
  537. </member>
  538. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.SaveToFile(System.String)">
  539. <summary>
  540. Save PDF documetns
  541. </summary>
  542. <param name="filePath"></param>
  543. </member>
  544. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.SaveToFile(System.IO.Stream)">
  545. <summary>
  546. Pdf document to save the file stream.
  547. </summary>
  548. <param name="stream"></param>
  549. </member>
  550. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.SaveAsImage(System.Int32)">
  551. <summary>
  552. Saves PDF document page as image
  553. </summary>
  554. <param name="pageIndex">Page with page index to save as image</param>
  555. <returns>Returns page as BitmapSource</returns>
  556. </member>
  557. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.SaveAsImage(System.Int32,System.Boolean)">
  558. <summary>
  559. Saves PDF document page as image
  560. The method is Expired,After using the PDF method,(PdfViewer-195)
  561. </summary>
  562. <param name="pageIndex"></param>
  563. <param name="isAddWarning"></param>
  564. <returns></returns>
  565. </member>
  566. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.SaveAsMetaImage(System.IO.Stream,System.Int32)">
  567. <summary>
  568. Saves PDF document page as image
  569. </summary>
  570. <param name="pageIndex">Page with page index to save as image</param>
  571. <returns>Returns page as BitmapSource</returns>
  572. </member>
  573. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.SaveAsThumbnail(System.Int32,System.Int32,System.Int32)">
  574. <summary>
  575. Gets thumbnail range of PDF document.
  576. </summary>
  577. <param name="pageIndex"></param>
  578. <param name="width"></param>
  579. <param name="height"></param>
  580. <returns></returns>
  581. </member>
  582. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.SaveAsImage(System.Int32,System.Int32)">
  583. <summary>
  584. Saves PDF document page as Image
  585. </summary>
  586. <param name="pageIndex">PDF document page index</param>
  587. <returns>Returns page as BitmapSource</returns>
  588. </member>
  589. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.GoToFirstPage">
  590. <summary>
  591. Go to first page.
  592. </summary>
  593. </member>
  594. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.GoToLastPage">
  595. <summary>
  596. Go to last page.
  597. </summary>
  598. </member>
  599. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.GoToNextPage">
  600. <summary>
  601. Go to next page.
  602. </summary>
  603. </member>
  604. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.GoToPage(System.Int32)">
  605. <summary>
  606. Jump to specified page
  607. </summary>
  608. <param name="index"> Destination page number</param>
  609. </member>
  610. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.GoToPageNumber(System.Int32)">
  611. <summary>
  612. Go to page in multi-page mode.
  613. </summary>
  614. <param name="pageNumber">The page number.</param>
  615. </member>
  616. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.GoToPageIndex(System.Int32)">
  617. <summary>
  618. Go to page in single page mode.
  619. </summary>
  620. <param name="index">The page index.</param>
  621. </member>
  622. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.GoToPreviousPage">
  623. <summary>
  624. </summary>
  625. </member>
  626. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.PrintDoc">
  627. <summary>
  628. Print document.
  629. </summary>
  630. </member>
  631. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.PrintDialog">
  632. <summary>
  633. Display a print dialog box
  634. </summary>
  635. </member>
  636. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.Print">
  637. <summary>
  638. Print PDF document
  639. </summary>
  640. </member>
  641. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.Print(System.Int32,System.Int32)">
  642. <summary>
  643. Print PDF document page rangek
  644. </summary>
  645. <param name="startPageIndex"></param>
  646. <param name="endPageIndex"></param>
  647. </member>
  648. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.Preview">
  649. <summary>
  650. Print Prievew
  651. </summary>
  652. </member>
  653. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.SearchText(System.String,System.Drawing.Color)">
  654. <summary>
  655. Set search text,highlight colors
  656. </summary>
  657. <param name="searchText">search text</param>
  658. <param name="hightColor">highlightColor colors</param>
  659. </member>
  660. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.SearchText(System.String,System.Drawing.Color,System.Boolean)">
  661. <summary>
  662. Set search text,highlight colors
  663. </summary>
  664. <param name="searchText">search text</param>
  665. <param name="hightColor">highlightColor colors</param>
  666. <param name="ignoreCase">bool ignoreCase</param>
  667. </member>
  668. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.LoadFromStream(System.IO.Stream)">
  669. <summary>
  670. Load PDF document from stream.
  671. </summary>
  672. <param name="stream">Data stream</param>
  673. </member>
  674. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.LoadFromFile(System.String)">
  675. <summary>
  676. Load PDF document from file.
  677. </summary>
  678. <param name="filePath">File path</param>
  679. </member>
  680. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.LoadFromFile(System.String,System.String)">
  681. <summary>
  682. </summary>
  683. <param name="filePath">File path</param>
  684. <param name="password">File password</param>
  685. </member>
  686. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.m_singlePagePanel_Paint(System.Object,System.Windows.Forms.PaintEventArgs)">
  687. <summary>
  688. Paint page in single page display mode.
  689. </summary>
  690. <param name="sender">The source of the event.</param>
  691. <param name="e">A PaintEventArgs that contains the event data.</param>
  692. </member>
  693. <!-- Badly formed XML comment ignored for member "M:Spire.PdfViewer.Forms.PdfDocumentViewer.m_multiPagePanel_Paint(System.Object,System.Windows.Forms.PaintEventArgs)" -->
  694. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.CloseDocument">
  695. <summary>
  696. Close current pdf document.
  697. </summary>
  698. </member>
  699. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.UpdatePageIndex">
  700. <summary>
  701. Update the current page index.
  702. </summary>
  703. </member>
  704. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.ZoomTo(Spire.PdfViewer.Forms.ZoomMode)">
  705. <summary>
  706. Zoom PDF document
  707. </summary>
  708. <param name="percentage">Zoom Mode</param>
  709. </member>
  710. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.ZoomTo(System.Int32)">
  711. <summary>
  712. Zoom PDF document
  713. </summary>
  714. <param name="percentage">Zoom percentage</param>
  715. </member>
  716. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.GetBookmarkContainer">
  717. <summary>
  718. Get PDF document bookmark container
  719. </summary>
  720. <returns> PDF document root bookmark</returns>
  721. </member>
  722. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.GoToBookmark(Spire.PdfViewer.Forms.PdfDocumentBookmark)">
  723. <summary>
  724. Go to specified bookmark
  725. </summary>
  726. <param name="bookmark">PDF document bookmark</param>
  727. </member>
  728. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.GetAttachments">
  729. <summary>
  730. Get PDF document all of attachments
  731. </summary>
  732. <returns>PDF document all of attachments</returns>
  733. </member>
  734. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.GetAttachmentAnnotaions">
  735. <summary>
  736. Get PDF document all of attachment annotations
  737. </summary>
  738. <returns>PDF document all of attachment annotations</returns>
  739. </member>
  740. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.GotoAttachmentAnnotation(Spire.PdfViewer.Forms.PdfDocumentAttachmentAnnotation)">
  741. <summary>
  742. Go to PDF document attachment annotation
  743. </summary>
  744. <param name="annotation">PDF document attachment annotation </param>
  745. </member>
  746. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.ExtractText(System.Int32)">
  747. <summary>
  748. Extract text from specific PDF pages.
  749. </summary>
  750. <param name="pageIndex">The page index.</param>
  751. <returns>The texts in pages.</returns>
  752. </member>
  753. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.ExtractImages(System.Int32)">
  754. <summary>
  755. Extract images from specific PDF page.
  756. </summary>
  757. <param name="pageIndex">The page index.</param>
  758. <returns>The images in pages.</returns>
  759. </member>
  760. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.ExtractImages(System.Int32,System.Boolean)">
  761. <summary>
  762. Extract images from specific PDF page,and adjust souce image rotatation.
  763. </summary>
  764. <param name="pageIndex">The page index.</param>
  765. <param name="isAdjustImageRotate"></param>
  766. <returns>The images in pages.</returns>
  767. </member>
  768. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.ExtractText(System.Int32,System.Int32)">
  769. <summary>
  770. Extract text from specific PDF pages.
  771. </summary>
  772. <param name="startPageIndex">The start page index.</param>
  773. <param name="endPageIndex">The end page index.</param>
  774. <returns>The texts in pages.</returns>
  775. </member>
  776. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.ExtractImages(System.Int32,System.Int32)">
  777. <summary>
  778. Extract images from specific PDF pages.
  779. </summary>
  780. <param name="startPageIndex">The start page index.</param>
  781. <param name="endPageIndex">The end page index.</param>
  782. <returns>The images in pages.</returns>
  783. </member>
  784. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.Rotate(Spire.PdfViewer.Forms.RotateAngle)">
  785. <summary>
  786. Rotate PDF document
  787. </summary>
  788. <param name="angle">Rotate angle</param>
  789. </member>
  790. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.GetDocumentInfomation">
  791. <summary>
  792. Get PDF document information
  793. </summary>
  794. <returns></returns>
  795. </member>
  796. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.LoadFromHtml(System.String,System.String,System.Boolean,System.Boolean,System.Boolean)">
  797. <summary>
  798. Load web page as PDF document.
  799. </summary>
  800. <param name="inputUrl"></param>
  801. <param name="convertPdfName"></param>
  802. <param name="enableJavascript"></param>
  803. <param name="enableHyperLink"></param>
  804. <param name="autoDetectePageBreak"></param>
  805. </member>
  806. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.LoadFromHtml(System.String,System.String)">
  807. <summary>
  808. Load web page as PDF document
  809. </summary>
  810. <param name="inputUrl">Html file path</param>
  811. <param name="convertPdfName">Converted PDF document file path</param>
  812. </member>
  813. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.VeryfyDocumentEncrypted(System.String)">
  814. <summary>
  815. Veryfy PDF doument whether to encrypt
  816. </summary>
  817. <param name="PdfDocument">PDF document file path</param>
  818. <returns></returns>
  819. </member>
  820. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.SetViewerMode(Spire.PdfViewer.Forms.PdfViewerMode.PdfViewerMode)">
  821. <summary>
  822. Set PdfDocumentViewer display mode
  823. </summary>
  824. <param name="mode">Display mode</param>
  825. </member>
  826. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.SetPageLayoutMode(Spire.PdfViewer.Forms.PageLayoutMode)">
  827. <summary>
  828. Set PDF document page display mode
  829. </summary>
  830. <param name="pageMode">Page display mode</param>
  831. </member>
  832. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.GetThumbnailControl">
  833. <summary>
  834. Get thumbnail control
  835. </summary>
  836. <returns></returns>
  837. </member>
  838. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.Rotate(Spire.PdfViewer.Forms.RotateAngle,System.Int32,System.Int32)">
  839. <summary>
  840. Rotate the specified range pages.
  841. </summary>
  842. <param name="angle">Rotate angle</param>
  843. <param name="startPageIndex">The start page index.</param>
  844. <param name="endPageIndex">The end page index.</param>
  845. </member>
  846. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.EnableHandTool">
  847. <summary>
  848. Enable hand tool ,then mouse cursor become hand shape and can drag PDF document
  849. </summary>
  850. </member>
  851. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.EscapeHandTool">
  852. <summary>
  853. Escapae hand tool ,mouse cursor recover default shape
  854. </summary>
  855. </member>
  856. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.OnClick(System.EventArgs)">
  857. <summary>
  858. Raises the Click event.
  859. </summary>
  860. <param name="e">A EventArgs that contains the event data.</param>
  861. </member>
  862. <member name="F:Spire.PdfViewer.Forms.PdfDocumentViewer.m_Disposed">
  863. <summary>
  864. whether dispose mehtod has been called.
  865. </summary>
  866. </member>
  867. <member name="M:Spire.PdfViewer.Forms.PdfDocumentViewer.Dispose(System.Boolean)">
  868. <summary>
  869. Release resources(managed/unmanaged)
  870. Dispose(bool disposing) executes in two distinct scenarios.
  871. If disposing equals true,
  872. the method has been called directly or indirectly by a user'code.
  873. Managed and unmanaged resources can be disposed.
  874. if disposing equals false,
  875. the method has been called by the runtime from the finalizer and you
  876. should not reference other objects.Only unmanaged resources can be disposed.
  877. </summary>
  878. <param name="disposing"> </param>
  879. </member>
  880. <member name="P:Spire.PdfViewer.Forms.PdfDocumentViewer.IgnoreCase">
  881. <summary>
  882. find text ignorecase
  883. </summary>
  884. </member>
  885. <member name="P:Spire.PdfViewer.Forms.PdfDocumentViewer.FindTextHighLightColor">
  886. <summary>
  887. find text color
  888. </summary>
  889. </member>
  890. <member name="P:Spire.PdfViewer.Forms.PdfDocumentViewer.IsClickJump">
  891. <summary>
  892. When viewer mode is single page mode,Gets or sets whether to jump to page after click PDF document
  893. </summary>
  894. </member>
  895. <member name="P:Spire.PdfViewer.Forms.PdfDocumentViewer.FindText">
  896. <summary>
  897. Set find text
  898. </summary>
  899. </member>
  900. <member name="P:Spire.PdfViewer.Forms.PdfDocumentViewer.EastAsianFont">
  901. <summary>
  902. Gets or Sets a bool value . This value represents very supportive of East Asian text
  903. </summary>
  904. </member>
  905. <member name="P:Spire.PdfViewer.Forms.PdfDocumentViewer.IsDocumentLoaded">
  906. <summary>
  907. Veryfy whether to PDF document loaded
  908. </summary>
  909. </member>
  910. <member name="E:Spire.PdfViewer.Forms.PdfDocumentViewer.PdfLoaded">
  911. <summary>
  912. </summary>
  913. </member>
  914. <member name="E:Spire.PdfViewer.Forms.PdfDocumentViewer.ZoomChanged">
  915. <summary>
  916. Occurs zoom changed.
  917. </summary>
  918. </member>
  919. <member name="P:Spire.PdfViewer.Forms.PdfDocumentViewer.CurrentPageNumber">
  920. <summary>
  921. Gets current display page number
  922. </summary>
  923. </member>
  924. <member name="P:Spire.PdfViewer.Forms.PdfDocumentViewer.PageCount">
  925. <summary>
  926. Get PDF document total page count
  927. </summary>
  928. </member>
  929. <member name="P:Spire.PdfViewer.Forms.PdfDocumentViewer.FileName">
  930. <summary>
  931. Get PDF document file name.
  932. </summary>
  933. </member>
  934. <member name="P:Spire.PdfViewer.Forms.PdfDocumentViewer.PrintSettings">
  935. <summary>
  936. Get the print settings.
  937. </summary>
  938. </member>
  939. <member name="P:Spire.PdfViewer.Forms.PdfDocumentViewer.ZoomMode">
  940. <summary>
  941. Gets or sets the zoom mode.
  942. </summary>
  943. </member>
  944. <member name="T:Spire.PdfViewer.Forms.Properties.Resources">
  945. <summary>
  946. A strongly-typed resource class, for looking up localized strings, etc.
  947. </summary>
  948. </member>
  949. <member name="P:Spire.PdfViewer.Forms.Properties.Resources.ResourceManager">
  950. <summary>
  951. Returns the cached ResourceManager instance used by this class.
  952. </summary>
  953. </member>
  954. <member name="P:Spire.PdfViewer.Forms.Properties.Resources.Culture">
  955. <summary>
  956. Overrides the current thread's CurrentUICulture property for all
  957. resource lookups using this strongly typed resource class.
  958. </summary>
  959. </member>
  960. <member name="T:Spire.PdfViewer.Forms.PdfDocumentAttachment">
  961. <summary>
  962. PDF document attachment
  963. </summary>
  964. </member>
  965. <member name="M:Spire.PdfViewer.Forms.PdfDocumentAttachment.SaveAS(System.String)">
  966. <summary>
  967. Exported attachment data to file
  968. </summary>
  969. <param name="filePath"></param>
  970. </member>
  971. <member name="P:Spire.PdfViewer.Forms.PdfDocumentAttachment.FileName">
  972. <summary>
  973. Attachment file name
  974. </summary>
  975. </member>
  976. <member name="P:Spire.PdfViewer.Forms.PdfDocumentAttachment.Description">
  977. <summary>
  978. Attachment description
  979. </summary>
  980. </member>
  981. <member name="P:Spire.PdfViewer.Forms.PdfDocumentAttachment.MimeType">
  982. <summary>
  983. Attachment mime type
  984. </summary>
  985. </member>
  986. <member name="P:Spire.PdfViewer.Forms.PdfDocumentAttachment.CreationTime">
  987. <summary>
  988. Attachment creat time
  989. </summary>
  990. </member>
  991. <member name="P:Spire.PdfViewer.Forms.PdfDocumentAttachment.ModifyTime">
  992. <summary>
  993. Attachment modify time
  994. </summary>
  995. </member>
  996. <member name="P:Spire.PdfViewer.Forms.PdfDocumentAttachment.Data">
  997. <summary>
  998. Attachment file data
  999. </summary>
  1000. </member>
  1001. <member name="T:Spire.PdfViewer.Forms.PdfDocumentInfo">
  1002. <summary>
  1003. PDF document basic information
  1004. </summary>
  1005. </member>
  1006. <member name="P:Spire.PdfViewer.Forms.PdfDocumentInfo.Title">
  1007. <summary>
  1008. PDF document title
  1009. </summary>
  1010. </member>
  1011. <member name="P:Spire.PdfViewer.Forms.PdfDocumentInfo.Author">
  1012. <summary>
  1013. PDF document author
  1014. </summary>
  1015. </member>
  1016. <member name="P:Spire.PdfViewer.Forms.PdfDocumentInfo.Creator">
  1017. <summary>
  1018. PDF document creator
  1019. </summary>
  1020. </member>
  1021. <member name="P:Spire.PdfViewer.Forms.PdfDocumentInfo.Producer">
  1022. <summary>
  1023. PDF document producer
  1024. </summary>
  1025. </member>
  1026. <member name="P:Spire.PdfViewer.Forms.PdfDocumentInfo.Keywords">
  1027. <summary>
  1028. PDF document keywords
  1029. </summary>
  1030. </member>
  1031. <member name="P:Spire.PdfViewer.Forms.PdfDocumentInfo.Subject">
  1032. <summary>
  1033. PDF document subject
  1034. </summary>
  1035. </member>
  1036. <member name="P:Spire.PdfViewer.Forms.PdfDocumentInfo.CreationDate">
  1037. <summary>
  1038. PDF document create date
  1039. </summary>
  1040. </member>
  1041. <member name="P:Spire.PdfViewer.Forms.PdfDocumentInfo.ModificationDate">
  1042. <summary>
  1043. PDF document modification date
  1044. </summary>
  1045. </member>
  1046. <member name="T:Spire.PdfViewer.Forms.PageLayoutMode">
  1047. <summary>
  1048. PdfDocumentViewer Page display mode
  1049. </summary>
  1050. </member>
  1051. <member name="T:Spire.PdfViewer.Forms.PasswordDlg">
  1052. <summary>
  1053. Summary description for password.
  1054. </summary>
  1055. </member>
  1056. <member name="F:Spire.PdfViewer.Forms.PasswordDlg.components">
  1057. <summary>
  1058. Required designer variable.
  1059. </summary>
  1060. </member>
  1061. <member name="M:Spire.PdfViewer.Forms.PasswordDlg.InitializeComponent">
  1062. <summary>
  1063. Required method for Designer support - do not modify
  1064. the contents of this method with the code editor.
  1065. </summary>
  1066. </member>
  1067. <member name="M:Spire.PdfViewer.Forms.PasswordDlg.Dispose(System.Boolean)">
  1068. <summary>
  1069. Clean up any resources being used.
  1070. </summary>
  1071. </member>
  1072. <member name="T:Spire.PdfViewer.Forms.PdfPagePonit">
  1073. <summary>
  1074. location of PDF document bookmark
  1075. </summary>
  1076. </member>
  1077. </members>
  1078. </doc>