SharpVectors.Rendering.Gdi.xml 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>SharpVectors.Rendering.Gdi</name>
  5. </assembly>
  6. <members>
  7. <member name="T:SharpVectors.Renderers.Forms.SvgPictureBox">
  8. <summary>
  9. This represents an <c>SVG</c> picture box control for displaying <c>GDI+</c> rendered <c>SVG</c> images.
  10. </summary>
  11. <remarks>This is similar to the Windows picture box control for displaying an image.</remarks>
  12. </member>
  13. <member name="F:SharpVectors.Renderers.Forms.SvgPictureBox._sizeMode">
  14. <summary>
  15. Controls how the image is placed within our bounds, or how we are sized to fit said image.
  16. </summary>
  17. </member>
  18. <member name="F:SharpVectors.Renderers.Forms.SvgPictureBox._borderStyle">
  19. <summary>
  20. The type of border this control will have.
  21. </summary>
  22. </member>
  23. <member name="M:SharpVectors.Renderers.Forms.SvgPictureBox.#ctor">
  24. <summary>
  25. Initializes a new instance of the <see cref="T:SharpVectors.Renderers.Forms.SvgPictureBox"/> class.
  26. </summary>
  27. </member>
  28. <member name="M:SharpVectors.Renderers.Forms.SvgPictureBox.Dispose(System.Boolean)">
  29. <summary>
  30. Clean up any resources being used.
  31. </summary>
  32. </member>
  33. <member name="E:SharpVectors.Renderers.Forms.SvgPictureBox.Alert">
  34. <summary>
  35. An event that occurs when there is an alert message to be displayed.
  36. </summary>
  37. <remarks>Handle this to display a customized message box or prevent the display of the alert.</remarks>
  38. </member>
  39. <member name="E:SharpVectors.Renderers.Forms.SvgPictureBox.Error">
  40. <summary>
  41. An event that occurs when there is an error message to be displayed.
  42. </summary>
  43. <remarks>Handle this to display a customized message box or prevent the display of the error.</remarks>
  44. </member>
  45. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.BorderStyle">
  46. <summary>
  47. Indicates the border style for the control.
  48. </summary>
  49. <value>An enumeration of the type <see cref="P:SharpVectors.Renderers.Forms.SvgPictureBox.BorderStyle"/> specifying the border style.</value>
  50. </member>
  51. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.SizeMode">
  52. <summary>
  53. Gets or sets a value indicating how the rendered image is displayed.
  54. </summary>
  55. <value>An enumeration of the type <see cref="T:System.Windows.Forms.PictureBoxSizeMode"/> specifying the size mode.</value>
  56. </member>
  57. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.AppTitle">
  58. <summary>
  59. Gets or sets the application title. This is used for message dialog titles.
  60. </summary>
  61. <value>A string specifying the application title.</value>
  62. </member>
  63. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.Source">
  64. <summary>
  65. Gets or sets the source URL for the <c>SVG</c> contents.
  66. </summary>
  67. <value>A string specifying the path of the <c>SVG</c> contents.</value>
  68. </member>
  69. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.UriSource">
  70. <summary>
  71. Gets or sets the source URL for the <c>SVG</c> contents.
  72. </summary>
  73. <value>An <see cref="T:System.Uri"/> specifying the path of the <c>SVG</c> contents.</value>
  74. </member>
  75. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.XmlSource">
  76. <summary>
  77. Gets or sets the <c>SVG</c> contents.
  78. </summary>
  79. <value>A string containing the <c>SVG</c> contents.</value>
  80. </member>
  81. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.Window">
  82. <summary>
  83. Gets the current SVG window implementation or <see cref="T:SharpVectors.Dom.Svg.ISvgWindow"/> used by this control
  84. </summary>
  85. <value>An SVG window interface, <see cref="T:SharpVectors.Dom.Svg.ISvgWindow"/>.</value>
  86. </member>
  87. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.InvalidRect">
  88. <summary>
  89. Gets A rectangle that represents the invalidated region of the control.
  90. </summary>
  91. <value>A <see cref="T:System.Drawing.RectangleF"/> that represents the invalidated region.</value>
  92. </member>
  93. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.ForeColor">
  94. <summary>
  95. Gets or sets the foreground color of the control.
  96. </summary>
  97. <value>The foreground <see cref="T:System.Drawing.Color"/> of the control.
  98. The default is the value of the <see cref="!:DefaultForeColor"/> property.</value>
  99. </member>
  100. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.Font">
  101. <summary>
  102. Gets or sets the font of the text displayed by the control.
  103. </summary>
  104. <value>The <see cref="T:System.Drawing.Font"/> to apply to the text displayed by the control.
  105. The default is the value of the <see cref="!:DefaultFont"/> property.</value>
  106. </member>
  107. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.RightToLeft">
  108. <summary>
  109. Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left languages.
  110. </summary>
  111. <value>One of the <see cref="T:System.Windows.Forms.RightToLeft"/> values.</value>
  112. </member>
  113. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.Text">
  114. <summary>
  115. Gets or sets the text of this control.
  116. </summary>
  117. <value>The text of the <see cref="T:SharpVectors.Renderers.Forms.SvgPictureBox"/>.</value>
  118. </member>
  119. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.DefaultSize">
  120. <summary>
  121. Deriving classes can override this to configure a default size for their control.
  122. This is more efficient than setting the size in the control's constructor.
  123. </summary>
  124. <value>The default Size of the control. The default size is 200 pixel square.</value>
  125. </member>
  126. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.DefaultImeMode">
  127. <summary>
  128. Gets the default Input Method Editor (IME) mode supported by the control.
  129. </summary>
  130. <value>This is one of the <see cref="T:System.Windows.Forms.ImeMode"/> values, and it is set to <see cref="F:System.Windows.Forms.ImeMode.Disable"/>.</value>
  131. </member>
  132. <member name="P:SharpVectors.Renderers.Forms.SvgPictureBox.CreateParams">
  133. <summary>
  134. Returns the parameters needed to create the handle.
  135. </summary>
  136. </member>
  137. <member name="M:SharpVectors.Renderers.Forms.SvgPictureBox.Load(System.String)">
  138. <summary>
  139. Loads and renders the SVG contents specified by the file path.
  140. </summary>
  141. <param name="svgSource">A <see cref="T:System.String"/> specifying the path of the SVG contents.</param>
  142. </member>
  143. <member name="M:SharpVectors.Renderers.Forms.SvgPictureBox.LoadAsync(System.String)">
  144. <summary>
  145. Loads and renders asynchronously the SVG contents specified by the file path.
  146. </summary>
  147. <param name="svgSource">A <see cref="T:System.String"/> specifying the path of the SVG contents.</param>
  148. </member>
  149. <member name="M:SharpVectors.Renderers.Forms.SvgPictureBox.LoadXml(System.String)">
  150. <summary>
  151. Loads and renders the SVG contents.
  152. </summary>
  153. <param name="svgSource">A <see cref="T:System.String"/> specifying the SVG contents.</param>
  154. </member>
  155. <member name="M:SharpVectors.Renderers.Forms.SvgPictureBox.Load(System.Uri)">
  156. <summary>
  157. Loads and renders the SVG contents specified by the URI.
  158. </summary>
  159. <param name="svgSource">A <see cref="T:System.Uri"/> specifying the path of the SVG contents.</param>
  160. </member>
  161. <member name="M:SharpVectors.Renderers.Forms.SvgPictureBox.Load(System.IO.Stream)">
  162. <summary>
  163. Loads and renders the SVG contents in the specified stream.
  164. </summary>
  165. <param name="streamSource">A stream containing the SVG contents.</param>
  166. </member>
  167. <member name="M:SharpVectors.Renderers.Forms.SvgPictureBox.Unload">
  168. <summary>
  169. Clears both the SVG document content and the rendered drawings.
  170. </summary>
  171. </member>
  172. <member name="M:SharpVectors.Renderers.Forms.SvgPictureBox.ToString">
  173. <summary>
  174. Returns a string representation for this control.
  175. </summary>
  176. </member>
  177. <member name="M:SharpVectors.Renderers.Forms.SvgPictureBox.CreateEmptySvgDocument">
  178. <summary>
  179. Create an empty SvgDocument and GdiRenderer for this control.
  180. The empty SvgDocument is returned. This method is needed only in situations
  181. where the library user needs to create an SVG DOM tree outside of the usual window Src setting mechanism.
  182. </summary>
  183. </member>
  184. <member name="M:SharpVectors.Renderers.Forms.SvgPictureBox.SetupStyleSheets">
  185. <summary>
  186. Loads the default user and agent stylesheets into the current SvgDocument
  187. </summary>
  188. </member>
  189. <member name="M:SharpVectors.Renderers.Forms.SvgPictureBox.AdjustSize">
  190. <summary>
  191. If the <see cref="T:SharpVectors.Renderers.Forms.SvgPictureBox"/> has the <see cref="P:SharpVectors.Renderers.Forms.SvgPictureBox.SizeMode"/> property set to
  192. <see cref="F:System.Windows.Forms.PictureBoxSizeMode.AutoSize"/>, adjust the size to hold the rendered image.
  193. </summary>
  194. </member>
  195. <member name="F:SharpVectors.Renderers.Forms.SvgPictureBox.components">
  196. <summary>
  197. Required designer variable.
  198. </summary>
  199. </member>
  200. <member name="M:SharpVectors.Renderers.Forms.SvgPictureBox.InitializeComponent">
  201. <summary>
  202. Required method for Designer support - do not modify
  203. the contents of this method with the code editor.
  204. </summary>
  205. </member>
  206. <member name="M:SharpVectors.Renderers.GdiConverter.ToColor(SharpVectors.Dom.Css.ICssColor)">
  207. <summary>
  208. A GDI Color representation of the RgbColor
  209. </summary>
  210. </member>
  211. <member name="M:SharpVectors.Renderers.GdiConverter.ToRectangle(SharpVectors.Dom.Svg.SvgRectF)">
  212. <summary>
  213. This converts the specified <see cref="T:System.Drawing.RectangleF"/> structure to a
  214. <see cref="T:SharpVectors.Dom.Svg.SvgRectF"/> structure.
  215. </summary>
  216. <param name="rect">The <see cref="T:System.Drawing.RectangleF"/> structure to convert.</param>
  217. <returns>
  218. The <see cref="T:SharpVectors.Dom.Svg.SvgRectF"/> structure that is converted from the
  219. specified <see cref="T:System.Drawing.RectangleF"/> structure.
  220. </returns>
  221. </member>
  222. <member name="P:SharpVectors.Renderers.GdiRenderingSettings.IgnoreRootViewbox">
  223. <summary>
  224. Gets or sets a value to indicate turning off viewbox at the root of the drawing.
  225. </summary>
  226. <value>
  227. For image outputs, this will force the original size to be saved.
  228. <para>
  229. The default value is <see langword="false"/>.
  230. </para>
  231. </value>
  232. <remarks>
  233. There are reported cases where are diagrams displayed in Inkscape program, but will not
  234. show when converted. These are diagrams on the drawing canvas of Inkspace but outside
  235. the svg viewbox.
  236. <para>
  237. When converted the drawings are also converted but not displayed due to
  238. clipping. Setting this property to <see langword="true"/> will clear the clipping region
  239. on conversion.
  240. </para>
  241. </remarks>
  242. </member>
  243. <member name="P:SharpVectors.Renderers.GdiRenderingSettings.EnsureViewboxSize">
  244. <summary>
  245. Gets or sets a value to indicate preserving the original viewbox size when saving images.
  246. </summary>
  247. <value>
  248. For image outputs, this will force the original size to be saved.
  249. <para>
  250. The default value is <see langword="false"/>. However, the ImageSvgConverter converted
  251. sets this to <see langword="true"/> by default.
  252. </para>
  253. </value>
  254. <remarks>
  255. Setting this to <see langword="true"/> will cause the rendering process to draw a transparent
  256. box around the output, if a viewbox is defined. This will ensure that the original image
  257. size is saved.
  258. </remarks>
  259. </member>
  260. <member name="P:SharpVectors.Renderers.GdiRenderingSettings.EnsureViewboxPosition">
  261. <summary>
  262. Gets or sets a value to indicate applying a translate transform to the viewbox to ensure
  263. it is visible when rendered.
  264. </summary>
  265. <value>
  266. This determines whether a transformation is applied to the rendered drawing. For drawings
  267. where the top-left position of the viewbox is off the screen, due to negative values, this
  268. will ensure the drawing is visible.
  269. <para>
  270. The default value is <see langword="true"/>. Set this value to <see langword="false"/> if
  271. you wish to apply your own transformations to the drawings.
  272. </para>
  273. </value>
  274. </member>
  275. <member name="P:SharpVectors.Renderers.GdiRenderingSettings.CultureInfo">
  276. <summary>
  277. Gets or sets the main culture information used for rendering texts.
  278. </summary>
  279. <value>
  280. An instance of the <see cref="P:SharpVectors.Renderers.GdiRenderingSettings.CultureInfo"/> specifying the main
  281. culture information for texts. The default is the English culture.
  282. </value>
  283. <remarks>
  284. <para>
  285. The library does not currently provide any means of splitting texts
  286. into its multi-language parts.
  287. </para>
  288. </remarks>
  289. </member>
  290. <member name="P:SharpVectors.Renderers.GdiRenderingSettings.NeutralCultureInfo">
  291. <summary>
  292. Gets the neutral language for text rendering.
  293. </summary>
  294. <value>
  295. An instance of the <see cref="P:SharpVectors.Renderers.GdiRenderingSettings.CultureInfo"/> specifying the neutral
  296. culture information for texts. The default is the English culture.
  297. </value>
  298. <remarks>
  299. For vertical text rendering, there is a basic text splitting into
  300. Western and other languages. This culture information is used to
  301. render the Western language part, and the mains culture information
  302. for the other languages.
  303. </remarks>
  304. </member>
  305. <member name="P:SharpVectors.Renderers.GdiRenderingSettings.DefaultFontName">
  306. <summary>
  307. Gets or sets the default font family name, which is used when a text
  308. node does not specify a font family name.
  309. </summary>
  310. <value>
  311. A string containing the default font family name. The default is
  312. the <c>Arial Unicode MS</c> font, for its support of Unicode texts.
  313. This value cannot be <see langword="null"/> or empty.
  314. </value>
  315. </member>
  316. <member name="P:SharpVectors.Renderers.GdiRenderingSettings.DefaultFontFamily">
  317. <summary>
  318. Gets or sets the globally available default font family.
  319. </summary>
  320. <value>
  321. An instance of the <see cref="T:System.Drawing.FontFamily"/> specifying the globally available font family.
  322. The default is <c>Arial</c> font (since <c>Arial Unicode MS</c> is no longer shipped by MS).
  323. family.
  324. </value>
  325. </member>
  326. <member name="P:SharpVectors.Renderers.GdiRenderingSettings.GenericSerif">
  327. <summary>
  328. Gets or set the globally available generic serif font family.
  329. </summary>
  330. <value>
  331. An instance of <see cref="T:System.Drawing.FontFamily"/> specifying the generic serif
  332. font family. The default is <c>Times New Roman</c> font family.
  333. </value>
  334. </member>
  335. <member name="P:SharpVectors.Renderers.GdiRenderingSettings.GenericSansSerif">
  336. <summary>
  337. Gets or set the globally available generic sans serif font family.
  338. </summary>
  339. <value>
  340. An instance of <see cref="T:System.Drawing.FontFamily"/> specifying the generic sans
  341. serif font family. The default is <c>Tahoma</c> font family.
  342. </value>
  343. <remarks>
  344. The possible font names are <c>Tahoma</c>, <c>Arial</c>,
  345. <c>Verdana</c>, <c>Trebuchet</c>, <c>MS Sans Serif</c> and <c>Helvetica</c>.
  346. </remarks>
  347. </member>
  348. <member name="P:SharpVectors.Renderers.GdiRenderingSettings.GenericMonospace">
  349. <summary>
  350. Gets or set the globally available generic Monospace font family.
  351. </summary>
  352. <value>
  353. An instance of <see cref="T:System.Drawing.FontFamily"/> specifying the generic
  354. Monospace font family. The default is <c>MS Gothic</c> font family.
  355. </value>
  356. </member>
  357. <member name="T:SharpVectors.Renderers.Gdi.GdiFontStyles">
  358. <summary>
  359. Provides a set of static predefined GdiFontStyles values.
  360. </summary>
  361. </member>
  362. <member name="F:SharpVectors.Renderers.Gdi.GdiFontStyles.Normal">
  363. <summary>
  364. Specifies a normal GdiFontStyles.
  365. </summary>
  366. </member>
  367. <member name="F:SharpVectors.Renderers.Gdi.GdiFontStyles.Oblique">
  368. <summary>
  369. Specifies an oblique GdiFontStyles.
  370. </summary>
  371. </member>
  372. <member name="F:SharpVectors.Renderers.Gdi.GdiFontStyles.Italic">
  373. <summary>
  374. Specifies an italic GdiFontStyles.
  375. </summary>
  376. </member>
  377. <member name="T:SharpVectors.Renderers.Gdi.GdiFontWeights">
  378. <summary>
  379. Provides a set of static predefined FontWeight values.
  380. </summary>
  381. </member>
  382. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.Thin">
  383. <summary>
  384. Specifies a "Thin" font weight.
  385. </summary>
  386. </member>
  387. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.ExtraLight">
  388. <summary>
  389. Specifies an "Extra-light" font weight.
  390. </summary>
  391. </member>
  392. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.UltraLight">
  393. <summary>
  394. Specifies an "Ultra-light" font weight.
  395. </summary>
  396. </member>
  397. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.Light">
  398. <summary>
  399. Specifies a "Light" font weight.
  400. </summary>
  401. </member>
  402. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.Normal">
  403. <summary>
  404. Specifies a "Normal" font weight.
  405. </summary>
  406. </member>
  407. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.Regular">
  408. <summary>
  409. Specifies a "Regular" font weight.
  410. </summary>
  411. </member>
  412. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.Medium">
  413. <summary>
  414. Specifies a "Medium" font weight.
  415. </summary>
  416. </member>
  417. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.DemiBold">
  418. <summary>
  419. Specifies a "Demi-bold" font weight.
  420. </summary>
  421. </member>
  422. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.SemiBold">
  423. <summary>
  424. Specifies a "Semi-bold" font weight.
  425. </summary>
  426. </member>
  427. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.Bold">
  428. <summary>
  429. Specifies a "Bold" font weight.
  430. </summary>
  431. </member>
  432. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.ExtraBold">
  433. <summary>
  434. Specifies an "Extra-bold" font weight.
  435. </summary>
  436. </member>
  437. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.UltraBold">
  438. <summary>
  439. Specifies an "Ultra-bold" font weight.
  440. </summary>
  441. </member>
  442. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.Black">
  443. <summary>
  444. Specifies a "Black" font weight.
  445. </summary>
  446. </member>
  447. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.Heavy">
  448. <summary>
  449. Specifies a "Heavy" font weight.
  450. </summary>
  451. </member>
  452. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.ExtraBlack">
  453. <summary>
  454. Specifies an "Extra-black" font weight.
  455. </summary>
  456. </member>
  457. <member name="F:SharpVectors.Renderers.Gdi.GdiFontWeights.UltraBlack">
  458. <summary>
  459. Specifies an "Ultra-black" font weight.
  460. </summary>
  461. </member>
  462. <member name="T:SharpVectors.Renderers.Gdi.GdiFontStretches">
  463. <summary>
  464. Provides a set of static predefined GdiFontStretches values.
  465. </summary>
  466. </member>
  467. <member name="F:SharpVectors.Renderers.Gdi.GdiFontStretches.UltraCondensed">
  468. <summary>
  469. Specifies an ultra-condensed GdiFontStretches.
  470. </summary>
  471. </member>
  472. <member name="F:SharpVectors.Renderers.Gdi.GdiFontStretches.ExtraCondensed">
  473. <summary>
  474. Specifies an extra-condensed GdiFontStretches.
  475. </summary>
  476. </member>
  477. <member name="F:SharpVectors.Renderers.Gdi.GdiFontStretches.Condensed">
  478. <summary>
  479. Specifies a condensed GdiFontStretches.
  480. </summary>
  481. </member>
  482. <member name="F:SharpVectors.Renderers.Gdi.GdiFontStretches.SemiCondensed">
  483. <summary>
  484. Specifies a semi-condensed GdiFontStretches.
  485. </summary>
  486. </member>
  487. <member name="F:SharpVectors.Renderers.Gdi.GdiFontStretches.Normal">
  488. <summary>
  489. Specifies a normal GdiFontStretches.
  490. </summary>
  491. </member>
  492. <member name="F:SharpVectors.Renderers.Gdi.GdiFontStretches.Medium">
  493. <summary>
  494. Specifies a medium GdiFontStretches.
  495. </summary>
  496. </member>
  497. <member name="F:SharpVectors.Renderers.Gdi.GdiFontStretches.SemiExpanded">
  498. <summary>
  499. Specifies a semi-expanded GdiFontStretches.
  500. </summary>
  501. </member>
  502. <member name="F:SharpVectors.Renderers.Gdi.GdiFontStretches.Expanded">
  503. <summary>
  504. Specifies an expanded GdiFontStretches.
  505. </summary>
  506. </member>
  507. <member name="F:SharpVectors.Renderers.Gdi.GdiFontStretches.ExtraExpanded">
  508. <summary>
  509. Specifies an extra-expanded GdiFontStretches.
  510. </summary>
  511. </member>
  512. <member name="F:SharpVectors.Renderers.Gdi.GdiFontStretches.UltraExpanded">
  513. <summary>
  514. Specifies an ultra-expanded GdiFontStretches.
  515. </summary>
  516. </member>
  517. <member name="F:SharpVectors.Renderers.Gdi.GdiFontStretches.Custom">
  518. <summary>
  519. </summary>
  520. </member>
  521. <member name="T:SharpVectors.Renderers.Gdi.GdiGradientFill">
  522. <summary>
  523. Summary description for PaintServer.
  524. </summary>
  525. </member>
  526. <member name="T:SharpVectors.Renderers.Gdi.GdiGradientStop">
  527. <summary>
  528. Describes the location and color of a transition point in a gradient.
  529. </summary>
  530. </member>
  531. <member name="M:SharpVectors.Renderers.Gdi.GdiGradientStop.#ctor">
  532. <summary>
  533. Initializes a new instance of the <see cref="T:SharpVectors.Renderers.Gdi.GdiGradientStop"/> class.
  534. </summary>
  535. </member>
  536. <member name="M:SharpVectors.Renderers.Gdi.GdiGradientStop.#ctor(System.Drawing.Color,System.Single)">
  537. <summary>
  538. Initializes a new instance of the <see cref="T:SharpVectors.Renderers.Gdi.GdiGradientStop"/> class with
  539. the specified color and offset.
  540. </summary>
  541. <param name="color">The color value of the gradient stop.</param>
  542. <param name="offset">The location in the gradient where the gradient stop is placed.</param>
  543. </member>
  544. <member name="P:SharpVectors.Renderers.Gdi.GdiGradientStop.Color">
  545. <summary>
  546. Gets or sets the color of the gradient stop.
  547. </summary>
  548. <value>The color of the gradient stop. The default value is <see cref="P:System.Drawing.Color.Transparent"/>.</value>
  549. </member>
  550. <member name="P:SharpVectors.Renderers.Gdi.GdiGradientStop.Offset">
  551. <summary>
  552. Gets or set the location of the gradient stop within the gradient vector.
  553. </summary>
  554. <value>
  555. The relative location of this gradient stop along the gradient vector.
  556. The default value is <c>0.0</c>.
  557. </value>
  558. </member>
  559. <member name="M:SharpVectors.Renderers.Gdi.GdiGradientStop.Clone">
  560. <summary>
  561. Creates a modifiable clone of this <see cref="!:]GdiGradientStop"/>, making
  562. deep copies of this object's values.
  563. </summary>
  564. <returns>A modifiable clone of the current object.</returns>
  565. </member>
  566. <member name="M:SharpVectors.Renderers.Gdi.GdiGradientStop.ToString">
  567. <summary>
  568. Creates a string representation of this object based on the current culture.
  569. </summary>
  570. <returns>
  571. A string representation of this object that contains its <see cref="P:SharpVectors.Renderers.Gdi.GdiGradientStop.Color"/>
  572. and <see cref="P:SharpVectors.Renderers.Gdi.GdiGradientStop.Offset"/> values.
  573. </returns>
  574. </member>
  575. <member name="T:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer">
  576. <summary>
  577. Renders a Svg image to GDI+
  578. </summary>
  579. </member>
  580. <member name="F:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer._rasterImage">
  581. <summary>
  582. The bitmap containing the rendered Svg image.
  583. </summary>
  584. </member>
  585. <member name="F:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer._graphics">
  586. <summary>
  587. The renderer's graphics wrapper object.
  588. </summary>
  589. </member>
  590. <member name="F:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer._backColor">
  591. <summary>
  592. The renderer's back color.
  593. </summary>
  594. </member>
  595. <member name="F:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer._svgWindow">
  596. <summary>
  597. The renderer's <see cref="T:SharpVectors.Dom.Svg.SvgWindow">SvgWindow</see> object.
  598. </summary>
  599. </member>
  600. <member name="F:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer._currentDownX">
  601. <summary>
  602. </summary>
  603. </member>
  604. <member name="M:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.#ctor(System.Boolean,System.Boolean)">
  605. <summary>
  606. Initializes a new instance of the GdiRenderer class.
  607. </summary>
  608. </member>
  609. <member name="P:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.RasterImage">
  610. <summary>
  611. Gets a bitmap image of the a rendered Svg document.
  612. </summary>
  613. </member>
  614. <member name="P:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.Window">
  615. <summary>
  616. Gets or sets the <see cref="P:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.Window">Window</see> of the
  617. renderer.
  618. </summary>
  619. <value>
  620. The <see cref="P:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.Window">Window</see> of the renderer.
  621. </value>
  622. </member>
  623. <member name="P:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.BackColor">
  624. <summary>
  625. Gets or sets the back color of the renderer.
  626. </summary>
  627. <value>
  628. The back color of the renderer.
  629. </value>
  630. </member>
  631. <member name="P:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.GdiGraphics">
  632. <summary>
  633. Gets or sets the <see cref="P:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.GdiGraphics">GdiGraphics</see>
  634. object associated with this renderer.
  635. </summary>
  636. <value>
  637. The <see cref="P:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.GdiGraphics">GdiGraphics</see> object
  638. associated with this renderer.
  639. </value>
  640. </member>
  641. <member name="P:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.InvalidRect">
  642. <summary>
  643. The invalidated region
  644. </summary>
  645. </member>
  646. <member name="M:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.Render(SharpVectors.Dom.Svg.ISvgElement)">
  647. <summary>
  648. Renders the <see cref="T:SharpVectors.Dom.Svg.SvgElement">SvgElement</see>.
  649. </summary>
  650. <param name="node">
  651. The <see cref="T:SharpVectors.Dom.Svg.SvgElement">SvgElement</see> node to be
  652. rendered
  653. </param>
  654. <returns>
  655. The bitmap on which the rendering was performed.
  656. </returns>
  657. </member>
  658. <member name="M:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.Render(SharpVectors.Dom.Svg.ISvgDocument)">
  659. <summary>
  660. Renders the <see cref="T:SharpVectors.Dom.Svg.SvgDocument">SvgDocument</see>.
  661. </summary>
  662. <param name="node">
  663. The <see cref="T:SharpVectors.Dom.Svg.SvgDocument">SvgDocument</see> node to be
  664. rendered
  665. </param>
  666. <returns>
  667. The bitmap on which the rendering was performed.
  668. </returns>
  669. </member>
  670. <member name="M:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.OnMouseEvent(System.String,System.Windows.Forms.MouseEventArgs)">
  671. <summary>
  672. Processes mouse events.
  673. </summary>
  674. <param name="type">
  675. A string describing the type of mouse event that occured.
  676. </param>
  677. <param name="e">
  678. The <see cref="T:System.Windows.Forms.MouseEventArgs">MouseEventArgs</see> that contains
  679. the event data.
  680. </param>
  681. </member>
  682. <member name="M:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.OnBeforeRender">
  683. <summary>
  684. BeforeRender - Make sure we have a Graphics object to render to.
  685. If we don't have one, then create one to match the SvgWindow's
  686. physical dimensions.
  687. </summary>
  688. </member>
  689. <member name="M:SharpVectors.Renderers.Gdi.GdiGraphicsRenderer.OnAfterRender">
  690. <summary>
  691. AfterRender - Dispose of Graphics object created for rendering.
  692. </summary>
  693. </member>
  694. <member name="M:SharpVectors.Renderers.Gdi.GdiHitTestHelper.HitTest(System.Int32,System.Int32)">
  695. <summary>
  696. Returns the topmost object of a hit test by specifying a Point.
  697. </summary>
  698. <param name="pointX">The X-value of the point to hit test against.</param>
  699. <param name="pointY">The Y-value of the point to hit test against.</param>
  700. <returns>The hit test result of the renderer, returned as a <see cref="T:SharpVectors.Renderers.Gdi.GdiHitTestResult"/> type.</returns>
  701. </member>
  702. <member name="M:SharpVectors.Renderers.Gdi.GdiHitTestHelper.HitTest(System.Drawing.Point)">
  703. <summary>
  704. Returns the topmost object of a hit test by specifying a Point.
  705. </summary>
  706. <param name="point">The point value to hit test against.</param>
  707. <returns>The hit test result of the renderer, returned as a <see cref="T:SharpVectors.Renderers.Gdi.GdiHitTestResult"/> type.</returns>
  708. </member>
  709. <member name="M:SharpVectors.Renderers.Gdi.GdiHitTestHelper.GdiHitTestHelperNoHit.HitTest(System.Int32,System.Int32)">
  710. <summary>
  711. Returns the topmost object of a hit test by specifying a Point.
  712. </summary>
  713. <param name="pointX">The X-value of the point to hit test against.</param>
  714. <param name="pointY">The Y-value of the point to hit test against.</param>
  715. <returns>The hit test result of the renderer, returned as a <see cref="T:SharpVectors.Renderers.Gdi.GdiHitTestResult"/> type.</returns>
  716. </member>
  717. <member name="P:SharpVectors.Renderers.Gdi.GdiHitTestResult.Point">
  718. <summary>
  719. The point value to hit test against.
  720. </summary>
  721. </member>
  722. <member name="P:SharpVectors.Renderers.Gdi.GdiHitTestResult.Element">
  723. <summary>
  724. Gets the SVG object that was hit.
  725. </summary>
  726. </member>
  727. <member name="T:SharpVectors.Renderers.Gdi.GdiImageRendering">
  728. <summary>
  729. Summary description for GdiImageRendering.
  730. </summary>
  731. </member>
  732. <member name="M:SharpVectors.Renderers.Gdi.GdiRendering.CreateByUri(SharpVectors.Dom.Svg.SvgDocument,System.String,System.String)">
  733. <summary>
  734. Generates a new <see cref="T:SharpVectors.Renderers.Gdi.GdiRendering">GdiRendering</see> that
  735. corresponds to the given Uri.
  736. </summary>
  737. <param name="baseUri">
  738. The base Uri.
  739. </param>
  740. <param name="url">
  741. The url.
  742. </param>
  743. <returns>
  744. The generated <see cref="T:SharpVectors.Renderers.Gdi.GdiRendering">GdiRendering</see> that
  745. corresponds to the given Uri.
  746. </returns>
  747. </member>
  748. <member name="T:SharpVectors.Renderers.Gdi.GdiRenderingBase">
  749. <summary>
  750. Defines the interface required for a rendering node to interact with the renderer and the SVG DOM
  751. </summary>
  752. </member>
  753. <member name="T:SharpVectors.Renderers.Gdi.GdiSvgRendering">
  754. <summary>
  755. Summary description for <see cref="T:SharpVectors.Renderers.Gdi.GdiSvgRendering"/>.
  756. </summary>
  757. </member>
  758. <member name="T:SharpVectors.Renderers.Gdi.GdiSymbolRendering">
  759. <summary>
  760. Summary description for <see cref="T:SharpVectors.Renderers.Gdi.GdiSymbolRendering"/>.
  761. </summary>
  762. </member>
  763. <member name="T:SharpVectors.Renderers.Gdi.GdiUseRendering">
  764. <summary>
  765. Summary description for <see cref="T:SharpVectors.Renderers.Gdi.GdiUseRendering"/>.
  766. </summary>
  767. </member>
  768. <member name="T:SharpVectors.Renderers.Gdi.GdiGraphicsImpl">
  769. <summary>
  770. Wraps a Graphics object since it's sealed
  771. </summary>
  772. </member>
  773. <member name="T:SharpVectors.Renderers.Gdi.GdiGraphicsImpl.GdiGraphicsContainerImpl">
  774. <summary>
  775. Wraps a GraphicsContainer because it is sealed.
  776. This is a helper for GraphicsWrapper so that it can save
  777. multiple container states. It holds the containers
  778. for both the idMapGraphics and the main graphics
  779. being rendered in the GraphicsWrapper.
  780. </summary>
  781. </member>
  782. <member name="T:SharpVectors.Renderers.Gdi.GdiGraphicsListenerImpl.GdiGraphicsContainerImpl">
  783. <summary>
  784. Wraps a GraphicsContainer because it is sealed.
  785. This is a helper for GraphicsWrapper so that it can save
  786. multiple container states. It holds the containers
  787. for both the idMapGraphics and the main graphics
  788. being rendered in the GraphicsWrapper.
  789. </summary>
  790. </member>
  791. <member name="T:SharpVectors.Renderers.Gdi.GdiGraphicsWrapper">
  792. <summary>
  793. Wraps a Graphics object since it's sealed
  794. </summary>
  795. </member>
  796. <member name="T:SharpVectors.Renderers.Gdi.GdiGraphicsWrapper.GdiGraphicsContainerImpl">
  797. <summary>
  798. Wraps a GraphicsContainer because it is sealed.
  799. This is a helper for GraphicsWrapper so that it can save
  800. multiple container states. It holds the containers
  801. for both the idMapGraphics and the main graphics
  802. being rendered in the GraphicsWrapper.
  803. </summary>
  804. </member>
  805. <member name="F:SharpVectors.Renderers.Gdi.GdiHitTestHelperImpl._colorCounter">
  806. <summary>
  807. A counter that tracks the next hit color.
  808. </summary>
  809. </member>
  810. <member name="F:SharpVectors.Renderers.Gdi.GdiHitTestHelperImpl._colorMap">
  811. <summary>
  812. Maps a 'hit color' to a graphics node.
  813. </summary>
  814. <remarks>
  815. The 'hit color' is an integer identifier that identifies the graphics node that drew it.
  816. When 'hit colors' are drawn onto a bitmap (ie. <see cref="F:SharpVectors.Renderers.Gdi.GdiHitTestHelperImpl._idMapRaster">id-mapppe raster</see>
  817. the 'hit color' of each pixel with the help of <see cref="F:SharpVectors.Renderers.Gdi.GdiHitTestHelperImpl._colorMap">color map</see>
  818. can identify for a given x, y coordinate the relevant graphics node a mouse event should be dispatched to.
  819. </remarks>
  820. </member>
  821. <member name="F:SharpVectors.Renderers.Gdi.GdiHitTestHelperImpl._idMapRaster">
  822. <summary>
  823. A bitmap image that consists of 'hit color' instead of visual color. A 'hit color' is an
  824. integer identifier that identifies the graphics node that drew it. A 'hit color' can
  825. therefore identify the graphics node that corresponds an x-y coordinates.
  826. </summary>
  827. </member>
  828. <member name="P:SharpVectors.Renderers.Gdi.GdiHitTestHelperImpl.IdMapRaster">
  829. <summary>
  830. Gets the image map of the rendered Svg document. This
  831. is a picture of how the renderer will map the (x,y) positions
  832. of mouse events to objects. You can display this raster
  833. to help in debugging of hit testing.
  834. </summary>
  835. </member>
  836. <member name="M:SharpVectors.Renderers.Gdi.GdiHitTestHelperImpl.HitTest(System.Int32,System.Int32)">
  837. <summary>
  838. Returns the topmost object of a hit test by specifying a Point.
  839. </summary>
  840. <param name="pointX">The X-value of the point to hit test against.</param>
  841. <param name="pointY">The Y-value of the point to hit test against.</param>
  842. <returns>The hit test result of the renderer, returned as a <see cref="T:SharpVectors.Renderers.Gdi.GdiHitTestResult"/> type.</returns>
  843. </member>
  844. <member name="M:SharpVectors.Renderers.Gdi.GdiHitTestHelperImpl.GetNextHitColor(SharpVectors.Dom.Svg.SvgElement)">
  845. <summary>
  846. Allocate a hit color for the specified graphics node.
  847. </summary>
  848. <param name="element">
  849. The <see cref="T:SharpVectors.Dom.Svg.SvgElement">SvgElement</see> object for which to
  850. allocate a new hit color.
  851. </param>
  852. <returns>
  853. The hit color for the <see cref="T:SharpVectors.Dom.Svg.SvgElement">SvgElement</see>
  854. object.
  855. </returns>
  856. </member>
  857. <member name="M:SharpVectors.Renderers.Gdi.GdiHitTestHelperImpl.GetElementFromColor(System.Drawing.Color)">
  858. <summary>
  859. Gets the <see cref="T:SharpVectors.Dom.Svg.SvgElement">SvgElement</see> object that
  860. corresponds to the given hit color.
  861. </summary>
  862. <param name="color">
  863. The hit color for which to get the corresponding
  864. <see cref="T:SharpVectors.Dom.Svg.SvgElement">SvgElement</see> object.
  865. </param>
  866. <remarks>
  867. Returns <c>null</c> if a corresponding
  868. <see cref="T:SharpVectors.Dom.Svg.SvgElement">SvgElement</see> object cannot be
  869. found for the given hit color.
  870. </remarks>
  871. <returns>
  872. The <see cref="T:SharpVectors.Dom.Svg.SvgElement">SvgElement</see> object that
  873. corresponds to the given hit color
  874. </returns>
  875. </member>
  876. <member name="M:SharpVectors.Renderers.Gdi.GdiHitTestHelperImpl.ColorToId(System.Drawing.Color)">
  877. <summary>
  878. TODO: This method is not used.
  879. </summary>
  880. <param name="color">
  881. </param>
  882. <returns>
  883. </returns>
  884. </member>
  885. </members>
  886. </doc>