暫無描述
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.

PdfSharp.Quality.xml 43KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>PdfSharp.Quality</name>
  5. </assembly>
  6. <members>
  7. <member name="T:PdfSharp.Quality.AssetsHelper">
  8. <summary>
  9. Static helper functions for fonts.
  10. </summary>
  11. </member>
  12. <member name="M:PdfSharp.Quality.AssetsHelper.GetAssetsFolder(System.String)">
  13. <summary>
  14. Gets the assets folder or null, if no such folder exists.
  15. </summary>
  16. <param name="path">The path or null, if the function should use the current folder.</param>
  17. </member>
  18. <member name="M:PdfSharp.Quality.AssetsHelper.EnsureAssets(System.String)">
  19. <summary>
  20. Checks whether the assets folder exists and throws an exception if not.
  21. </summary>
  22. <param name="path">The path or null, if the function should use the current folder.</param>
  23. </member>
  24. <member name="T:PdfSharp.Quality.DefaultFontResolver_unused">
  25. <summary>
  26. </summary>
  27. <seealso cref="T:PdfSharp.Fonts.IFontResolver" />
  28. </member>
  29. <member name="M:PdfSharp.Quality.DefaultFontResolver_unused.ResolveTypeface(System.String,System.Boolean,System.Boolean)">
  30. <summary>
  31. Converts specified information about a required typeface into a specific font.
  32. </summary>
  33. <param name="familyName">Name of the font family.</param>
  34. <param name="isBold">Set to <c>true</c> when a bold font face is required.</param>
  35. <param name="isItalic">Set to <c>true</c> when an italic font face is required.</param>
  36. <returns>
  37. Information about the physical font, or null if the request cannot be satisfied.
  38. </returns>
  39. </member>
  40. <member name="M:PdfSharp.Quality.DefaultFontResolver_unused.GetFont(System.String)">
  41. <summary>
  42. Gets the bytes of a physical font with specified face name.
  43. </summary>
  44. <param name="faceName">A face name previously retrieved by ResolveTypeface.</param>
  45. </member>
  46. <member name="T:PdfSharp.Quality.Feature">
  47. <summary>
  48. Base class for features.
  49. </summary>
  50. </member>
  51. <member name="M:PdfSharp.Quality.Feature.RenderSnippetAsPdf(PdfSharp.Quality.Snippet)">
  52. <summary>
  53. Renders a code snippet to PDF.
  54. </summary>
  55. <param name="snippet">A code snippet.</param>
  56. </member>
  57. <member name="M:PdfSharp.Quality.Feature.RenderSnippetAsPdf(PdfSharp.Quality.Snippet,PdfSharp.Drawing.XUnit,PdfSharp.Drawing.XUnit,PdfSharp.Drawing.XGraphicsUnit,PdfSharp.Drawing.XPageDirection)">
  58. <summary>
  59. Renders a code snippet to PDF.
  60. </summary>
  61. <param name="snippet"></param>
  62. <param name="width"></param>
  63. <param name="height"></param>
  64. <param name="graphicsUnit"></param>
  65. <param name="pageDirection"></param>
  66. </member>
  67. <member name="M:PdfSharp.Quality.Feature.RenderAllSnippets">
  68. <summary>
  69. Renders all code snippets to PDF.
  70. </summary>
  71. </member>
  72. <member name="M:PdfSharp.Quality.Feature.CreateNewPdfDocument">
  73. <summary>
  74. Creates a PDF test document.
  75. </summary>
  76. </member>
  77. <member name="M:PdfSharp.Quality.Feature.SaveToStreamOrSaveToFile(PdfSharp.Pdf.PdfDocument,System.IO.Stream,System.String,System.Boolean)">
  78. <summary>
  79. Saves a PDF document to stream or save to file.
  80. </summary>
  81. <param name="document">The document.</param>
  82. <param name="stream">The stream.</param>
  83. <param name="filenameTag">The filename tag.</param>
  84. <param name="show">if set to <c>true</c> [show].</param>
  85. </member>
  86. <member name="M:PdfSharp.Quality.Feature.SaveAndShowDocument(PdfSharp.Pdf.PdfDocument,System.String)">
  87. <summary>
  88. Saves a PDF document and show it document.
  89. </summary>
  90. <param name="document">The document.</param>
  91. <param name="filenameTag">The filename tag.</param>
  92. </member>
  93. <member name="M:PdfSharp.Quality.Feature.SaveDocument(PdfSharp.Pdf.PdfDocument,System.String)">
  94. <summary>
  95. Saves a PDF document into a file.
  96. </summary>
  97. <param name="document">The PDF document.</param>
  98. <param name="filenameTag">The tag of the PDF file.</param>
  99. </member>
  100. <member name="M:PdfSharp.Quality.Feature.ReadWritePdfDocument(System.String,PdfSharp.Pdf.IO.PdfPasswordProvider)">
  101. <summary>
  102. Reads and writes a PDF document.
  103. </summary>
  104. <param name="filename">The PDF file to read.</param>
  105. <param name="passwordProvider">The password provider if the file is protected.</param>
  106. </member>
  107. <member name="T:PdfSharp.Quality.FeatureAndSnippetBase">
  108. <summary>
  109. Base class with common code for both features and snippets.
  110. </summary>
  111. </member>
  112. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.#ctor">
  113. <summary>
  114. Initializes a new instance of the <see cref="T:PdfSharp.Quality.FeatureAndSnippetBase"/> class.
  115. </summary>
  116. </member>
  117. <member name="T:PdfSharp.Quality.FeatureAndSnippetBase.BoxOptions">
  118. <summary>
  119. Specifies how to draw a box on the PDF page.
  120. </summary>
  121. </member>
  122. <member name="F:PdfSharp.Quality.FeatureAndSnippetBase.BoxOptions.None">
  123. <summary>
  124. Draw no box.
  125. </summary>
  126. </member>
  127. <member name="F:PdfSharp.Quality.FeatureAndSnippetBase.BoxOptions.Box">
  128. <summary>
  129. Draw a box.
  130. </summary>
  131. </member>
  132. <member name="F:PdfSharp.Quality.FeatureAndSnippetBase.BoxOptions.DrawX">
  133. <summary>
  134. Draw
  135. </summary>
  136. </member>
  137. <member name="F:PdfSharp.Quality.FeatureAndSnippetBase.BoxOptions.Fill">
  138. <summary>
  139. Draw
  140. </summary>
  141. </member>
  142. <member name="F:PdfSharp.Quality.FeatureAndSnippetBase.BoxOptions.Tile">
  143. <summary>
  144. Draw
  145. </summary>
  146. </member>
  147. <member name="F:PdfSharp.Quality.FeatureAndSnippetBase.WidthInPoint">
  148. <summary>
  149. The width of the PDF page in point.
  150. </summary>
  151. </member>
  152. <member name="F:PdfSharp.Quality.FeatureAndSnippetBase.HeightInPoint">
  153. <summary>
  154. The height of the PDF page in point.
  155. </summary>
  156. </member>
  157. <member name="F:PdfSharp.Quality.FeatureAndSnippetBase.WidthInMillimeter">
  158. <summary>
  159. The width of the PDF page in millimeter.
  160. </summary>
  161. </member>
  162. <member name="F:PdfSharp.Quality.FeatureAndSnippetBase.HeightInMillimeter">
  163. <summary>
  164. The height of the PDF page in millimeter.
  165. </summary>
  166. </member>
  167. <member name="F:PdfSharp.Quality.FeatureAndSnippetBase.WidthInPU">
  168. <summary>
  169. The width of the PDF page in presentation units.
  170. </summary>
  171. </member>
  172. <member name="F:PdfSharp.Quality.FeatureAndSnippetBase.HeightInPU">
  173. <summary>
  174. The width of the PDF page in presentation units.
  175. </summary>
  176. </member>
  177. <member name="F:PdfSharp.Quality.FeatureAndSnippetBase.BoxWidth">
  178. <summary>
  179. The width of the drawing box in presentation units.
  180. </summary>
  181. </member>
  182. <member name="F:PdfSharp.Quality.FeatureAndSnippetBase.BoxHeight">
  183. <summary>
  184. The height of the drawing box in presentation units.
  185. </summary>
  186. </member>
  187. <member name="P:PdfSharp.Quality.FeatureAndSnippetBase.BoxCenter">
  188. <summary>
  189. The center of the box.
  190. </summary>
  191. </member>
  192. <member name="P:PdfSharp.Quality.FeatureAndSnippetBase.Gray">
  193. <summary>
  194. Gets the gray background brush for boxes.
  195. </summary>
  196. </member>
  197. <member name="P:PdfSharp.Quality.FeatureAndSnippetBase.PdfSharpTechnology">
  198. <summary>
  199. Gets a tag that specifies the PDFsharp build technology.
  200. It is either 'core', 'gdi', or 'wpf'.
  201. </summary>
  202. </member>
  203. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.BeginPdfDocument">
  204. <summary>
  205. Creates a new PDF document.
  206. </summary>
  207. </member>
  208. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.EndPdfDocument">
  209. <summary>
  210. Ends access to the current PDF document and renders it to a memory stream.
  211. </summary>
  212. </member>
  213. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.BeginPdfPage">
  214. <summary>
  215. Creates a new page in the current PDF document.
  216. </summary>
  217. </member>
  218. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.BeginPdfPage(PdfSharp.Drawing.XUnit,PdfSharp.Drawing.XUnit,PdfSharp.Drawing.XGraphicsUnit,PdfSharp.Drawing.XPageDirection)">
  219. <summary>
  220. Creates a new page in the current PDF document.
  221. </summary>
  222. </member>
  223. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.EndPdfPage">
  224. <summary>
  225. Ends the current PDF page.
  226. </summary>
  227. </member>
  228. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.GenerateParallelComparisonDocument">
  229. <summary>
  230. Generates a PDF document for parallel comparison of two render results.
  231. </summary>
  232. </member>
  233. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.GenerateSerialComparisonDocument">
  234. <summary>
  235. Generates the serial comparison document. DOCTODO
  236. </summary>
  237. </member>
  238. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.SaveAndShowFile(System.Byte[],System.String,System.Boolean)">
  239. <summary>
  240. Saves the bytes to PDF file and show file.
  241. </summary>
  242. <param name="sourceBytes">The source bytes.</param>
  243. <param name="filepath">The filepath.</param>
  244. <param name="startViewer">if set to <c>true</c> [start viewer].</param>
  245. <returns></returns>
  246. <exception cref="T:System.ArgumentNullException">sourceBytes</exception>
  247. </member>
  248. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.SaveAndShowPdfDocument(System.String,System.Boolean)">
  249. <summary>
  250. Saves and optionally shows a PDF document.
  251. </summary>
  252. <param name="filepath">The filepath.</param>
  253. <param name="startViewer">if set to <c>true</c> [start viewer].</param>
  254. </member>
  255. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.SaveAndShowPngImage(System.String,System.Boolean)">
  256. <summary>
  257. Saves and optionally shows a PNG image.
  258. </summary>
  259. <param name="filepath">The filepath.</param>
  260. <param name="startViewer">if set to <c>true</c> [start viewer].</param>
  261. </member>
  262. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.SaveAndShowComparisonDocument(System.String,System.Boolean)">
  263. <summary>
  264. Saves and shows a parallel comparison PDF document.
  265. </summary>
  266. <param name="filepath">The filepath.</param>
  267. <param name="startViewer">if set to <c>true</c> [start viewer].</param>
  268. </member>
  269. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.SaveStreamToFile(System.IO.Stream,System.String)">
  270. <summary>
  271. Saves a stream to a file.
  272. </summary>
  273. <param name="stream">The stream.</param>
  274. <param name="path">The path.</param>
  275. </member>
  276. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.BeginImage">
  277. <summary>
  278. Prepares new bitmap image for drawing.
  279. </summary>
  280. </member>
  281. <member name="M:PdfSharp.Quality.FeatureAndSnippetBase.EndPngImage">
  282. <summary>
  283. Ends the current GDI+ image.
  284. </summary>
  285. </member>
  286. <member name="P:PdfSharp.Quality.FeatureAndSnippetBase.Document">
  287. <summary>
  288. Gets the current PDF document.
  289. </summary>
  290. </member>
  291. <member name="P:PdfSharp.Quality.FeatureAndSnippetBase.Page">
  292. <summary>
  293. Gets the current PDF page.
  294. </summary>
  295. </member>
  296. <member name="P:PdfSharp.Quality.FeatureAndSnippetBase.XGraphics">
  297. <summary>
  298. Gets the current PDFsharp graphics object.
  299. </summary>
  300. </member>
  301. <member name="P:PdfSharp.Quality.FeatureAndSnippetBase.PdfBytes">
  302. <summary>
  303. Gets the bytes of a PDF document.
  304. </summary>
  305. </member>
  306. <member name="P:PdfSharp.Quality.FeatureAndSnippetBase.PngBytes">
  307. <summary>
  308. Gets the bytes of a PNG image.
  309. </summary>
  310. </member>
  311. <member name="P:PdfSharp.Quality.FeatureAndSnippetBase.ComparisonBytes">
  312. <summary>
  313. Gets the bytes of a comparision document.
  314. </summary>
  315. </member>
  316. <member name="T:PdfSharp.Quality.FontHelper">
  317. <summary>
  318. Static helper functions for fonts.
  319. </summary>
  320. </member>
  321. <member name="M:PdfSharp.Quality.FontHelper.LoadFontData(System.String)">
  322. <summary>
  323. Returns the specified font from an embedded resource.
  324. </summary>
  325. </member>
  326. <member name="M:PdfSharp.Quality.FontHelper.LoadFontData(System.String,System.Reflection.Assembly)">
  327. <summary>
  328. Returns the specified font from an embedded resource.
  329. </summary>
  330. </member>
  331. <member name="T:PdfSharp.Quality.FontUtility">
  332. <summary>
  333. Static helper functions for file IO.
  334. </summary>
  335. </member>
  336. <member name="T:PdfSharp.Quality.IOHelper">
  337. <summary>
  338. Static helper functions for file IO.
  339. </summary>
  340. </member>
  341. <member name="T:PdfSharp.Quality.IOUtility">
  342. <summary>
  343. Static utility functions for file IO.
  344. These function are intended for unit test und sample in a solution code only.
  345. </summary>
  346. </member>
  347. <member name="M:PdfSharp.Quality.IOUtility.IsDirectorySeparator(System.Char)">
  348. <summary>
  349. True if the given character is a directory separator.
  350. </summary>
  351. </member>
  352. <member name="M:PdfSharp.Quality.IOUtility.NormalizeDirectorySeparators(System.String@)">
  353. <summary>
  354. Replaces all back-slashes with forward slashes in the specified path.
  355. The resulting path works under Windows and Linux if no drive names are
  356. included.
  357. </summary>
  358. </member>
  359. <member name="M:PdfSharp.Quality.IOUtility.GetSolutionRoot">
  360. <summary>
  361. Gets the root path of the current solution, or null, if no parent
  362. directory with a solution file exists.
  363. </summary>
  364. </member>
  365. <member name="M:PdfSharp.Quality.IOUtility.GetAssetsPath(System.String)">
  366. <summary>
  367. Gets the root path of the current assets directory if no parameter is specified,
  368. or null, if no assets directory exists in the solution root directory.
  369. If a parameter is specified gets the assets root path combined with the specified relative path or file.
  370. If only the root path is returned it always ends with a directory separator.
  371. If a parameter is specified the return value ends literally with value of the parameter.
  372. </summary>
  373. </member>
  374. <member name="M:PdfSharp.Quality.IOUtility.GetTempPath(System.String)">
  375. <summary>
  376. Gets the root or sub path of the current temp directory.
  377. The directory is created if it does not exist.
  378. If a valid path is returned it always ends with the current directory separator.
  379. </summary>
  380. </member>
  381. <member name="M:PdfSharp.Quality.IOUtility.GetViewerWatchDirectory">
  382. <summary>
  383. Gets the viewer watch directory.
  384. Which is currently just a hard-coded directory on drive C or /mnt/c
  385. </summary>
  386. </member>
  387. <member name="M:PdfSharp.Quality.IOUtility.GetTempFileName(System.String,System.String,System.Boolean)">
  388. <summary>
  389. Creates a temporary file name with the pattern '{namePrefix}-{WIN|WSL|LNX|...}-{...uuid...}_temp.{extension}'.
  390. The name ends with '_temp.' to make it easy to delete it using the pattern '*_temp.{extension}'.
  391. No file is created by this function. The name contains 10 hex characters to make it unique.
  392. It is not tested whether the file exists, because we have no path here.
  393. </summary>
  394. </member>
  395. <member name="M:PdfSharp.Quality.IOUtility.GetTempFullFileName(System.String,System.String,System.Boolean)">
  396. <summary>
  397. Creates a temporary file and returns the full name. The name pattern is '/.../temp/.../{namePrefix}-{WIN|WSL|LNX|...}-{...uuid...}_temp.{extension}'.
  398. The namePrefix may contain a sub-path relative to the temp directory.
  399. The name ends with '_temp.' to make it easy to delete it using the pattern '*_temp.{extension}'.
  400. The file is created and immediately closed. That ensures the returned full file name can be used.
  401. </summary>
  402. </member>
  403. <member name="M:PdfSharp.Quality.IOUtility.FindLatestTempFile(System.String,System.String,System.String,System.Boolean)">
  404. <summary>
  405. Finds the latest temporary file in a directory. The pattern of the file is expected
  406. to be '{namePrefix}*_temp.{extension}'.
  407. </summary>
  408. <param name="namePrefix">The prefix of the file name to search for.</param>
  409. <param name="path">The path to search in.</param>
  410. <param name="extension">The file extension of the file.</param>
  411. <param name="recursive">If set to <c>true</c> subdirectories are included in the search.</param>
  412. </member>
  413. <member name="M:PdfSharp.Quality.IOUtility.EnsureAssets(System.String,System.Nullable{System.Int32})">
  414. <summary>
  415. Ensures the assets folder exists in the solution root and an optional specified file
  416. or directory exists. If relativeFileOrDirectory is specified, it is considered to
  417. be a path to a directory if it ends with a directory separator. Otherwise, it is
  418. considered to ba a path to a file.
  419. </summary>
  420. <param name="relativeFileOrDirectory">A relative path to a file or directory.</param>
  421. <param name="requiredAssetsVersion">The minimum of the required assets version.</param>
  422. </member>
  423. <member name="M:PdfSharp.Quality.IOUtility.EnsureAssetsVersion(System.Int32)">
  424. <summary>
  425. Ensures the assets directory exists in the solution root and its version is at least the specified version.
  426. </summary>
  427. <param name="requiredAssetsVersion">The minimum of the required assets version.</param>
  428. </member>
  429. <member name="T:PdfSharp.Quality.PathHelper">
  430. <summary>
  431. Helper class for file paths.
  432. </summary>
  433. </member>
  434. <member name="M:PdfSharp.Quality.PathHelper.FindPath(System.String,System.String)">
  435. <summary>
  436. Builds a path by the following strategy. Get the current directory and find the specified folderName in it.
  437. Then replace the path right of folderName with the specified subPath.
  438. </summary>
  439. <param name="folderName">Name of a parent folder in the path to the current directory.</param>
  440. <param name="subPath">The sub path that substitutes the part right of folderName in the current directory path.</param>
  441. <returns>The new path.</returns>
  442. </member>
  443. <member name="T:PdfSharp.Quality.DocTag">
  444. <summary>
  445. Contains information of a PDF document created for testing purposes.
  446. </summary>
  447. </member>
  448. <member name="P:PdfSharp.Quality.DocTag.Title">
  449. <summary>
  450. Gets or sets the title of the document.
  451. </summary>
  452. <value>
  453. The title.
  454. </value>
  455. </member>
  456. <member name="T:PdfSharp.Quality.PdfDocUtility">
  457. <summary>
  458. Static helper functions for file IO.
  459. </summary>
  460. </member>
  461. <member name="M:PdfSharp.Quality.PdfDocUtility.CreateNewPdfDocument(System.String)">
  462. <summary>
  463. Creates a PDF test document.
  464. </summary>
  465. </member>
  466. <member name="T:PdfSharp.Quality.PdfFileFormatter">
  467. <summary>
  468. Reads a PDF document, unpacks all its streams, and save it under a new name.
  469. </summary>
  470. </member>
  471. <member name="M:PdfSharp.Quality.PdfFileFormatter.FormatDocument(System.String)">
  472. <summary>
  473. Reads a PDF file, formats the content and saves the new document.
  474. </summary>
  475. <param name="path">The path.</param>
  476. </member>
  477. <member name="T:PdfSharp.Quality.PdfFileUtility">
  478. <summary>
  479. Static helper functions for file IO.
  480. These function are intended for unit test und sample in a solution code only.
  481. </summary>
  482. </member>
  483. <member name="M:PdfSharp.Quality.PdfFileUtility.GetTempPdfFileName(System.String,System.Boolean)">
  484. <summary>
  485. Creates a temporary name of a PDF file with the pattern '{namePrefix}-{WIN|WSL|LNX|...}-{...uuid...}_temp.pdf'.
  486. The name ends with '_temp.pdf' to make it easy to delete it using the pattern '*_temp.pdf'.
  487. No file is created by this function. The name contains 10 hex characters to make it unique.
  488. It is not tested whether the file exists, because we have no path here.
  489. </summary>
  490. </member>
  491. <member name="M:PdfSharp.Quality.PdfFileUtility.GetTempPdfFullFileName(System.String,System.Boolean)">
  492. <summary>
  493. Creates a temporary file and returns the full name. The name pattern is '.../temp/.../{namePrefix}-{WIN|WSL|LNX|...}-{...uuid...}_temp.pdf'.
  494. The namePrefix may contain a sub-path relative to the temp directory.
  495. The name ends with '_temp.pdf' to make it easy to delete it using the pattern '*_temp.pdf'.
  496. The file is created and immediately closed. That ensures the returned full file name can be used.
  497. </summary>
  498. </member>
  499. <member name="M:PdfSharp.Quality.PdfFileUtility.FindLatestPdfTempFile(System.String,System.String,System.Boolean)">
  500. <summary>
  501. Finds the latest PDF temporary file in the specified folder, including sub-folders, or null,
  502. if no such file exists.
  503. </summary>
  504. <param name="name">The name.</param>
  505. <param name="path">The path.</param>
  506. <param name="recursive">if set to <c>true</c> [recursive].</param>
  507. </member>
  508. <member name="M:PdfSharp.Quality.PdfFileUtility.SaveDocument(PdfSharp.Pdf.PdfDocument,System.String,System.Boolean)">
  509. <summary>
  510. Save the specified document and returns the path.
  511. </summary>
  512. <param name="doc"></param>
  513. <param name="name"></param>
  514. <param name="addInfo"></param>
  515. </member>
  516. <member name="M:PdfSharp.Quality.PdfFileUtility.SaveAndShowDocument(PdfSharp.Pdf.PdfDocument,System.String,System.Boolean)">
  517. <summary>
  518. Save the specified document and shows it in a PDF viewer application.
  519. </summary>
  520. <param name="doc"></param>
  521. <param name="name"></param>
  522. <param name="addInfo"></param>
  523. </member>
  524. <member name="M:PdfSharp.Quality.PdfFileUtility.SaveAndShowDocumentIfDebugging(PdfSharp.Pdf.PdfDocument,System.String,System.Boolean)">
  525. <summary>
  526. Save the specified document and shows it in a PDF viewer application only if the current program
  527. is debugged.
  528. </summary>
  529. <param name="doc"></param>
  530. <param name="name"></param>
  531. <param name="addInfo"></param>
  532. </member>
  533. <member name="M:PdfSharp.Quality.PdfFileUtility.ShowDocument(System.String)">
  534. <summary>
  535. Shows the specified document in a PDF viewer application.
  536. </summary>
  537. <param name="pdfFilename">The PDF filename.</param>
  538. </member>
  539. <member name="M:PdfSharp.Quality.PdfFileUtility.ShowDocumentIfDebugging(System.String)">
  540. <summary>
  541. Shows the specified document in a PDF viewer application only if the current program
  542. is debugged.
  543. </summary>
  544. <param name="pdfFilename">The PDF filename.</param>
  545. </member>
  546. <member name="T:PdfSharp.Quality.Snippet">
  547. <summary>
  548. Base class of code snippets for testing.
  549. </summary>
  550. </member>
  551. <member name="M:PdfSharp.Quality.Snippet.#ctor">
  552. <summary>
  553. Initializes a new instance of the <see cref="T:PdfSharp.Quality.Snippet"/> class.
  554. </summary>
  555. </member>
  556. <member name="P:PdfSharp.Quality.Snippet.Title">
  557. <summary>
  558. Gets or sets the title of the snipped
  559. </summary>
  560. </member>
  561. <member name="P:PdfSharp.Quality.Snippet.PathName">
  562. <summary>
  563. Gets or sets the path or name where to store the PDF file.
  564. </summary>
  565. </member>
  566. <member name="P:PdfSharp.Quality.Snippet.BoxOption">
  567. <summary>
  568. Gets or sets the box option.
  569. </summary>
  570. </member>
  571. <member name="P:PdfSharp.Quality.Snippet.Cleanroom">
  572. <summary>
  573. Gets or sets a value indicating how this <see cref="T:PdfSharp.Quality.Snippet"/> is drawn.
  574. If it is true, all describing graphics like title and boxes are omitted.
  575. Use this option to produce a clean PDF for debugging purposes.
  576. If it is false, all describing graphics like title and boxes are drawn.
  577. This is the regular case.
  578. </summary>
  579. </member>
  580. <member name="P:PdfSharp.Quality.Snippet.NoGraphic">
  581. <summary>
  582. Gets or sets a value indicating whether all graphics output is omitted.
  583. </summary>
  584. </member>
  585. <member name="P:PdfSharp.Quality.Snippet.NoText">
  586. <summary>
  587. Gets or sets a value indicating whether all text output is omitted.
  588. </summary>
  589. </member>
  590. <member name="P:PdfSharp.Quality.Snippet.FontNameStd">
  591. <summary>
  592. The standard font name used in snippet.
  593. </summary>
  594. </member>
  595. <member name="P:PdfSharp.Quality.Snippet.FontStd">
  596. <summary>
  597. Gets the standard font in snippets.
  598. </summary>
  599. </member>
  600. <member name="P:PdfSharp.Quality.Snippet.FontHeader">
  601. <summary>
  602. Gets the header font in snippets.
  603. </summary>
  604. </member>
  605. <member name="M:PdfSharp.Quality.Snippet.DrawNotSupportedFeature(PdfSharp.Drawing.XGraphics)">
  606. <summary>
  607. Draws a text that states that a feature is not supported in a particular build.
  608. </summary>
  609. </member>
  610. <member name="M:PdfSharp.Quality.Snippet.DrawHeader(PdfSharp.Drawing.XGraphics,System.String)">
  611. <summary>
  612. Draws the header.
  613. </summary>
  614. </member>
  615. <member name="M:PdfSharp.Quality.Snippet.DrawHeader(System.String)">
  616. <summary>
  617. Draws the header.
  618. </summary>
  619. </member>
  620. <member name="M:PdfSharp.Quality.Snippet.DrawPdfHeader">
  621. <summary>
  622. Draws the header for a PDF document.
  623. </summary>
  624. </member>
  625. <member name="M:PdfSharp.Quality.Snippet.DrawPngHeader">
  626. <summary>
  627. Draws the header for a PNG image.
  628. </summary>
  629. </member>
  630. <member name="M:PdfSharp.Quality.Snippet.RenderSnippet(PdfSharp.Drawing.XGraphics)">
  631. <summary>
  632. When implemented in a derived class renders the snippet in the specified XGraphic object.
  633. </summary>
  634. <param name="gfx">The XGraphics where to render the snippet.</param>
  635. </member>
  636. <member name="M:PdfSharp.Quality.Snippet.RenderSnippet">
  637. <summary>
  638. When implemented in a derived class renders the snippet in an XGraphic object.
  639. </summary>
  640. </member>
  641. <member name="M:PdfSharp.Quality.Snippet.RenderSnippetAsPdf">
  642. <summary>
  643. Renders a snippet as PDF document.
  644. </summary>
  645. </member>
  646. <member name="M:PdfSharp.Quality.Snippet.RenderSnippetAsPdf(PdfSharp.Drawing.XUnit,PdfSharp.Drawing.XUnit,PdfSharp.Drawing.XGraphicsUnit,PdfSharp.Drawing.XPageDirection)">
  647. <summary>
  648. Renders a snippet as PDF document.
  649. </summary>
  650. <param name="width"></param>
  651. <param name="height"></param>
  652. <param name="graphicsUnit"></param>
  653. <param name="pageDirection"></param>
  654. </member>
  655. <member name="M:PdfSharp.Quality.Snippet.RenderSnippetAsPng">
  656. <summary>
  657. Renders a snippet as PNG image.
  658. </summary>
  659. </member>
  660. <member name="M:PdfSharp.Quality.Snippet.CreatePdfPage(PdfSharp.Pdf.PdfDocument)">
  661. <summary>
  662. Creates a PDF page for the specified document.
  663. </summary>
  664. <param name="doc">The document.</param>
  665. </member>
  666. <member name="M:PdfSharp.Quality.Snippet.BeginBox(PdfSharp.Drawing.XGraphics,System.Int32,PdfSharp.Quality.FeatureAndSnippetBase.BoxOptions,System.String)">
  667. <summary>
  668. Translates origin of coordinate space to a box of size 220pp x 140pp.
  669. </summary>
  670. </member>
  671. <member name="M:PdfSharp.Quality.Snippet.BeginBox(PdfSharp.Drawing.XGraphics,System.Int32)">
  672. <summary>
  673. Begins rendering the content of a box.
  674. </summary>
  675. <param name="gfx">The XGraphics object.</param>
  676. <param name="boxNumber">The box number.</param>
  677. </member>
  678. <member name="M:PdfSharp.Quality.Snippet.BeginBox(PdfSharp.Drawing.XGraphics,System.Int32,PdfSharp.Quality.FeatureAndSnippetBase.BoxOptions)">
  679. <summary>
  680. Begins rendering the content of a box.
  681. </summary>
  682. <param name="gfx">The XGraphics object.</param>
  683. <param name="boxNumber">The box number.</param>
  684. <param name="options">The box options.</param>
  685. </member>
  686. <member name="M:PdfSharp.Quality.Snippet.EndBox(PdfSharp.Drawing.XGraphics)">
  687. <summary>
  688. Ends rendering of the current box.
  689. </summary>
  690. <param name="gfx">The XGraphics object.</param>
  691. </member>
  692. <member name="M:PdfSharp.Quality.Snippet.DrawTiledBox(PdfSharp.Drawing.XGraphics,System.Double,System.Double,System.Double,System.Double,System.Double)">
  693. <summary>
  694. Draws a tiled box.
  695. </summary>
  696. <param name="gfx">The XGraphics object.</param>
  697. <param name="x">The left position of the box.</param>
  698. <param name="y">The top position of the box.</param>
  699. <param name="width">The width of the box.</param>
  700. <param name="height">The height of the box.</param>
  701. <param name="delta">The size of the grid square.</param>
  702. </member>
  703. <member name="P:PdfSharp.Quality.Snippet.RectBox">
  704. <summary>
  705. Gets the rectangle of a box.
  706. </summary>
  707. </member>
  708. <member name="M:PdfSharp.Quality.Snippet.DrawCenterPoint(PdfSharp.Drawing.XGraphics)">
  709. <summary>
  710. Draws the center point of a box.
  711. </summary>
  712. <param name="gfx">The XGraphics object.</param>
  713. </member>
  714. <member name="M:PdfSharp.Quality.Snippet.DrawAlignmentGrid(PdfSharp.Drawing.XGraphics,System.Boolean,System.Boolean)">
  715. <summary>
  716. Draws the alignment grid.
  717. </summary>
  718. <param name="gfx">The XGraphics object.</param>
  719. <param name="highlightHorizontal">if set to <c>true</c> [highlight horizontal].</param>
  720. <param name="highlightVertical">if set to <c>true</c> [highlight vertical].</param>
  721. </member>
  722. <member name="M:PdfSharp.Quality.Snippet.DrawArtBox(PdfSharp.Drawing.XGraphics)">
  723. <summary>
  724. Draws a dotted line showing the art box.
  725. </summary>
  726. <param name="gfx">The XGraphics object.</param>
  727. </member>
  728. <member name="P:PdfSharp.Quality.Snippet.Pentagram">
  729. <summary>
  730. Gets the points of a pentagram in a unit circle.
  731. </summary>
  732. </member>
  733. <member name="M:PdfSharp.Quality.Snippet.GetPentagram(System.Double,PdfSharp.Drawing.XPoint)">
  734. <summary>
  735. Gets the points of a pentagram relative to a center and scaled by a size factor.
  736. </summary>
  737. <param name="size">The scaling factor of the pentagram.</param>
  738. <param name="center">The center of the pentagram.</param>
  739. <returns></returns>
  740. </member>
  741. <member name="M:PdfSharp.Quality.Snippet.HelloWorldFactory(System.String,System.Boolean)">
  742. <summary>
  743. Creates a HelloWorld document, optionally with custom message.
  744. </summary>
  745. <param name="message"></param>
  746. <param name="unicode"></param>
  747. </member>
  748. <member name="M:PdfSharp.Quality.Snippet.GfxForLastPage(PdfSharp.Pdf.PdfDocument)">
  749. <summary>
  750. Gets a XGraphics object for the last page of the specified document.
  751. </summary>
  752. <param name="doc">The PDF document.</param>
  753. </member>
  754. <member name="T:PdfSharp.Quality.XGraphicsDevExtensions">
  755. <summary>
  756. Extensions for the XGraphics class.
  757. </summary>
  758. </member>
  759. <member name="M:PdfSharp.Quality.XGraphicsDevExtensions.DrawMeasureBox(PdfSharp.Drawing.XGraphics,System.String,PdfSharp.Drawing.XFont,PdfSharp.Drawing.XPoint)">
  760. <summary>
  761. Draws the measurement box for a specified text and a font.
  762. </summary>
  763. <param name="gfx">The XGraphics object</param>
  764. <param name="text">The text to be measured.</param>
  765. <param name="font">The font to be used for measuring.</param>
  766. <param name="pos">The start point of the box.</param>
  767. </member>
  768. <member name="T:System.Runtime.CompilerServices.IsExternalInit">
  769. <summary>
  770. Required to compile init-only setters in .NET Standard and .NET Framework 4.71.
  771. </summary>
  772. </member>
  773. <member name="M:System.Runtime.CompilerServices.RuntimeHelpers.GetSubArray``1(``0[],System.Range)">
  774. <summary>
  775. Slices the specified array using the specified range.
  776. </summary>
  777. </member>
  778. <member name="T:System.Index">
  779. <summary>Represent a type can be used to index a collection either from the start or the end.</summary>
  780. <remarks>
  781. Index is used by the C# compiler to support the new index syntax
  782. <code>
  783. int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ;
  784. int lastElement = someArray[^1]; // lastElement = 5
  785. </code>
  786. </remarks>
  787. </member>
  788. <member name="M:System.Index.#ctor(System.Int32,System.Boolean)">
  789. <summary>Construct an Index using a value and indicating if the index is from the start or from the end.</summary>
  790. <param name="value">The index value. it has to be zero or positive number.</param>
  791. <param name="fromEnd">Indicating if the index is from the start or from the end.</param>
  792. <remarks>
  793. If the Index constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element.
  794. </remarks>
  795. </member>
  796. <member name="P:System.Index.Start">
  797. <summary>Create an Index pointing at first element.</summary>
  798. </member>
  799. <member name="P:System.Index.End">
  800. <summary>Create an Index pointing at beyond last element.</summary>
  801. </member>
  802. <member name="M:System.Index.FromStart(System.Int32)">
  803. <summary>Create an Index from the start at the position indicated by the value.</summary>
  804. <param name="value">The index value from the start.</param>
  805. </member>
  806. <member name="M:System.Index.FromEnd(System.Int32)">
  807. <summary>Create an Index from the end at the position indicated by the value.</summary>
  808. <param name="value">The index value from the end.</param>
  809. </member>
  810. <member name="P:System.Index.Value">
  811. <summary>Returns the index value.</summary>
  812. </member>
  813. <member name="P:System.Index.IsFromEnd">
  814. <summary>Indicates whether the index is from the start or the end.</summary>
  815. </member>
  816. <member name="M:System.Index.GetOffset(System.Int32)">
  817. <summary>Calculate the offset from the start using the giving collection length.</summary>
  818. <param name="length">The length of the collection that the Index will be used with. length has to be a positive value</param>
  819. <remarks>
  820. For performance reason, we don’t validate the input length parameter and the returned offset value against negative values.
  821. we don’t validate either the returned offset is greater than the input length.
  822. It is expected Index will be used with collections which always have non-negative length/count. If the returned offset is negative and
  823. then used to index a collection will get out of range exception which will be same affect as the validation.
  824. </remarks>
  825. </member>
  826. <member name="M:System.Index.Equals(System.Object)">
  827. <summary>Indicates whether the current Index object is equal to another object of the same type.</summary>
  828. <param name="value">An object to compare with this object</param>
  829. </member>
  830. <member name="M:System.Index.Equals(System.Index)">
  831. <summary>Indicates whether the current Index object is equal to another Index object.</summary>
  832. <param name="other">An object to compare with this object</param>
  833. </member>
  834. <member name="M:System.Index.GetHashCode">
  835. <summary>Returns the hash code for this instance.</summary>
  836. </member>
  837. <member name="M:System.Index.op_Implicit(System.Int32)~System.Index">
  838. <summary>Converts integer number to an Index.</summary>
  839. </member>
  840. <member name="M:System.Index.ToString">
  841. <summary>Converts the value of the current Index object to its equivalent string representation.</summary>
  842. </member>
  843. <member name="T:System.Range">
  844. <summary>Represent a range has start and end indexes.</summary>
  845. <remarks>
  846. Range is used by the C# compiler to support the range syntax.
  847. <code>
  848. int[] someArray = new int[5] { 1, 2, 3, 4, 5 };
  849. int[] subArray1 = someArray[0..2]; // { 1, 2 }
  850. int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 }
  851. </code>
  852. </remarks>
  853. </member>
  854. <member name="P:System.Range.Start">
  855. <summary>Represent the inclusive start index of the Range.</summary>
  856. </member>
  857. <member name="P:System.Range.End">
  858. <summary>Represent the exclusive end index of the Range.</summary>
  859. </member>
  860. <member name="M:System.Range.#ctor(System.Index,System.Index)">
  861. <summary>Construct a Range object using the start and end indexes.</summary>
  862. <param name="start">Represent the inclusive start index of the range.</param>
  863. <param name="end">Represent the exclusive end index of the range.</param>
  864. </member>
  865. <member name="M:System.Range.Equals(System.Object)">
  866. <summary>Indicates whether the current Range object is equal to another object of the same type.</summary>
  867. <param name="value">An object to compare with this object</param>
  868. </member>
  869. <member name="M:System.Range.Equals(System.Range)">
  870. <summary>Indicates whether the current Range object is equal to another Range object.</summary>
  871. <param name="other">An object to compare with this object</param>
  872. </member>
  873. <member name="M:System.Range.GetHashCode">
  874. <summary>Returns the hash code for this instance.</summary>
  875. </member>
  876. <member name="M:System.Range.ToString">
  877. <summary>Converts the value of the current Range object to its equivalent string representation.</summary>
  878. </member>
  879. <member name="M:System.Range.StartAt(System.Index)">
  880. <summary>Create a Range object starting from start index to the end of the collection.</summary>
  881. </member>
  882. <member name="M:System.Range.EndAt(System.Index)">
  883. <summary>Create a Range object starting from first element in the collection to the end Index.</summary>
  884. </member>
  885. <member name="P:System.Range.All">
  886. <summary>Create a Range object starting from first element to the end.</summary>
  887. </member>
  888. <member name="M:System.Range.GetOffsetAndLength(System.Int32)">
  889. <summary>Calculate the start offset and length of range object using a collection length.</summary>
  890. <param name="length">The length of the collection that the range will be used with. length has to be a positive value.</param>
  891. <remarks>
  892. For performance reason, we don’t validate the input length parameter against negative values.
  893. It is expected Range will be used with collections which always have non-negative length/count.
  894. We validate the range is inside the length scope though.
  895. </remarks>
  896. </member>
  897. <member name="M:StringExtensions.Contains(System.String,System.String,System.StringComparison)">
  898. <summary>
  899. String.Contains implementation for .NET Framework and .NET Standard as an extension method.
  900. </summary>
  901. </member>
  902. </members>
  903. </doc>