SharpVectors.Converters.Wpf.xml 184 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>SharpVectors.Converters.Wpf</name>
  5. </assembly>
  6. <members>
  7. <member name="T:SharpVectors.Converters.DirectorySvgConverter">
  8. <summary>
  9. This converts a directory (and optionally the sub-directories) of SVG files to XAML files in a specified directory,
  10. maintaining the original directory structure.
  11. <para>
  12. It uses <see cref="T:SharpVectors.Converters.FileSvgConverter"/> or <see cref="T:SharpVectors.Converters.ImageSvgConverter"/> converter to process each SVG file
  13. in the specified directory.
  14. </para>
  15. </summary>
  16. </member>
  17. <member name="M:SharpVectors.Converters.DirectorySvgConverter.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  18. <summary>
  19. Initializes a new instance of the <see cref="T:SharpVectors.Renderers.Wpf.WpfDrawingSettings"/>
  20. class with the specified drawing or rendering settings.
  21. </summary>
  22. <param name="settings">
  23. This specifies the settings used by the rendering or drawing engine.
  24. If this is <see langword="null"/>, the default settings is used.
  25. </param>
  26. </member>
  27. <member name="P:SharpVectors.Converters.DirectorySvgConverter.Recursive">
  28. <summary>
  29. Gets or sets a value indicating whether the directory copying is
  30. recursive, that is includes the sub-directories.
  31. </summary>
  32. <value>
  33. This property is <see langword="true"/> if the sub-directories are
  34. included in the directory copy; otherwise, it is <see langword="false"/>.
  35. The default is <see langword="true"/>.
  36. </value>
  37. </member>
  38. <member name="P:SharpVectors.Converters.DirectorySvgConverter.Overwrite">
  39. <summary>
  40. Gets or sets a value indicating whether an existing file is overwritten.
  41. </summary>
  42. <value>
  43. This property is <see langword="true"/> if existing file is overwritten;
  44. otherwise, it is <see langword="false"/>. The default is <see langword="true"/>.
  45. </value>
  46. </member>
  47. <member name="P:SharpVectors.Converters.DirectorySvgConverter.IncludeSecurity">
  48. <summary>
  49. Gets or sets a value indicating whether the security settings of the
  50. copied file is retained.
  51. </summary>
  52. <value>
  53. This property is <see langword="true"/> if the security settings of the
  54. file is also copied; otherwise, it is <see langword="false"/>. The
  55. default is <see langword="false"/>.
  56. </value>
  57. </member>
  58. <member name="P:SharpVectors.Converters.DirectorySvgConverter.IncludeHidden">
  59. <summary>
  60. Gets or sets a value indicating whether the copy operation includes
  61. hidden directories and files.
  62. </summary>
  63. <value>
  64. This property is <see langword="true"/> if hidden directories and files
  65. are included in the copy operation; otherwise, it is
  66. <see langword="false"/>. The default is <see langword="false"/>.
  67. </value>
  68. </member>
  69. <member name="P:SharpVectors.Converters.DirectorySvgConverter.WriterErrorOccurred">
  70. <summary>
  71. Gets a value indicating whether a writer error occurred when
  72. using the custom XAML writer.
  73. </summary>
  74. <value>
  75. This is <see langword="true"/> if an error occurred when using
  76. the custom XAML writer; otherwise, it is <see langword="false"/>.
  77. </value>
  78. </member>
  79. <member name="P:SharpVectors.Converters.DirectorySvgConverter.FallbackOnWriterError">
  80. <summary>
  81. Gets or sets a value indicating whether to fall back and use
  82. the .NET Framework XAML writer when an error occurred in using the
  83. custom writer.
  84. </summary>
  85. <value>
  86. This is <see langword="true"/> if the converter falls back to using
  87. the system XAML writer when an error occurred in using the custom
  88. writer; otherwise, it is <see langword="false"/>. If <see langword="false"/>,
  89. an exception, which occurred in using the custom writer will be
  90. thrown. The default is <see langword="false"/>.
  91. </value>
  92. </member>
  93. <member name="P:SharpVectors.Converters.DirectorySvgConverter.SourceDir">
  94. <summary>
  95. Gets the source directory of the SVG files to be converted.
  96. </summary>
  97. <value>
  98. A <see cref="T:System.IO.DirectoryInfo"/> specifying the source directory of
  99. the SVG files.
  100. </value>
  101. </member>
  102. <member name="P:SharpVectors.Converters.DirectorySvgConverter.DestinationDir">
  103. <summary>
  104. Gets the destination directory of the converted XAML files.
  105. </summary>
  106. <value>
  107. A <see cref="T:System.IO.DirectoryInfo"/> specifying the destination directory of
  108. the converted XAML files.
  109. </value>
  110. </member>
  111. <member name="P:SharpVectors.Converters.DirectorySvgConverter.ErrorFile">
  112. <summary>
  113. Gets the full path of the last SVG file not successfully converted.
  114. </summary>
  115. <value>
  116. A string containing the full path of the last SVG file not
  117. successfully converted to the XAML
  118. </value>
  119. <remarks>
  120. Whenever an error occurred in the conversion of a file, the
  121. conversion process will stop. Use this property to retrieve the full
  122. path of the SVG file causing the error.
  123. </remarks>
  124. </member>
  125. <member name="P:SharpVectors.Converters.DirectorySvgConverter.SaveImage">
  126. <summary>
  127. Gets or sets a value indicating whether to save static or bitmap image output.
  128. </summary>
  129. <value>
  130. This is <see langword="true"/> if the conversion saves static or bitmap image file; otherwise,
  131. it is <see langword="false"/>. The default value is <see langword="false"/>.
  132. </value>
  133. </member>
  134. <member name="P:SharpVectors.Converters.DirectorySvgConverter.EncoderType">
  135. <summary>
  136. Gets or set the bitmap encoder type to use in encoding the drawing
  137. to an image file.
  138. </summary>
  139. <value>
  140. An enumeration of the type <see cref="T:SharpVectors.Converters.ImageEncoderType"/> specifying
  141. the bitmap encoder. The default is the <see cref="F:SharpVectors.Converters.ImageEncoderType.PngBitmap"/>.
  142. </value>
  143. </member>
  144. <member name="P:SharpVectors.Converters.DirectorySvgConverter.Encoder">
  145. <summary>
  146. Gets or sets a custom bitmap encoder to use in encoding the drawing
  147. to an image file.
  148. </summary>
  149. <value>
  150. A derived <see cref="T:System.Windows.Media.Imaging.BitmapEncoder"/> object specifying the bitmap
  151. encoder for encoding the images. The default is <see langword="null"/>,
  152. and the <see cref="P:SharpVectors.Converters.DirectorySvgConverter.EncoderType"/> property determines the encoder used.
  153. </value>
  154. <remarks>
  155. If the value of this is set, it must match the MIME type or file
  156. extension defined by the <see cref="P:SharpVectors.Converters.DirectorySvgConverter.EncoderType"/> property for it
  157. to be used.
  158. </remarks>
  159. </member>
  160. <member name="M:SharpVectors.Converters.DirectorySvgConverter.Convert(System.IO.DirectoryInfo,System.IO.DirectoryInfo)">
  161. <summary>
  162. Convert the SVG files in the specified source directory, saving the
  163. results in the specified destination directory.
  164. </summary>
  165. <param name="sourceInfo">
  166. A <see cref="T:System.IO.DirectoryInfo"/> specifying the source directory of
  167. the SVG files.
  168. </param>
  169. <param name="destInfo">
  170. A <see cref="T:System.IO.DirectoryInfo"/> specifying the source directory of
  171. the SVG files.
  172. </param>
  173. <exception cref="T:System.ArgumentNullException">
  174. <para>
  175. If the <paramref name="sourceInfo"/> is <see langword="null"/>.
  176. </para>
  177. <para>
  178. -or-
  179. </para>
  180. <para>
  181. If the <paramref name="destInfo"/> is <see langword="null"/>.
  182. </para>
  183. </exception>
  184. <exception cref="T:System.ArgumentException">
  185. If the directory specified by <paramref name="sourceInfo"/> does not
  186. exists.
  187. </exception>
  188. </member>
  189. <member name="T:SharpVectors.Converters.FileSvgConverter">
  190. <summary>
  191. <para>
  192. This converts an SVG file to the corresponding XAML file, which can be viewed in WPF application.
  193. </para>
  194. <para>The root object in the converted file is <see cref="T:System.Windows.Media.DrawingGroup"/>.</para>
  195. </summary>
  196. </member>
  197. <member name="F:SharpVectors.Converters.FileSvgConverter._drawing">
  198. <summary>
  199. This is the last drawing generated.
  200. </summary>
  201. </member>
  202. <member name="M:SharpVectors.Converters.FileSvgConverter.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  203. <overloads>
  204. Initializes a new instance of the <see cref="T:SharpVectors.Converters.FileSvgConverter"/> class.
  205. </overloads>
  206. <summary>
  207. Initializes a new instance of the <see cref="T:SharpVectors.Converters.FileSvgConverter"/> class
  208. with the specified drawing or rendering settings.
  209. </summary>
  210. <param name="settings">
  211. This specifies the settings used by the rendering or drawing engine.
  212. If this is <see langword="null"/>, the default settings is used.
  213. </param>
  214. </member>
  215. <member name="M:SharpVectors.Converters.FileSvgConverter.#ctor(System.Boolean,System.Boolean,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  216. <summary>
  217. Initializes a new instance of the <see cref="T:SharpVectors.Converters.FileSvgConverter"/> class
  218. with the specified drawing or rendering settings and the saving options.
  219. </summary>
  220. <param name="saveXaml">
  221. This specifies whether to save result object tree in XAML file.
  222. </param>
  223. <param name="saveZaml">
  224. This specifies whether to save result object tree in ZAML file. The
  225. ZAML is simply a G-Zip compressed XAML format, similar to the SVGZ.
  226. </param>
  227. <param name="settings">
  228. This specifies the settings used by the rendering or drawing engine.
  229. If this is <see langword="null"/>, the default settings is used.
  230. </param>
  231. </member>
  232. <member name="P:SharpVectors.Converters.FileSvgConverter.WriterErrorOccurred">
  233. <summary>
  234. Gets a value indicating whether a writer error occurred when
  235. using the custom XAML writer.
  236. </summary>
  237. <value>
  238. This is <see langword="true"/> if an error occurred when using
  239. the custom XAML writer; otherwise, it is <see langword="false"/>.
  240. </value>
  241. </member>
  242. <member name="P:SharpVectors.Converters.FileSvgConverter.FallbackOnWriterError">
  243. <summary>
  244. Gets or sets a value indicating whether to fall back and use
  245. the .NET Framework XAML writer when an error occurred in using the
  246. custom writer.
  247. </summary>
  248. <value>
  249. This is <see langword="true"/> if the converter falls back to using
  250. the system XAML writer when an error occurred in using the custom
  251. writer; otherwise, it is <see langword="false"/>. If <see langword="false"/>,
  252. an exception, which occurred in using the custom writer will be
  253. thrown. The default is <see langword="false"/>.
  254. </value>
  255. </member>
  256. <member name="P:SharpVectors.Converters.FileSvgConverter.Drawing">
  257. <summary>
  258. Gets the last created drawing.
  259. </summary>
  260. <value>
  261. A <see cref="T:System.Windows.Media.DrawingGroup"/> specifying the last converted drawing.
  262. </value>
  263. </member>
  264. <member name="P:SharpVectors.Converters.FileSvgConverter.XamlFile">
  265. <summary>
  266. Gets the output XAML file path if generated.
  267. </summary>
  268. <value>
  269. A string containing the full path to the XAML if generated; otherwise,
  270. it is <see langword="null"/>.
  271. </value>
  272. </member>
  273. <member name="P:SharpVectors.Converters.FileSvgConverter.ZamlFile">
  274. <summary>
  275. Gets the output ZAML file path if generated.
  276. </summary>
  277. <value>
  278. A string containing the full path to the ZAML if generated; otherwise,
  279. it is <see langword="null"/>.
  280. </value>
  281. </member>
  282. <member name="M:SharpVectors.Converters.FileSvgConverter.Convert(System.String)">
  283. <overloads>
  284. This performs the conversion of the specified SVG file, and saves
  285. the output to an XAML file.
  286. </overloads>
  287. <summary>
  288. This performs the conversion of the specified SVG file, and saves
  289. the output to an XAML file with the same file name.
  290. </summary>
  291. <param name="svgFileName">
  292. The full path of the SVG source file.
  293. </param>
  294. <returns>
  295. This returns <see langword="true"/> if the conversion is successful;
  296. otherwise, it return <see langword="false"/>.
  297. </returns>
  298. <exception cref="T:System.ArgumentNullException">
  299. If the <paramref name="svgFileName"/> is <see langword="null"/>.
  300. </exception>
  301. <exception cref="T:System.ArgumentException">
  302. If the <paramref name="svgFileName"/> is empty.
  303. <para>-or-</para>
  304. If the <paramref name="svgFileName"/> does not exists.
  305. </exception>
  306. </member>
  307. <member name="M:SharpVectors.Converters.FileSvgConverter.Convert(System.String,System.String)">
  308. <summary>
  309. This performs the conversion of the specified SVG file, and saves
  310. the output to the specified XAML file.
  311. </summary>
  312. <param name="svgFileName">
  313. The full path of the SVG source file.
  314. </param>
  315. <param name="xamlFileName">
  316. The output XAML file. This is optional. If not specified, an XAML
  317. file is created in the same directory as the SVG file.
  318. </param>
  319. <returns>
  320. This returns <see langword="true"/> if the conversion is successful;
  321. otherwise, it return <see langword="false"/>.
  322. </returns>
  323. <exception cref="T:System.ArgumentNullException">
  324. If the <paramref name="svgFileName"/> is <see langword="null"/>.
  325. </exception>
  326. <exception cref="T:System.ArgumentException">
  327. If the <paramref name="svgFileName"/> is empty.
  328. <para>-or-</para>
  329. If the <paramref name="svgFileName"/> does not exists.
  330. </exception>
  331. </member>
  332. <member name="M:SharpVectors.Converters.FileSvgConverter.Convert(System.IO.Stream,System.String)">
  333. <summary>
  334. This performs the conversion of the specified SVG source, and saves
  335. the output to the specified XAML file.
  336. </summary>
  337. <param name="svgStream">
  338. A stream providing access to the SVG source data.
  339. </param>
  340. <param name="xamlFileName">
  341. The output XAML file. This is optional. If not specified, an XAML
  342. file is created in the same directory as the SVG file.
  343. </param>
  344. <returns>
  345. This returns <see langword="true"/> if the conversion is successful;
  346. otherwise, it return <see langword="false"/>.
  347. </returns>
  348. <exception cref="T:System.ArgumentNullException">
  349. If the <paramref name="xamlFileName"/> is <see langword="null"/>.
  350. <para>-or-</para>
  351. If the <paramref name="svgStream"/> is <see langword="null"/>.
  352. </exception>
  353. <exception cref="T:System.ArgumentException">
  354. If the <paramref name="xamlFileName"/> is empty.
  355. </exception>
  356. </member>
  357. <member name="M:SharpVectors.Converters.FileSvgConverter.Convert(System.IO.TextReader,System.String)">
  358. <summary>
  359. This performs the conversion of the specified SVG source, and saves
  360. the output to the specified XAML file.
  361. </summary>
  362. <param name="svgTextReader">
  363. A text reader providing access to the SVG source data.
  364. </param>
  365. <param name="xamlFileName">
  366. The output XAML file. This is optional. If not specified, an XAML
  367. file is created in the same directory as the SVG file.
  368. </param>
  369. <returns>
  370. This returns <see langword="true"/> if the conversion is successful;
  371. otherwise, it return <see langword="false"/>.
  372. </returns>
  373. <exception cref="T:System.ArgumentNullException">
  374. If the <paramref name="xamlFileName"/> is <see langword="null"/>.
  375. <para>-or-</para>
  376. If the <paramref name="svgTextReader"/> is <see langword="null"/>.
  377. </exception>
  378. <exception cref="T:System.ArgumentException">
  379. If the <paramref name="xamlFileName"/> is empty.
  380. </exception>
  381. </member>
  382. <member name="M:SharpVectors.Converters.FileSvgConverter.Convert(System.Xml.XmlReader,System.String)">
  383. <summary>
  384. This performs the conversion of the specified SVG source, and saves
  385. the output to the specified XAML file.
  386. </summary>
  387. <param name="svgXmlReader">
  388. An XML reader providing access to the SVG source data.
  389. </param>
  390. <param name="xamlFileName">
  391. The output XAML file. This is optional. If not specified, an XAML
  392. file is created in the same directory as the SVG file.
  393. </param>
  394. <returns>
  395. This returns <see langword="true"/> if the conversion is successful;
  396. otherwise, it return <see langword="false"/>.
  397. </returns>
  398. <exception cref="T:System.ArgumentNullException">
  399. If the <paramref name="xamlFileName"/> is <see langword="null"/>.
  400. <para>-or-</para>
  401. If the <paramref name="svgXmlReader"/> is <see langword="null"/>.
  402. </exception>
  403. <exception cref="T:System.ArgumentException">
  404. If the <paramref name="xamlFileName"/> is empty.
  405. </exception>
  406. </member>
  407. <member name="T:SharpVectors.Converters.FileSvgReader">
  408. <summary>
  409. This converts a SVG file to <see cref="T:System.Windows.Media.DrawingGroup"/> object, and can
  410. optionally save the result to a file as XAML.
  411. </summary>
  412. </member>
  413. <member name="F:SharpVectors.Converters.FileSvgReader._drawing">
  414. <summary>
  415. This is the last drawing generated.
  416. </summary>
  417. </member>
  418. <member name="M:SharpVectors.Converters.FileSvgReader.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings,System.Boolean)">
  419. <overloads>
  420. Initializes a new instance of the <see cref="T:SharpVectors.Converters.FileSvgReader"/> class.
  421. </overloads>
  422. <summary>
  423. Initializes a new instance of the <see cref="T:SharpVectors.Converters.FileSvgReader"/> class
  424. with the specified drawing or rendering settings.
  425. </summary>
  426. <param name="settings">
  427. This specifies the settings used by the rendering or drawing engine.
  428. If this is <see langword="null"/>, the default settings is used.
  429. </param>
  430. <param name="isEmbedded">A value indicating whether this converter is embedded or not.</param>
  431. </member>
  432. <member name="M:SharpVectors.Converters.FileSvgReader.#ctor(System.Boolean,System.Boolean,System.IO.DirectoryInfo,SharpVectors.Renderers.Wpf.WpfDrawingSettings,System.Boolean)">
  433. <summary>
  434. Initializes a new instance of the <see cref="T:SharpVectors.Converters.FileSvgConverter"/> class
  435. with the specified drawing or rendering settings, the saving options
  436. and the working directory.
  437. </summary>
  438. <param name="saveXaml">
  439. This specifies whether to save result object tree in XAML file.
  440. </param>
  441. <param name="saveZaml">
  442. This specifies whether to save result object tree in ZAML file. The
  443. ZAML is simply a G-Zip compressed XAML format, similar to the SVGZ.
  444. </param>
  445. <param name="workingDir">
  446. The working directory, where converted outputs are saved.
  447. </param>
  448. <param name="settings">
  449. This specifies the settings used by the rendering or drawing engine.
  450. If this is <see langword="null"/>, the default settings is used.
  451. </param>
  452. </member>
  453. <member name="P:SharpVectors.Converters.FileSvgReader.WriterErrorOccurred">
  454. <summary>
  455. Gets a value indicating whether a writer error occurred when
  456. using the custom XAML writer.
  457. </summary>
  458. <value>
  459. This is <see langword="true"/> if an error occurred when using
  460. the custom XAML writer; otherwise, it is <see langword="false"/>.
  461. </value>
  462. </member>
  463. <member name="P:SharpVectors.Converters.FileSvgReader.FallbackOnWriterError">
  464. <summary>
  465. Gets or sets a value indicating whether to fall back and use
  466. the .NET Framework XAML writer when an error occurred in using the
  467. custom writer.
  468. </summary>
  469. <value>
  470. This is <see langword="true"/> if the converter falls back to using
  471. the system XAML writer when an error occurred in using the custom
  472. writer; otherwise, it is <see langword="false"/>. If <see langword="false"/>,
  473. an exception, which occurred in using the custom writer will be
  474. thrown. The default is <see langword="false"/>.
  475. </value>
  476. </member>
  477. <member name="P:SharpVectors.Converters.FileSvgReader.ImageFile">
  478. <summary>
  479. Gets the output image file path if generated.
  480. </summary>
  481. <value>
  482. A string containing the full path to the image if generated; otherwise,
  483. it is <see langword="null"/>.
  484. </value>
  485. </member>
  486. <member name="P:SharpVectors.Converters.FileSvgReader.XamlFile">
  487. <summary>
  488. Gets the output XAML file path if generated.
  489. </summary>
  490. <value>
  491. A string containing the full path to the XAML if generated; otherwise,
  492. it is <see langword="null"/>.
  493. </value>
  494. </member>
  495. <member name="P:SharpVectors.Converters.FileSvgReader.ZamlFile">
  496. <summary>
  497. Gets the output ZAML file path if generated.
  498. </summary>
  499. <value>
  500. A string containing the full path to the ZAML if generated; otherwise,
  501. it is <see langword="null"/>.
  502. </value>
  503. </member>
  504. <member name="P:SharpVectors.Converters.FileSvgReader.Drawing">
  505. <summary>
  506. Gets or sets the last created drawing.
  507. </summary>
  508. <value>
  509. A <see cref="T:System.Windows.Media.DrawingGroup"/> specifying the last converted drawing.
  510. </value>
  511. </member>
  512. <member name="M:SharpVectors.Converters.FileSvgReader.Read(System.String)">
  513. <overloads>
  514. Reads in the specified SVG file and converts it to WPF drawing.
  515. </overloads>
  516. <summary>
  517. Reads in the specified SVG file and converts it to WPF drawing.
  518. </summary>
  519. <param name="svgFileName">
  520. The full path of the SVG source file.
  521. </param>
  522. <returns>
  523. This returns the <see cref="T:System.Windows.Media.DrawingGroup"/> representing the SVG file,
  524. if successful; otherwise, it returns <see langword="null"/>.
  525. </returns>
  526. <exception cref="T:System.ArgumentNullException">
  527. If the <paramref name="svgFileName"/> is <see langword="null"/>.
  528. </exception>
  529. <exception cref="T:System.ArgumentException">
  530. If the <paramref name="svgFileName"/> is empty.
  531. <para>-or-</para>
  532. If the <paramref name="svgFileName"/> does not exists.
  533. </exception>
  534. </member>
  535. <member name="M:SharpVectors.Converters.FileSvgReader.Read(System.Uri)">
  536. <summary>
  537. Reads in the specified SVG file and converts it to WPF drawing.
  538. </summary>
  539. <param name="svgUri">
  540. A <see cref="T:System.Uri"/> specifying the path to the SVG file.
  541. </param>
  542. <returns>
  543. This returns the <see cref="T:System.Windows.Media.DrawingGroup"/> representing the SVG file,
  544. if successful; otherwise, it returns <see langword="null"/>.
  545. </returns>
  546. <exception cref="T:System.ArgumentNullException">
  547. If the <paramref name="svgUri"/> is <see langword="null"/>.
  548. </exception>
  549. </member>
  550. <member name="M:SharpVectors.Converters.FileSvgReader.Read(System.IO.Stream)">
  551. <summary>
  552. Reads in the specified SVG file stream and converts it to WPF drawing.
  553. </summary>
  554. <param name="svgStream">The source SVG file stream.</param>
  555. <returns>
  556. This returns the <see cref="T:System.Windows.Media.DrawingGroup"/> representing the SVG file,
  557. if successful; otherwise, it returns <see langword="null"/>.
  558. </returns>
  559. <exception cref="T:System.ArgumentNullException">
  560. If the <paramref name="svgStream"/> is <see langword="null"/>.
  561. </exception>
  562. </member>
  563. <member name="M:SharpVectors.Converters.FileSvgReader.Read(System.IO.TextReader)">
  564. <summary>
  565. Reads in the specified source from the SVG file reader and converts
  566. it to WPF drawing.
  567. </summary>
  568. <param name="svgTextReader">
  569. A text reader providing access to the SVG file data.
  570. </param>
  571. <returns>
  572. This returns the <see cref="T:System.Windows.Media.DrawingGroup"/> representing the SVG file,
  573. if successful; otherwise, it returns <see langword="null"/>.
  574. </returns>
  575. <exception cref="T:System.ArgumentNullException">
  576. If the <paramref name="svgTextReader"/> is <see langword="null"/>.
  577. </exception>
  578. </member>
  579. <member name="M:SharpVectors.Converters.FileSvgReader.Read(System.Xml.XmlReader)">
  580. <summary>
  581. Reads in the specified source SVG file reader and converts it to
  582. WPF drawing.
  583. </summary>
  584. <param name="svgXmlReader">
  585. An XML reader providing access to the SVG file data.
  586. </param>
  587. <returns>
  588. This returns the <see cref="T:System.Windows.Media.DrawingGroup"/> representing the SVG file,
  589. if successful; otherwise, it returns <see langword="null"/>.
  590. </returns>
  591. <exception cref="T:System.ArgumentNullException">
  592. If the <paramref name="svgXmlReader"/> is <see langword="null"/>.
  593. </exception>
  594. </member>
  595. <member name="M:SharpVectors.Converters.FileSvgReader.Read(System.String,System.IO.DirectoryInfo)">
  596. <summary>
  597. Reads in the specified SVG file, converting it to WPF drawing and
  598. saving the results to the specified directory if successful.
  599. </summary>
  600. <param name="svgFileName">
  601. The full path of the SVG source file.
  602. </param>
  603. <param name="destinationDir">
  604. The destination of the output XAML file, if the saving properties
  605. are enabled.
  606. </param>
  607. <returns>
  608. This returns the <see cref="T:System.Windows.Media.DrawingGroup"/> representing the SVG file,
  609. if successful; otherwise, it returns <see langword="null"/>.
  610. </returns>
  611. <exception cref="T:System.ArgumentNullException">
  612. If the <paramref name="svgFileName"/> is <see langword="null"/>.
  613. </exception>
  614. <exception cref="T:System.ArgumentException">
  615. If the <paramref name="svgFileName"/> is empty.
  616. <para>-or-</para>
  617. If the <paramref name="svgFileName"/> does not exists.
  618. </exception>
  619. </member>
  620. <member name="M:SharpVectors.Converters.FileSvgReader.Save(System.String,System.Boolean,System.Boolean)">
  621. <summary>
  622. Saves the last converted file to the specified file name.
  623. </summary>
  624. <param name="fileName">
  625. The full path of the output file.
  626. </param>
  627. <param name="asXaml">
  628. A value indicating whether to save the output to XAML file.
  629. </param>
  630. <param name="asZaml">
  631. A value indicating whether to save the output to ZAML file, which
  632. is a G-zip compression of the XAML file.
  633. </param>
  634. <returns>
  635. This returns <see langword="true"/> if either <paramref name="asXaml"/>
  636. or <paramref name="asZaml"/> is <see langword="true"/> and the operation
  637. is successful.
  638. </returns>
  639. <remarks>
  640. <para>
  641. If the output serialization properties are not enabled, this method
  642. can be used to save the output to a file.
  643. </para>
  644. <para>
  645. This will not change the output serialization properties of this object.
  646. </para>
  647. </remarks>
  648. <exception cref="T:System.InvalidOperationException">
  649. If there is no converted drawing from a previous conversion process
  650. to be saved.
  651. </exception>
  652. </member>
  653. <member name="M:SharpVectors.Converters.FileSvgReader.Dispose(System.Boolean)">
  654. <summary>
  655. This releases the unmanaged resources used by the <see cref="T:SharpVectors.Converters.SvgConverter"/>
  656. and optionally releases the managed resources.
  657. </summary>
  658. <param name="disposing">
  659. This is <see langword="true"/> if managed resources should be
  660. disposed; otherwise, <see langword="false"/>.
  661. </param>
  662. </member>
  663. <member name="T:SharpVectors.Converters.ImageEncoderType">
  664. <summary>
  665. <para>
  666. This specifies the encoder type used to encode a collection of
  667. bitmap frame objects to an image stream.
  668. </para>
  669. <para>
  670. This is used by the <see cref="T:SharpVectors.Converters.ImageSvgConverter"/> converter.
  671. </para>
  672. </summary>
  673. <seealso cref="T:SharpVectors.Converters.ImageSvgConverter"/>
  674. </member>
  675. <member name="F:SharpVectors.Converters.ImageEncoderType.BmpBitmap">
  676. <summary>
  677. Specifies an encoder that is used to encode bitmap (BMP)
  678. format images, that is
  679. <see cref="T:System.Windows.Media.Imaging.BmpBitmapEncoder"/>.
  680. </summary>
  681. </member>
  682. <member name="F:SharpVectors.Converters.ImageEncoderType.GifBitmap">
  683. <summary>
  684. Specifies an encoder that is used to encode Graphics Interchange
  685. Format (GIF) images, that is
  686. <see cref="T:System.Windows.Media.Imaging.GifBitmapEncoder"/>.
  687. </summary>
  688. </member>
  689. <member name="F:SharpVectors.Converters.ImageEncoderType.JpegBitmap">
  690. <summary>
  691. Specifies an encoder that is used to encode Joint Photographics
  692. Experts Group (JPEG) format images, that is
  693. <see cref="T:System.Windows.Media.Imaging.JpegBitmapEncoder"/>.
  694. </summary>
  695. </member>
  696. <member name="F:SharpVectors.Converters.ImageEncoderType.PngBitmap">
  697. <summary>
  698. Specifies an encoder that is used to encode Portable Network
  699. Graphics (PNG) format images, that is
  700. <see cref="T:System.Windows.Media.Imaging.PngBitmapEncoder"/>.
  701. </summary>
  702. </member>
  703. <member name="F:SharpVectors.Converters.ImageEncoderType.TiffBitmap">
  704. <summary>
  705. Specifies an encoder that is used to encode Tagged Image File
  706. Format (TIFF) images, that is
  707. <see cref="T:System.Windows.Media.Imaging.TiffBitmapEncoder"/>.
  708. </summary>
  709. </member>
  710. <member name="F:SharpVectors.Converters.ImageEncoderType.WmpBitmap">
  711. <summary>
  712. Specifies an encoder that is used to Microsoft Windows Media Photo
  713. (WDP) images, that is
  714. <see cref="T:System.Windows.Media.Imaging.WmpBitmapEncoder"/>.
  715. </summary>
  716. </member>
  717. <member name="T:SharpVectors.Converters.ImageSvgConverter">
  718. <summary>
  719. This converts the SVG file to static or bitmap image, which is saved to a file.
  720. </summary>
  721. <remarks>
  722. <para>
  723. The image is save with the <see cref="P:System.Windows.Media.PixelFormats.Pbgra32"/> format,
  724. since that is the only pixel format which does not throw an exception
  725. with the <see cref="T:System.Windows.Media.Imaging.RenderTargetBitmap"/>.
  726. </para>
  727. <para>
  728. The DPI used is 96.
  729. </para>
  730. </remarks>
  731. </member>
  732. <member name="F:SharpVectors.Converters.ImageSvgConverter._drawing">
  733. <summary>
  734. This is the last drawing generated.
  735. </summary>
  736. </member>
  737. <member name="M:SharpVectors.Converters.ImageSvgConverter.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  738. <overloads>
  739. Initializes a new instance of the <see cref="T:SharpVectors.Converters.ImageSvgConverter"/> class.
  740. </overloads>
  741. <summary>
  742. Initializes a new instance of the <see cref="T:SharpVectors.Converters.ImageSvgConverter"/> class
  743. with the specified drawing or rendering settings.
  744. </summary>
  745. <param name="settings">
  746. This specifies the settings used by the rendering or drawing engine.
  747. If this is <see langword="null"/>, the default settings is used.
  748. </param>
  749. </member>
  750. <member name="M:SharpVectors.Converters.ImageSvgConverter.#ctor(System.Boolean,System.Boolean,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  751. <summary>
  752. Initializes a new instance of the <see cref="T:SharpVectors.Converters.ImageSvgConverter"/> class
  753. with the specified drawing or rendering settings and the saving options.
  754. </summary>
  755. <param name="saveXaml">
  756. This specifies whether to save result object tree in image file.
  757. </param>
  758. <param name="saveZaml">
  759. This specifies whether to save result object tree in ZAML file. The
  760. ZAML is simply a G-Zip compressed image format, similar to the SVGZ.
  761. </param>
  762. <param name="settings">
  763. This specifies the settings used by the rendering or drawing engine.
  764. If this is <see langword="null"/>, the default settings is used.
  765. </param>
  766. </member>
  767. <member name="P:SharpVectors.Converters.ImageSvgConverter.WriterErrorOccurred">
  768. <summary>
  769. Gets a value indicating whether a writer error occurred when
  770. using the custom image writer.
  771. </summary>
  772. <value>
  773. This is <see langword="true"/> if an error occurred when using
  774. the custom image writer; otherwise, it is <see langword="false"/>.
  775. </value>
  776. </member>
  777. <member name="P:SharpVectors.Converters.ImageSvgConverter.FallbackOnWriterError">
  778. <summary>
  779. Gets or sets a value indicating whether to fall back and use
  780. the .NET Framework image writer when an error occurred in using the
  781. custom writer.
  782. </summary>
  783. <value>
  784. This is <see langword="true"/> if the converter falls back to using
  785. the system image writer when an error occurred in using the custom
  786. writer; otherwise, it is <see langword="false"/>. If <see langword="false"/>,
  787. an exception, which occurred in using the custom writer will be
  788. thrown. The default is <see langword="false"/>.
  789. </value>
  790. </member>
  791. <member name="P:SharpVectors.Converters.ImageSvgConverter.EncoderType">
  792. <summary>
  793. Gets or set the bitmap encoder type to use in encoding the drawing
  794. to an image file.
  795. </summary>
  796. <value>
  797. An enumeration of the type <see cref="T:SharpVectors.Converters.ImageEncoderType"/> specifying
  798. the bitmap encoder. The default is the <see cref="F:SharpVectors.Converters.ImageEncoderType.PngBitmap"/>.
  799. </value>
  800. </member>
  801. <member name="P:SharpVectors.Converters.ImageSvgConverter.Encoder">
  802. <summary>
  803. Gets or sets a custom bitmap encoder to use in encoding the drawing
  804. to an image file.
  805. </summary>
  806. <value>
  807. A derived <see cref="T:System.Windows.Media.Imaging.BitmapEncoder"/> object specifying the bitmap
  808. encoder for encoding the images. The default is <see langword="null"/>,
  809. and the <see cref="P:SharpVectors.Converters.ImageSvgConverter.EncoderType"/> property determines the encoder used.
  810. </value>
  811. <remarks>
  812. If the value of this is set, it must match the MIME type or file
  813. extension defined by the <see cref="P:SharpVectors.Converters.ImageSvgConverter.EncoderType"/> property for it
  814. to be used.
  815. </remarks>
  816. </member>
  817. <member name="P:SharpVectors.Converters.ImageSvgConverter.Drawing">
  818. <summary>
  819. Gets the last created drawing.
  820. </summary>
  821. <value>
  822. A <see cref="T:System.Windows.Media.DrawingGroup"/> specifying the last converted drawing.
  823. </value>
  824. </member>
  825. <member name="P:SharpVectors.Converters.ImageSvgConverter.XamlFile">
  826. <summary>
  827. Gets the output XAML file path if generated.
  828. </summary>
  829. <value>
  830. A string containing the full path to the XAML if generated; otherwise,
  831. it is <see langword="null"/>.
  832. </value>
  833. </member>
  834. <member name="P:SharpVectors.Converters.ImageSvgConverter.ZamlFile">
  835. <summary>
  836. Gets the output ZAML file path if generated.
  837. </summary>
  838. <value>
  839. A string containing the full path to the ZAML if generated; otherwise,
  840. it is <see langword="null"/>.
  841. </value>
  842. </member>
  843. <member name="M:SharpVectors.Converters.ImageSvgConverter.Convert(System.String)">
  844. <overloads>
  845. This performs the conversion of the specified SVG file, and saves
  846. the output to an image file.
  847. </overloads>
  848. <summary>
  849. This performs the conversion of the specified SVG file, and saves
  850. the output to an image file with the same file name.
  851. </summary>
  852. <param name="svgFileName">
  853. The full path of the SVG source file.
  854. </param>
  855. <returns>
  856. This returns <see langword="true"/> if the conversion is successful;
  857. otherwise, it return <see langword="false"/>.
  858. </returns>
  859. <exception cref="T:System.ArgumentNullException">
  860. If the <paramref name="svgFileName"/> is <see langword="null"/>.
  861. </exception>
  862. <exception cref="T:System.ArgumentException">
  863. If the <paramref name="svgFileName"/> is empty.
  864. <para>-or-</para>
  865. If the <paramref name="svgFileName"/> does not exists.
  866. </exception>
  867. </member>
  868. <member name="M:SharpVectors.Converters.ImageSvgConverter.Convert(System.String,System.String)">
  869. <summary>
  870. This performs the conversion of the specified SVG file, and saves
  871. the output to the specified image file.
  872. </summary>
  873. <param name="svgFileName">
  874. The full path of the SVG source file.
  875. </param>
  876. <param name="imageFileName">
  877. The output image file. This is optional. If not specified, an image
  878. file is created in the same directory as the SVG file.
  879. </param>
  880. <returns>
  881. This returns <see langword="true"/> if the conversion is successful;
  882. otherwise, it return <see langword="false"/>.
  883. </returns>
  884. <exception cref="T:System.ArgumentNullException">
  885. If the <paramref name="svgFileName"/> is <see langword="null"/>.
  886. </exception>
  887. <exception cref="T:System.ArgumentException">
  888. If the <paramref name="svgFileName"/> is empty.
  889. <para>-or-</para>
  890. If the <paramref name="svgFileName"/> does not exists.
  891. </exception>
  892. </member>
  893. <member name="M:SharpVectors.Converters.ImageSvgConverter.Convert(System.IO.Stream,System.String)">
  894. <summary>
  895. This performs the conversion of the specified SVG source, and saves
  896. the output to the specified image file.
  897. </summary>
  898. <param name="svgStream">
  899. A stream providing access to the SVG source data.
  900. </param>
  901. <param name="imageFileName">
  902. The output image file. This is optional. If not specified, an image
  903. file is created in the same directory as the SVG file.
  904. </param>
  905. <returns>
  906. This returns <see langword="true"/> if the conversion is successful;
  907. otherwise, it return <see langword="false"/>.
  908. </returns>
  909. <exception cref="T:System.ArgumentNullException">
  910. If the <paramref name="imageFileName"/> is <see langword="null"/>.
  911. <para>-or-</para>
  912. If the <paramref name="svgStream"/> is <see langword="null"/>.
  913. </exception>
  914. <exception cref="T:System.ArgumentException">
  915. If the <paramref name="imageFileName"/> is empty.
  916. </exception>
  917. </member>
  918. <member name="M:SharpVectors.Converters.ImageSvgConverter.Convert(System.IO.TextReader,System.String)">
  919. <summary>
  920. This performs the conversion of the specified SVG source, and saves
  921. the output to the specified image file.
  922. </summary>
  923. <param name="svgTextReader">
  924. A text reader providing access to the SVG source data.
  925. </param>
  926. <param name="imageFileName">
  927. The output image file. This is optional. If not specified, an image
  928. file is created in the same directory as the SVG file.
  929. </param>
  930. <returns>
  931. This returns <see langword="true"/> if the conversion is successful;
  932. otherwise, it return <see langword="false"/>.
  933. </returns>
  934. <exception cref="T:System.ArgumentNullException">
  935. If the <paramref name="imageFileName"/> is <see langword="null"/>.
  936. <para>-or-</para>
  937. If the <paramref name="svgTextReader"/> is <see langword="null"/>.
  938. </exception>
  939. <exception cref="T:System.ArgumentException">
  940. If the <paramref name="imageFileName"/> is empty.
  941. </exception>
  942. </member>
  943. <member name="M:SharpVectors.Converters.ImageSvgConverter.Convert(System.Xml.XmlReader,System.String)">
  944. <summary>
  945. This performs the conversion of the specified SVG source, and saves
  946. the output to the specified image file.
  947. </summary>
  948. <param name="svgXmlReader">
  949. An XML reader providing access to the SVG source data.
  950. </param>
  951. <param name="imageFileName">
  952. The output image file. This is optional. If not specified, an image
  953. file is created in the same directory as the SVG file.
  954. </param>
  955. <returns>
  956. This returns <see langword="true"/> if the conversion is successful;
  957. otherwise, it return <see langword="false"/>.
  958. </returns>
  959. <exception cref="T:System.ArgumentNullException">
  960. If the <paramref name="imageFileName"/> is <see langword="null"/>.
  961. <para>-or-</para>
  962. If the <paramref name="svgXmlReader"/> is <see langword="null"/>.
  963. </exception>
  964. <exception cref="T:System.ArgumentException">
  965. If the <paramref name="imageFileName"/> is empty.
  966. </exception>
  967. </member>
  968. <member name="T:SharpVectors.Converters.Properties.Resources">
  969. <summary>
  970. A strongly-typed resource class, for looking up localized strings, etc.
  971. </summary>
  972. </member>
  973. <member name="P:SharpVectors.Converters.Properties.Resources.ResourceManager">
  974. <summary>
  975. Returns the cached ResourceManager instance used by this class.
  976. </summary>
  977. </member>
  978. <member name="P:SharpVectors.Converters.Properties.Resources.Culture">
  979. <summary>
  980. Overrides the current thread's CurrentUICulture property for all
  981. resource lookups using this strongly typed resource class.
  982. </summary>
  983. </member>
  984. <member name="T:SharpVectors.Converters.ResourceSvgConverter">
  985. <summary>
  986. </summary>
  987. </member>
  988. <member name="M:SharpVectors.Converters.ResourceSvgConverter.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  989. <summary>
  990. Initializes a new instance of the <see cref="T:SharpVectors.Converters.ResourceSvgConverter"/>
  991. class with the specified drawing or rendering settings.
  992. </summary>
  993. <param name="drawingSettings">
  994. This specifies the settings used by the rendering or drawing engine.
  995. If this is <see langword="null"/>, the default settings is used.
  996. </param>
  997. </member>
  998. <member name="T:SharpVectors.Converters.ShapeSvgCanvas">
  999. <summary>
  1000. Component that visualizes svg document contents.
  1001. </summary>
  1002. </member>
  1003. <member name="P:SharpVectors.Converters.ShapeSvgCanvas.Source">
  1004. <summary>
  1005. Gets or sets svg document source.
  1006. </summary>
  1007. </member>
  1008. <member name="P:SharpVectors.Converters.ShapeSvgCanvas.ItemStyle">
  1009. <summary>
  1010. Gets or sets an item style that will be applied to all svg elements.
  1011. </summary>
  1012. <remarks>
  1013. This style will be used as a BasedOn style for all shapes created from
  1014. svg elements.
  1015. </remarks>
  1016. </member>
  1017. <member name="P:SharpVectors.Converters.ShapeSvgCanvas.Bounds">
  1018. <summary>
  1019. Gets the bounding box of the svg document.
  1020. </summary>
  1021. </member>
  1022. <member name="M:SharpVectors.Converters.ShapeSvgCanvas.UnloadDiagrams">
  1023. <summary>
  1024. Unloads loaded svg.
  1025. </summary>
  1026. </member>
  1027. <member name="T:SharpVectors.Converters.StreamSvgConverter">
  1028. <summary>
  1029. This converts the SVG file to static or bitmap image, which is saved to a file.
  1030. </summary>
  1031. <remarks>
  1032. <para>
  1033. The image is save with the <see cref="P:System.Windows.Media.PixelFormats.Pbgra32"/> format,
  1034. since that is the only pixel format which does not throw an exception
  1035. with the <see cref="T:System.Windows.Media.Imaging.RenderTargetBitmap"/>.
  1036. </para>
  1037. <para>The DPI used is 96.</para>
  1038. </remarks>
  1039. </member>
  1040. <member name="F:SharpVectors.Converters.StreamSvgConverter._drawing">
  1041. <summary>
  1042. This is the last drawing generated.
  1043. </summary>
  1044. </member>
  1045. <member name="M:SharpVectors.Converters.StreamSvgConverter.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  1046. <overloads>
  1047. Initializes a new instance of the <see cref="T:SharpVectors.Converters.StreamSvgConverter"/> class.
  1048. </overloads>
  1049. <summary>
  1050. Initializes a new instance of the <see cref="T:SharpVectors.Converters.StreamSvgConverter"/> class
  1051. with the specified drawing or rendering settings.
  1052. </summary>
  1053. <param name="settings">
  1054. This specifies the settings used by the rendering or drawing engine.
  1055. If this is <see langword="null"/>, the default settings is used.
  1056. </param>
  1057. </member>
  1058. <member name="M:SharpVectors.Converters.StreamSvgConverter.#ctor(System.Boolean,System.Boolean,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  1059. <summary>
  1060. Initializes a new instance of the <see cref="T:SharpVectors.Converters.StreamSvgConverter"/> class
  1061. with the specified drawing or rendering settings and the saving options.
  1062. </summary>
  1063. <param name="saveXaml">
  1064. This specifies whether to save result object tree in image file.
  1065. </param>
  1066. <param name="saveZaml">
  1067. This specifies whether to save result object tree in ZAML file. The
  1068. ZAML is simply a G-Zip compressed image format, similar to the SVGZ.
  1069. </param>
  1070. <param name="settings">
  1071. This specifies the settings used by the rendering or drawing engine.
  1072. If this is <see langword="null"/>, the default settings is used.
  1073. </param>
  1074. </member>
  1075. <member name="P:SharpVectors.Converters.StreamSvgConverter.WriterErrorOccurred">
  1076. <summary>
  1077. Gets a value indicating whether a writer error occurred when
  1078. using the custom image writer.
  1079. </summary>
  1080. <value>
  1081. This is <see langword="true"/> if an error occurred when using
  1082. the custom image writer; otherwise, it is <see langword="false"/>.
  1083. </value>
  1084. </member>
  1085. <member name="P:SharpVectors.Converters.StreamSvgConverter.FallbackOnWriterError">
  1086. <summary>
  1087. Gets or sets a value indicating whether to fall back and use
  1088. the .NET Framework image writer when an error occurred in using the
  1089. custom writer.
  1090. </summary>
  1091. <value>
  1092. This is <see langword="true"/> if the converter falls back to using
  1093. the system image writer when an error occurred in using the custom
  1094. writer; otherwise, it is <see langword="false"/>. If <see langword="false"/>,
  1095. an exception, which occurred in using the custom writer will be
  1096. thrown. The default is <see langword="false"/>.
  1097. </value>
  1098. </member>
  1099. <member name="P:SharpVectors.Converters.StreamSvgConverter.EncoderType">
  1100. <summary>
  1101. Gets or set the bitmap encoder type to use in encoding the drawing
  1102. to an image file.
  1103. </summary>
  1104. <value>
  1105. An enumeration of the type <see cref="T:SharpVectors.Converters.ImageEncoderType"/> specifying
  1106. the bitmap encoder. The default is the <see cref="F:SharpVectors.Converters.ImageEncoderType.PngBitmap"/>.
  1107. </value>
  1108. </member>
  1109. <member name="P:SharpVectors.Converters.StreamSvgConverter.Encoder">
  1110. <summary>
  1111. Gets or sets a custom bitmap encoder to use in encoding the drawing
  1112. to an image file.
  1113. </summary>
  1114. <value>
  1115. A derived <see cref="T:System.Windows.Media.Imaging.BitmapEncoder"/> object specifying the bitmap
  1116. encoder for encoding the images. The default is <see langword="null"/>,
  1117. and the <see cref="P:SharpVectors.Converters.StreamSvgConverter.EncoderType"/> property determines the encoder used.
  1118. </value>
  1119. <remarks>
  1120. If the value of this is set, it must match the MIME type or file
  1121. extension defined by the <see cref="P:SharpVectors.Converters.StreamSvgConverter.EncoderType"/> property for it
  1122. to be used.
  1123. </remarks>
  1124. </member>
  1125. <member name="P:SharpVectors.Converters.StreamSvgConverter.Drawing">
  1126. <summary>
  1127. Gets the last created drawing.
  1128. </summary>
  1129. <value>
  1130. A <see cref="T:System.Windows.Media.DrawingGroup"/> specifying the last converted drawing.
  1131. </value>
  1132. </member>
  1133. <member name="M:SharpVectors.Converters.StreamSvgConverter.Convert(System.String,System.IO.Stream)">
  1134. <overloads>
  1135. This performs the conversion of the specified SVG file, and saves
  1136. the output to an image file.
  1137. </overloads>
  1138. <summary>
  1139. This performs the conversion of the specified SVG file, and saves
  1140. the output to the specified image file.
  1141. </summary>
  1142. <param name="svgFileName">
  1143. The full path of the SVG source file.
  1144. </param>
  1145. <param name="imageStream">
  1146. The output image file. This is optional. If not specified, an image
  1147. file is created in the same directory as the SVG file.
  1148. </param>
  1149. <returns>
  1150. This returns <see langword="true"/> if the conversion is successful;
  1151. otherwise, it return <see langword="false"/>.
  1152. </returns>
  1153. <exception cref="T:System.ArgumentNullException">
  1154. If the <paramref name="svgFileName"/> is <see langword="null"/>.
  1155. </exception>
  1156. <exception cref="T:System.ArgumentException">
  1157. If the <paramref name="svgFileName"/> is empty.
  1158. <para>-or-</para>
  1159. If the <paramref name="svgFileName"/> does not exists.
  1160. </exception>
  1161. </member>
  1162. <member name="M:SharpVectors.Converters.StreamSvgConverter.Convert(System.IO.Stream,System.IO.Stream)">
  1163. <summary>
  1164. This performs the conversion of the specified SVG source, and saves
  1165. the output to the specified image file.
  1166. </summary>
  1167. <param name="svgStream">
  1168. A stream providing access to the SVG source data.
  1169. </param>
  1170. <param name="imageStream">
  1171. The output image file. This is optional. If not specified, an image
  1172. file is created in the same directory as the SVG file.
  1173. </param>
  1174. <returns>
  1175. This returns <see langword="true"/> if the conversion is successful;
  1176. otherwise, it return <see langword="false"/>.
  1177. </returns>
  1178. <exception cref="T:System.ArgumentNullException">
  1179. If the <paramref name="imageStream"/> is <see langword="null"/>.
  1180. <para>-or-</para>
  1181. If the <paramref name="svgStream"/> is <see langword="null"/>.
  1182. </exception>
  1183. <exception cref="T:System.ArgumentException">
  1184. If the <paramref name="imageStream"/> is empty.
  1185. </exception>
  1186. </member>
  1187. <member name="M:SharpVectors.Converters.StreamSvgConverter.Convert(System.IO.TextReader,System.IO.Stream)">
  1188. <summary>
  1189. This performs the conversion of the specified SVG source, and saves
  1190. the output to the specified image file.
  1191. </summary>
  1192. <param name="svgTextReader">
  1193. A text reader providing access to the SVG source data.
  1194. </param>
  1195. <param name="imageStream">
  1196. The output image file. This is optional. If not specified, an image
  1197. file is created in the same directory as the SVG file.
  1198. </param>
  1199. <returns>
  1200. This returns <see langword="true"/> if the conversion is successful;
  1201. otherwise, it return <see langword="false"/>.
  1202. </returns>
  1203. <exception cref="T:System.ArgumentNullException">
  1204. If the <paramref name="imageStream"/> is <see langword="null"/>.
  1205. <para>-or-</para>
  1206. If the <paramref name="svgTextReader"/> is <see langword="null"/>.
  1207. </exception>
  1208. <exception cref="T:System.ArgumentException">
  1209. If the <paramref name="imageStream"/> is empty.
  1210. </exception>
  1211. </member>
  1212. <member name="M:SharpVectors.Converters.StreamSvgConverter.Convert(System.Xml.XmlReader,System.IO.Stream)">
  1213. <summary>
  1214. This performs the conversion of the specified SVG source, and saves
  1215. the output to the specified image file.
  1216. </summary>
  1217. <param name="svgXmlReader">
  1218. An XML reader providing access to the SVG source data.
  1219. </param>
  1220. <param name="imageStream">
  1221. The output image file. This is optional. If not specified, an image
  1222. file is created in the same directory as the SVG file.
  1223. </param>
  1224. <returns>
  1225. This returns <see langword="true"/> if the conversion is successful;
  1226. otherwise, it return <see langword="false"/>.
  1227. </returns>
  1228. <exception cref="T:System.ArgumentNullException">
  1229. If the <paramref name="imageStream"/> is <see langword="null"/>.
  1230. <para>-or-</para>
  1231. If the <paramref name="svgXmlReader"/> is <see langword="null"/>.
  1232. </exception>
  1233. <exception cref="T:System.ArgumentException">
  1234. If the <paramref name="imageStream"/> is empty.
  1235. </exception>
  1236. </member>
  1237. <member name="T:SharpVectors.Converters.SvgBitmap">
  1238. <summary>
  1239. This is an extension of the WPF <see cref="T:System.Windows.Controls.Image"/> control to provide SVG-based image sources.
  1240. </summary>
  1241. <seealso cref="T:SharpVectors.Converters.SvgIcon"/>
  1242. </member>
  1243. <member name="F:SharpVectors.Converters.SvgBitmap.UriSourceProperty">
  1244. <summary>
  1245. Identifies the <see cref="P:SharpVectors.Converters.SvgBitmap.UriSource"/> dependency property.
  1246. </summary>
  1247. </member>
  1248. <member name="F:SharpVectors.Converters.SvgBitmap.SvgSourceProperty">
  1249. <summary>
  1250. Identifies the <see cref="P:SharpVectors.Converters.SvgBitmap.SvgSource"/> dependency property.
  1251. </summary>
  1252. </member>
  1253. <member name="F:SharpVectors.Converters.SvgBitmap.AppNameProperty">
  1254. <summary>
  1255. The <see cref="T:System.Windows.DependencyProperty"/> for the <c>AppName</c> property.
  1256. </summary>
  1257. </member>
  1258. <member name="M:SharpVectors.Converters.SvgBitmap.#ctor">
  1259. <summary>
  1260. Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgBitmap"/> class.
  1261. </summary>
  1262. </member>
  1263. <member name="P:SharpVectors.Converters.SvgBitmap.AppName">
  1264. <summary>
  1265. Gets or sets the <c>name</c> of the parent assembly for this element.
  1266. </summary>
  1267. <value>
  1268. A string containing the name of the parent assembly or the name of the assembly containing <c>SVG</c> file
  1269. referenced on this control in XAML, if the source type is <see cref="T:System.Uri"/>.
  1270. </value>
  1271. </member>
  1272. <member name="P:SharpVectors.Converters.SvgBitmap.UriSource">
  1273. <summary>
  1274. Gets or sets the path to the SVG file to load into this <see cref="T:SharpVectors.Converters.SvgBitmap"/>.
  1275. </summary>
  1276. <value>
  1277. A <see cref="T:System.Uri"/> specifying the path to the SVG source file.
  1278. The file can be located on a computer, network or assembly resources.
  1279. Settings this to <see langword="null"/> will close any opened diagram.
  1280. </value>
  1281. <remarks>
  1282. This is the same as the <see cref="!:Source"/> property, and added for consistency.
  1283. </remarks>
  1284. <seealso cref="P:SharpVectors.Converters.SvgBitmap.SvgSource"/>
  1285. </member>
  1286. <member name="P:SharpVectors.Converters.SvgBitmap.SvgSource">
  1287. <summary>
  1288. Gets or sets the SVG contents to load into this <see cref="T:SharpVectors.Converters.SvgBitmap"/>.
  1289. </summary>
  1290. <value>
  1291. A <see cref="T:System.String"/> specifying the embedded SVG contents.
  1292. Settings this to <see langword="null"/> will close any opened diagram.
  1293. </value>
  1294. <seealso cref="P:SharpVectors.Converters.SvgBitmap.UriSource"/>
  1295. </member>
  1296. <member name="M:SharpVectors.Converters.SvgBitmap.OnInitialized(System.EventArgs)">
  1297. <summary>
  1298. Raises the Initialized event. This method is invoked whenever IsInitialized is set to true.
  1299. </summary>
  1300. <param name="e">Event data for the event.</param>
  1301. </member>
  1302. <member name="M:SharpVectors.Converters.SvgBitmap.OnSettingsChanged">
  1303. <summary>
  1304. This handles changes in the rendering settings of this control.
  1305. </summary>
  1306. </member>
  1307. <member name="M:SharpVectors.Converters.SvgBitmap.CreateDrawing">
  1308. <summary>
  1309. Performs the conversion of a valid SVG source to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
  1310. </summary>
  1311. <returns>
  1312. This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
  1313. returns <see langword="null"/>.
  1314. </returns>
  1315. </member>
  1316. <member name="M:SharpVectors.Converters.SvgBitmap.CreateDrawing(System.Uri,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  1317. <summary>
  1318. Performs the conversion of a valid SVG source file to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
  1319. </summary>
  1320. <param name="svgSource">A <see cref="T:System.Uri"/> defining the path to the SVG source.</param>
  1321. <param name="settings">
  1322. This specifies the settings used by the rendering or drawing engine.
  1323. If this is <see langword="null"/>, the default settings is used.
  1324. </param>
  1325. <returns>
  1326. This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
  1327. returns <see langword="null"/>.
  1328. </returns>
  1329. </member>
  1330. <member name="M:SharpVectors.Converters.SvgBitmap.CreateDrawing(System.String,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  1331. <summary>
  1332. Performs the conversion of a valid SVG source stream to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
  1333. </summary>
  1334. <param name="svgSource">A stream providing access to the SVG source data.</param>
  1335. <param name="settings">
  1336. This specifies the settings used by the rendering or drawing engine.
  1337. If this is <see langword="null"/>, the default settings is used.
  1338. </param>
  1339. <returns>
  1340. This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
  1341. returns <see langword="null"/>.
  1342. </returns>
  1343. </member>
  1344. <member name="T:SharpVectors.Converters.SvgCanvas">
  1345. <summary>
  1346. This is a <see cref="T:System.Windows.Controls.Canvas"/> control for viewing <c>SVG</c> file in <c>WPF</c> applications.
  1347. </summary>
  1348. <remarks>
  1349. It extends the drawing canvas, <see cref="T:SharpVectors.Runtime.SvgDrawingCanvas"/>, instead of generic <see cref="T:System.Windows.Controls.Canvas"/> control,
  1350. therefore any interactivity support implemented in the drawing canvas will be available in the <see cref="T:System.Windows.Controls.Canvas"/>.
  1351. </remarks>
  1352. <seealso cref="T:SharpVectors.Converters.SvgViewbox"/>
  1353. </member>
  1354. <member name="F:SharpVectors.Converters.SvgCanvas.SourceProperty">
  1355. <summary>
  1356. Identifies the <see cref="P:SharpVectors.Converters.SvgCanvas.Source"/> dependency property.
  1357. </summary>
  1358. </member>
  1359. <member name="F:SharpVectors.Converters.SvgCanvas.UriSourceProperty">
  1360. <summary>
  1361. Identifies the <see cref="P:SharpVectors.Converters.SvgCanvas.UriSource"/> dependency property.
  1362. </summary>
  1363. </member>
  1364. <member name="F:SharpVectors.Converters.SvgCanvas.SvgSourceProperty">
  1365. <summary>
  1366. Identifies the <see cref="P:SharpVectors.Converters.SvgCanvas.SvgSource"/> dependency property.
  1367. </summary>
  1368. </member>
  1369. <member name="F:SharpVectors.Converters.SvgCanvas.StreamSourceProperty">
  1370. <summary>
  1371. Identifies the <see cref="P:SharpVectors.Converters.SvgCanvas.StreamSource"/> dependency property.
  1372. </summary>
  1373. </member>
  1374. <member name="F:SharpVectors.Converters.SvgCanvas.MessageFontFamilyProperty">
  1375. <summary>
  1376. The DependencyProperty for the MessageFontFamily property.
  1377. <para>
  1378. Flags: Can be used in style rules
  1379. </para>
  1380. <para>
  1381. Default Value: System Dialog Font
  1382. </para>
  1383. </summary>
  1384. </member>
  1385. <member name="F:SharpVectors.Converters.SvgCanvas.MessageFontSizeProperty">
  1386. <summary>
  1387. The DependencyProperty for the MessageFontSize property.
  1388. <para>
  1389. Flags: Can be used in style rules
  1390. </para>
  1391. <para>
  1392. Default Value: 48 pixels
  1393. </para>
  1394. </summary>
  1395. </member>
  1396. <member name="F:SharpVectors.Converters.SvgCanvas.MessageOpacityProperty">
  1397. <summary>
  1398. The DependencyProperty for the MessageOpacity property.
  1399. <para>
  1400. Flags: Can be used in style rules
  1401. </para>
  1402. <para>
  1403. Default Value: 1 (full opacity)
  1404. </para>
  1405. </summary>
  1406. </member>
  1407. <member name="F:SharpVectors.Converters.SvgCanvas.MessageTextProperty">
  1408. <summary>
  1409. The DependencyProperty for the MessageText property.
  1410. <para>
  1411. Flags: Can be used in style rules
  1412. </para>
  1413. <para>
  1414. Default Value: "Loading..."
  1415. </para>
  1416. </summary>
  1417. </member>
  1418. <member name="F:SharpVectors.Converters.SvgCanvas.MessageBackgroundProperty">
  1419. <summary>
  1420. The DependencyProperty for the MessageBackground property.
  1421. <para>
  1422. Flags: Can be used in style rules
  1423. </para>
  1424. <para>
  1425. Default Value: <see cref="P:System.Windows.Media.Brushes.PapayaWhip"/>
  1426. </para>
  1427. </summary>
  1428. </member>
  1429. <member name="F:SharpVectors.Converters.SvgCanvas.MessageFillBrushProperty">
  1430. <summary>
  1431. The DependencyProperty for the MessageFillBrush property.
  1432. <para>
  1433. Flags: Can be used in style rules
  1434. </para>
  1435. <para>
  1436. Default Value: <see cref="P:System.Windows.Media.Brushes.Gold"/>
  1437. </para>
  1438. </summary>
  1439. </member>
  1440. <member name="F:SharpVectors.Converters.SvgCanvas.MessageStrokeBrushProperty">
  1441. <summary>
  1442. The DependencyProperty for the MessageStrokeBrush property.
  1443. <para>
  1444. Flags: Can be used in style rules
  1445. </para>
  1446. <para>
  1447. Default Value: <see cref="P:System.Windows.Media.Brushes.Maroon"/>
  1448. </para>
  1449. </summary>
  1450. </member>
  1451. <member name="F:SharpVectors.Converters.SvgCanvas.AppNameProperty">
  1452. <summary>
  1453. The <see cref="T:System.Windows.DependencyProperty"/> for the <c>AppName</c> property.
  1454. </summary>
  1455. </member>
  1456. <member name="M:SharpVectors.Converters.SvgCanvas.#ctor">
  1457. <summary>
  1458. Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgCanvas"/> class.
  1459. </summary>
  1460. </member>
  1461. <member name="M:SharpVectors.Converters.SvgCanvas.#cctor">
  1462. <summary>
  1463. Static constructor to define metadata for the control (and link it to the style in Generic.xaml).
  1464. </summary>
  1465. </member>
  1466. <member name="P:SharpVectors.Converters.SvgCanvas.AppName">
  1467. <summary>
  1468. Gets or sets the <c>name</c> of the parent assembly for this element.
  1469. </summary>
  1470. <value>
  1471. A string containing the name of the parent assembly or the name of the assembly containing <c>SVG</c> file
  1472. referenced on this control in XAML, if the source type is <see cref="T:System.Uri"/>.
  1473. </value>
  1474. </member>
  1475. <member name="P:SharpVectors.Converters.SvgCanvas.Source">
  1476. <summary>
  1477. Gets or sets the path to the <c>SVG</c> file to load into this <see cref="T:System.Windows.Controls.Canvas"/>.
  1478. </summary>
  1479. <value>
  1480. A <see cref="T:System.Uri"/> specifying the path to the <c>SVG</c> source file. The file can be located on
  1481. a computer, network or assembly resources.
  1482. Settings this to <see langword="null"/> will close any rendered <c>SVG</c> diagram.
  1483. </value>
  1484. <seealso cref="P:SharpVectors.Converters.SvgCanvas.UriSource"/>
  1485. <seealso cref="P:SharpVectors.Converters.SvgCanvas.StreamSource"/>
  1486. </member>
  1487. <member name="P:SharpVectors.Converters.SvgCanvas.UriSource">
  1488. <summary>
  1489. Gets or sets the path to the <c>SVG</c> file to load into this <see cref="T:System.Windows.Controls.Canvas"/>.
  1490. </summary>
  1491. <value>
  1492. A <see cref="T:System.Uri"/> specifying the path to the <c>SVG</c> source file.
  1493. The <c>SVG</c> file can be located on a computer, network or assembly resources.
  1494. Settings this to <see langword="null"/> will close any rendered <c>SVG</c> diagram.
  1495. </value>
  1496. <remarks>
  1497. This is the same as the <see cref="P:SharpVectors.Converters.SvgCanvas.Source"/> property, it is added for consistency in naming the <c>SVG</c> sources.
  1498. </remarks>
  1499. <seealso cref="P:SharpVectors.Converters.SvgCanvas.Source"/>
  1500. <seealso cref="P:SharpVectors.Converters.SvgCanvas.SvgSource"/>
  1501. <seealso cref="P:SharpVectors.Converters.SvgCanvas.StreamSource"/>
  1502. </member>
  1503. <member name="P:SharpVectors.Converters.SvgCanvas.SvgSource">
  1504. <summary>
  1505. Gets or sets the <c>SVG</c> contents to load into this <see cref="T:System.Windows.Controls.Canvas"/>.
  1506. </summary>
  1507. <value>
  1508. A <see cref="T:System.String"/> specifying the embedded <c>SVG</c> contents.
  1509. Settings this to <see langword="null"/> will close any opened diagram.
  1510. </value>
  1511. <seealso cref="P:SharpVectors.Converters.SvgCanvas.Source"/>
  1512. <seealso cref="P:SharpVectors.Converters.SvgCanvas.UriSource"/>
  1513. <seealso cref="P:SharpVectors.Converters.SvgCanvas.StreamSource"/>
  1514. </member>
  1515. <member name="P:SharpVectors.Converters.SvgCanvas.StreamSource">
  1516. <summary>
  1517. Gets or sets the <see cref="T:System.IO.Stream"/> to the <c>SVG</c> source to load into this
  1518. <see cref="T:System.Windows.Controls.Canvas"/>.
  1519. </summary>
  1520. <value>
  1521. A <see cref="T:System.IO.Stream"/> specifying the stream to the SVG source.
  1522. Settings this to <see langword="null"/> will close any opened diagram.
  1523. </value>
  1524. <remarks>
  1525. <para>
  1526. The stream source has precedence over the Uri <see cref="P:SharpVectors.Converters.SvgCanvas.Source"/> property.
  1527. If set (not <see langword="null"/>), the stream source will be rendered instead of the Uri source.
  1528. </para>
  1529. <para>
  1530. WPF controls do not implement the <see cref="T:System.IDisposable"/> interface and cannot properly dispose any
  1531. stream set to it. To avoid this issue and also any problem of the user accidentally closing the stream,
  1532. this control makes a copy of the stream to memory stream.
  1533. </para>
  1534. </remarks>
  1535. <seealso cref="P:SharpVectors.Converters.SvgCanvas.Source"/>
  1536. <seealso cref="P:SharpVectors.Converters.SvgCanvas.UriSource"/>
  1537. <seealso cref="P:SharpVectors.Converters.SvgCanvas.SvgSource"/>
  1538. </member>
  1539. <member name="P:SharpVectors.Converters.SvgCanvas.AutoSize">
  1540. <summary>
  1541. Gets or sets a value indicating whether to automatically resize this
  1542. <see cref="T:System.Windows.Controls.Canvas"/> based on the size of the loaded drawing.
  1543. </summary>
  1544. <value>
  1545. This is <see langword="true"/> if this <see cref="T:System.Windows.Controls.Canvas"/> is automatically resized based on the size of the
  1546. loaded drawing; otherwise, it is <see langword="false"/>. The default is <see langword="false"/>, and the
  1547. user-defined size or the parent assigned layout size is used.
  1548. </value>
  1549. </member>
  1550. <member name="P:SharpVectors.Converters.SvgCanvas.OptimizePath">
  1551. <summary>
  1552. Gets or sets a value indicating whether the path geometry is optimized using the <see cref="T:System.Windows.Media.StreamGeometry"/>.
  1553. </summary>
  1554. <value>
  1555. This is <see langword="true"/> if the path geometry is optimized using the <see cref="T:System.Windows.Media.StreamGeometry"/>;
  1556. otherwise, it is <see langword="false"/>. The default is <see langword="true"/>.
  1557. </value>
  1558. </member>
  1559. <member name="P:SharpVectors.Converters.SvgCanvas.TextAsGeometry">
  1560. <summary>
  1561. Gets or sets a value indicating whether the texts are rendered as path geometry.
  1562. </summary>
  1563. <value>
  1564. This is <see langword="true"/> if texts are rendered as path geometries; otherwise, this is
  1565. <see langword="false"/>. The default is <see langword="true"/>.
  1566. </value>
  1567. <remarks>
  1568. The text features of the <c>SVG</c> format are complex and difficult to fully support without directly reverting
  1569. the text paths (or glyph geometry). This options will, therefore, be removed in future versions of the library,
  1570. as it is not always honored when set to <see langword="false"/>.
  1571. </remarks>
  1572. </member>
  1573. <member name="P:SharpVectors.Converters.SvgCanvas.IncludeRuntime">
  1574. <summary>
  1575. Gets or sets a value indicating whether the <c>SharpVectors.Runtime.dll</c> classes are used in the
  1576. generated output.
  1577. </summary>
  1578. <value>
  1579. This is <see langword="true"/> if the <c>SharpVectors.Runtime.dll</c> classes and types are used in the
  1580. generated output; otherwise, it is <see langword="false"/>. The default is <see langword="true"/>.
  1581. </value>
  1582. <remarks>
  1583. The use of the <c>SharpVectors.Runtime.dll</c> prevents the hard-coded font path generated by the
  1584. <see cref="T:System.Windows.Media.FormattedText"/> class, support for embedded images etc.
  1585. </remarks>
  1586. </member>
  1587. <member name="P:SharpVectors.Converters.SvgCanvas.CultureInfo">
  1588. <summary>
  1589. Gets or sets the main culture information used for rendering texts.
  1590. </summary>
  1591. <value>
  1592. An instance of the <see cref="P:SharpVectors.Converters.SvgCanvas.CultureInfo"/> specifying the main
  1593. culture information for texts. The default is the English culture.
  1594. </value>
  1595. <remarks>
  1596. <para>
  1597. This is the culture information passed to the <see cref="T:System.Windows.Media.FormattedText"/> class instance for the text rendering.
  1598. </para>
  1599. <para>
  1600. The library does not currently provide any means of splitting texts into its multi-language parts.
  1601. </para>
  1602. </remarks>
  1603. </member>
  1604. <member name="P:SharpVectors.Converters.SvgCanvas.IgnoreRootViewbox">
  1605. <summary>
  1606. Gets or sets a value to indicate turning off viewbox at the root of the drawing.
  1607. </summary>
  1608. <value>
  1609. For image outputs, this will force the original size to be saved.
  1610. <para>
  1611. The default value is <see langword="false"/>.
  1612. </para>
  1613. </value>
  1614. <remarks>
  1615. There are reported cases where are diagrams displayed in Inkscape program, but will not show when converted.
  1616. These are diagrams on the drawing canvas of Inkspace but outside the svg viewbox.
  1617. <para>
  1618. When converted the drawings are also converted but not displayed due to clipping. Setting this property
  1619. to <see langword="true"/> will clear the clipping region on conversion.
  1620. </para>
  1621. </remarks>
  1622. </member>
  1623. <member name="P:SharpVectors.Converters.SvgCanvas.EnsureViewboxSize">
  1624. <summary>
  1625. Gets or sets a value to indicate preserving the original viewbox size when saving images.
  1626. </summary>
  1627. <value>
  1628. For image outputs, this will force the original size to be saved.
  1629. <para>
  1630. The default value is <see langword="false"/>. However, the ImageSvgConverter converted
  1631. sets this to <see langword="true"/> by default.
  1632. </para>
  1633. </value>
  1634. <remarks>
  1635. Setting this to <see langword="true"/> will cause the rendering process to draw a transparent box around
  1636. the output, if a viewbox is defined. This will ensure that the original image size is saved.
  1637. </remarks>
  1638. </member>
  1639. <member name="P:SharpVectors.Converters.SvgCanvas.EnsureViewboxPosition">
  1640. <summary>
  1641. Gets or sets a value to indicate applying a translate transform to the viewbox to ensure
  1642. it is visible when rendered.
  1643. </summary>
  1644. <value>
  1645. This determines whether a transformation is applied to the rendered drawing. For drawings where the top-left
  1646. position of the viewbox is off the screen, due to negative values, this will ensure the drawing is visible.
  1647. <para>
  1648. The default value is <see langword="true"/>. Set this value to <see langword="false"/> if
  1649. you wish to apply your own transformations to the drawings.
  1650. </para>
  1651. </value>
  1652. </member>
  1653. <member name="P:SharpVectors.Converters.SvgCanvas.Drawings">
  1654. <summary>
  1655. Gets the drawing from the SVG file conversion.
  1656. </summary>
  1657. <value>
  1658. An instance of the <see cref="T:System.Windows.Media.DrawingGroup"/> specifying the converted drawings
  1659. which is rendered in this canvas.
  1660. </value>
  1661. </member>
  1662. <member name="P:SharpVectors.Converters.SvgCanvas.MessageFontFamily">
  1663. <summary>
  1664. Gets or sets the font family of the desired font for the message text.
  1665. </summary>
  1666. <value>
  1667. A <see cref="T:System.Windows.Media.FontFamily"/> specifying the font for the message text.
  1668. The default value is <see cref="P:System.Windows.SystemFonts.MessageFontFamily"/>.
  1669. </value>
  1670. </member>
  1671. <member name="P:SharpVectors.Converters.SvgCanvas.MessageFontSize">
  1672. <summary>
  1673. Gets or sets the size of the desired font for the message text.
  1674. </summary>
  1675. <value>
  1676. A value specifying the font size of the message text. The default is 48 pixels.
  1677. The font size must be a positive number.
  1678. </value>
  1679. </member>
  1680. <member name="P:SharpVectors.Converters.SvgCanvas.MessageOpacity">
  1681. <summary>
  1682. Gets or sets the opacity factor applied to the entire message text when it is
  1683. rendered in the user interface (UI).
  1684. </summary>
  1685. <value>
  1686. The opacity factor. Default opacity is 1.0. Expected values are between 0.0 and 1.0.
  1687. </value>
  1688. </member>
  1689. <member name="P:SharpVectors.Converters.SvgCanvas.MessageText">
  1690. <summary>
  1691. Gets or sets the content of the message.
  1692. </summary>
  1693. <value>
  1694. A <see cref="T:System.String"/> specifying the content of the message text.
  1695. The default is "Loading...". This value can be overriden in the <see cref="M:SharpVectors.Converters.SvgCanvas.Unload(System.Boolean,System.String)"/> method.
  1696. </value>
  1697. </member>
  1698. <member name="P:SharpVectors.Converters.SvgCanvas.MessageBackground">
  1699. <summary>
  1700. Gets or sets a brush that describes the background of a message text.
  1701. </summary>
  1702. <value>
  1703. A <see cref="T:System.Windows.Media.Brush"/> specifying the brush that is used to fill the background of the
  1704. message text. The default is <see cref="P:System.Windows.Media.Brushes.PapayaWhip"/>. If set to <see langword="null"/>,
  1705. the background will not be drawn.
  1706. </value>
  1707. </member>
  1708. <member name="P:SharpVectors.Converters.SvgCanvas.MessageFillBrush">
  1709. <summary>
  1710. Gets or sets the brush with which to fill the message text.
  1711. This is optional, and can be <see langword="null"/>. If the brush is <see langword="null"/>, no fill is drawn.
  1712. </summary>
  1713. <value>
  1714. A <see cref="T:System.Windows.Media.Brush"/> specifying the fill of the message text. The default is <see cref="P:System.Windows.Media.Brushes.Gold"/>.
  1715. </value>
  1716. <remarks>
  1717. If both the fill and stroke brushes of the message text are <see langword="null"/>, no text is drawn.
  1718. </remarks>
  1719. </member>
  1720. <member name="P:SharpVectors.Converters.SvgCanvas.MessageStrokeBrush">
  1721. <summary>
  1722. Gets or sets the brush of the <see cref="T:System.Windows.Media.Pen"/> with which to stroke the message text.
  1723. This is optional, and can be <see langword="null"/>. If the brush is <see langword="null"/>, no stroke is drawn.
  1724. </summary>
  1725. <value>
  1726. A <see cref="T:System.Windows.Media.Brush"/> specifying the brush of the <see cref="T:System.Windows.Media.Pen"/> for stroking the message text.
  1727. The default is <see cref="P:System.Windows.Media.Brushes.Maroon"/>.
  1728. </value>
  1729. <remarks>
  1730. If both the fill and stroke brushes of the message text are <see langword="null"/>, no text is drawn.
  1731. </remarks>
  1732. </member>
  1733. <member name="M:SharpVectors.Converters.SvgCanvas.Load(System.Uri,System.Boolean)">
  1734. <summary>
  1735. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgCanvas"/> by using the supplied Uniform Resource Identifier (URI)
  1736. and optionally processing the result asynchronously.
  1737. </summary>
  1738. <param name="uriSource">A reference to the SVG source file.</param>
  1739. <param name="useAsync">
  1740. A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
  1741. the SVG conversion is processed synchronously.
  1742. </param>
  1743. <returns>
  1744. A value that indicates whether the operation was successful. This is <see langword="true"/>
  1745. if successful, otherwise, it is <see langword="false"/>.
  1746. </returns>
  1747. </member>
  1748. <member name="M:SharpVectors.Converters.SvgCanvas.Load(System.String,System.Boolean)">
  1749. <summary>
  1750. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgCanvas"/> by accessing text content
  1751. and optionally processing the result asynchronously.
  1752. </summary>
  1753. <param name="svgSource">The stream source that sets the SVG source value.</param>
  1754. <param name="useAsync">
  1755. A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
  1756. the SVG conversion is processed synchronously.
  1757. </param>
  1758. <returns>
  1759. A value that indicates whether the operation was successful. This is <see langword="true"/>
  1760. if successful, otherwise, it is <see langword="false"/>.
  1761. </returns>
  1762. </member>
  1763. <member name="M:SharpVectors.Converters.SvgCanvas.Load(System.IO.Stream,System.Boolean,System.Boolean)">
  1764. <summary>
  1765. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgCanvas"/> by accessing a stream
  1766. and optionally processing the result asynchronously.
  1767. </summary>
  1768. <param name="streamSource">The stream source that sets the SVG source value.</param>
  1769. <param name="useCopyStream">
  1770. A value specifying whether to use a copy of the stream. The default is <see langword="true"/>,
  1771. the SVG source stream is copied, rendered and stored.
  1772. </param>
  1773. <param name="useAsync">
  1774. A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
  1775. the SVG conversion is processed synchronously.
  1776. </param>
  1777. <returns>
  1778. A value that indicates whether the operation was successful. This is <see langword="true"/>
  1779. if successful, otherwise, it is <see langword="false"/>.
  1780. </returns>
  1781. <remarks>
  1782. The control will by default create a copy of the source stream to prevent any effect of disposing.
  1783. If the source stream is stored, then use the <paramref name="useCopyStream"/> to prevent the control
  1784. from creating its own copy.
  1785. </remarks>
  1786. </member>
  1787. <member name="M:SharpVectors.Converters.SvgCanvas.LoadAsync(System.Uri)">
  1788. <summary>
  1789. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgCanvas"/> by using the supplied Uniform Resource Identifier (URI)
  1790. and processing the result asynchronously.
  1791. </summary>
  1792. <param name="uriSource">A reference to the SVG source file.</param>
  1793. <returns>
  1794. A value that indicates whether the operation was successful. This is <see langword="true"/>
  1795. if successful, otherwise, it is <see langword="false"/>.
  1796. </returns>
  1797. </member>
  1798. <member name="M:SharpVectors.Converters.SvgCanvas.LoadAsync(System.String)">
  1799. <summary>
  1800. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgCanvas"/> by accessing text contents
  1801. and processing the result asynchronously.
  1802. </summary>
  1803. <param name="svgSource">The stream source that sets the SVG source value.</param>
  1804. <returns>
  1805. A value that indicates whether the operation was successful. This is <see langword="true"/>
  1806. if successful, otherwise, it is <see langword="false"/>.
  1807. </returns>
  1808. </member>
  1809. <member name="M:SharpVectors.Converters.SvgCanvas.LoadAsync(System.IO.Stream,System.Boolean)">
  1810. <summary>
  1811. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgCanvas"/> by accessing a stream
  1812. and processing the result asynchronously.
  1813. </summary>
  1814. <param name="streamSource">The stream source that sets the SVG source value.</param>
  1815. <param name="useCopyStream">
  1816. A value specifying whether to use a copy of the stream. The default is <see langword="true"/>,
  1817. the SVG source stream is copied, rendered and stored.
  1818. </param>
  1819. <returns>
  1820. A value that indicates whether the operation was successful. This is <see langword="true"/>
  1821. if successful, otherwise, it is <see langword="false"/>.
  1822. </returns>
  1823. <remarks>
  1824. The control will by default create a copy of the source stream to prevent any effect of disposing.
  1825. If the source stream is stored, then use the <paramref name="useCopyStream"/> to prevent the control
  1826. from creating its own copy.
  1827. </remarks>
  1828. </member>
  1829. <member name="M:SharpVectors.Converters.SvgCanvas.Unload(System.Boolean,System.String)">
  1830. <summary>
  1831. This clears the <see cref="T:SharpVectors.Converters.SvgCanvas"/> of any drawn diagram and optionally displays a
  1832. message.
  1833. </summary>
  1834. <param name="displayMessage">
  1835. A value indicating whether to display a message after clearing the SVG rendered diagram.
  1836. The value is <see langword="false"/>, not message is displayed.
  1837. </param>
  1838. <param name="message">
  1839. This specifies the message to be displayed after clearing the diagram. Setting this parameter
  1840. to a non-empty text will override any message set in the <see cref="P:SharpVectors.Converters.SvgCanvas.MessageText"/>.
  1841. The default value is <see cref="F:System.String.Empty"/>.
  1842. </param>
  1843. </member>
  1844. <member name="M:SharpVectors.Converters.SvgCanvas.OnInitialized(System.EventArgs)">
  1845. <summary>
  1846. Raises the Initialized event. This method is invoked whenever IsInitialized is set to true.
  1847. </summary>
  1848. <param name="e">Event data for the event.</param>
  1849. </member>
  1850. <member name="M:SharpVectors.Converters.SvgCanvas.GetDrawingSettings">
  1851. <summary>
  1852. Gets the rendering settings or options to be used in rendering the SVG in this control.
  1853. </summary>
  1854. <returns>
  1855. An instance of <see cref="T:SharpVectors.Renderers.Wpf.WpfDrawingSettings"/> specifying the rendering options or settings.
  1856. </returns>
  1857. </member>
  1858. <member name="M:SharpVectors.Converters.SvgCanvas.OnSettingsChanged">
  1859. <summary>
  1860. This handles changes in the rendering settings of this control.
  1861. </summary>
  1862. </member>
  1863. <member name="M:SharpVectors.Converters.SvgCanvas.OnAutoSizeChanged">
  1864. <summary>
  1865. This handles changes in the automatic resizing property of this control.
  1866. </summary>
  1867. </member>
  1868. <member name="M:SharpVectors.Converters.SvgCanvas.CreateDrawing">
  1869. <summary>
  1870. Performs the conversion of a valid SVG source to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
  1871. </summary>
  1872. <returns>
  1873. This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
  1874. returns <see langword="null"/>.
  1875. </returns>
  1876. </member>
  1877. <member name="M:SharpVectors.Converters.SvgCanvas.CreateDrawing(System.Uri,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  1878. <summary>
  1879. Performs the conversion of a valid SVG source file to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
  1880. </summary>
  1881. <param name="svgSource">A <see cref="T:System.Uri"/> defining the path to the SVG source.</param>
  1882. <param name="settings">
  1883. This specifies the settings used by the rendering or drawing engine.
  1884. If this is <see langword="null"/>, the default settings is used.
  1885. </param>
  1886. <returns>
  1887. This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
  1888. returns <see langword="null"/>.
  1889. </returns>
  1890. </member>
  1891. <member name="M:SharpVectors.Converters.SvgCanvas.CreateDrawing(System.IO.Stream,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  1892. <summary>
  1893. Performs the conversion of a valid SVG source stream to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
  1894. </summary>
  1895. <param name="svgStream">A stream providing access to the SVG source data.</param>
  1896. <param name="settings">
  1897. This specifies the settings used by the rendering or drawing engine.
  1898. If this is <see langword="null"/>, the default settings is used.
  1899. </param>
  1900. <returns>
  1901. This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it returns <see langword="null"/>.
  1902. </returns>
  1903. </member>
  1904. <member name="M:SharpVectors.Converters.SvgCanvas.CreateDrawing(System.String,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  1905. <summary>
  1906. Performs the conversion of a valid SVG source stream to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
  1907. </summary>
  1908. <param name="svgSource">A stream providing access to the SVG source data.</param>
  1909. <param name="settings">
  1910. This specifies the settings used by the rendering or drawing engine.
  1911. If this is <see langword="null"/>, the default settings is used.
  1912. </param>
  1913. <returns>
  1914. This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it returns <see langword="null"/>.
  1915. </returns>
  1916. </member>
  1917. <member name="P:SharpVectors.Converters.SvgCanvas.BaseUri">
  1918. <summary>
  1919. Gets or sets the base URI of the current application context.
  1920. </summary>
  1921. <value>
  1922. The base URI of the application context.
  1923. </value>
  1924. </member>
  1925. <member name="P:SharpVectors.Converters.SvgCanvas.SharpVectors#Dom#Svg#ISvgControl#Width">
  1926. <inheritdoc/>
  1927. </member>
  1928. <member name="P:SharpVectors.Converters.SvgCanvas.SharpVectors#Dom#Svg#ISvgControl#Height">
  1929. <inheritdoc/>
  1930. </member>
  1931. <member name="M:SharpVectors.Converters.SvgCanvas.SharpVectors#Dom#Svg#ISvgControl#HandleAlert(System.String)">
  1932. <inheritdoc/>
  1933. </member>
  1934. <member name="M:SharpVectors.Converters.SvgCanvas.SharpVectors#Dom#Svg#ISvgControl#HandleError(System.String)">
  1935. <inheritdoc/>
  1936. </member>
  1937. <member name="M:SharpVectors.Converters.SvgCanvas.SharpVectors#Dom#Svg#ISvgControl#HandleError(System.Exception)">
  1938. <inheritdoc/>
  1939. </member>
  1940. <member name="M:SharpVectors.Converters.SvgCanvas.SharpVectors#Dom#Svg#ISvgControl#HandleError(System.String,System.Exception)">
  1941. <inheritdoc/>
  1942. </member>
  1943. <member name="T:SharpVectors.Converters.SvgControlSizeMode">
  1944. <summary>
  1945. </summary>
  1946. </member>
  1947. <member name="F:SharpVectors.Converters.SvgControlSizeMode.None">
  1948. <summary></summary>
  1949. </member>
  1950. <member name="F:SharpVectors.Converters.SvgControlSizeMode.ContentToSizeNoStretch">
  1951. <summary></summary>
  1952. </member>
  1953. <member name="F:SharpVectors.Converters.SvgControlSizeMode.ContentToSizeStretch">
  1954. <summary></summary>
  1955. </member>
  1956. <member name="F:SharpVectors.Converters.SvgControlSizeMode.SizeToContent">
  1957. <summary></summary>
  1958. </member>
  1959. <member name="T:SharpVectors.Converters.SvgControl">
  1960. <summary>
  1961. </summary>
  1962. </member>
  1963. <member name="F:SharpVectors.Converters.SvgControl.SourceProperty">
  1964. <summary>
  1965. Identifies the <see cref="P:SharpVectors.Converters.SvgControl.Source"/> dependency property.
  1966. </summary>
  1967. </member>
  1968. <member name="F:SharpVectors.Converters.SvgControl.StreamSourceProperty">
  1969. <summary>
  1970. Identifies the <see cref="P:SharpVectors.Converters.SvgControl.StreamSource"/> dependency property.
  1971. </summary>
  1972. </member>
  1973. <member name="F:SharpVectors.Converters.SvgControl.MessageFontFamilyProperty">
  1974. <summary>
  1975. The DependencyProperty for the MessageFontFamily property.
  1976. <para>
  1977. Flags: Can be used in style rules
  1978. </para>
  1979. <para>
  1980. Default Value: System Dialog Font
  1981. </para>
  1982. </summary>
  1983. </member>
  1984. <member name="F:SharpVectors.Converters.SvgControl.MessageFontSizeProperty">
  1985. <summary>
  1986. The DependencyProperty for the MessageFontSize property.
  1987. <para>
  1988. Flags: Can be used in style rules
  1989. </para>
  1990. <para>
  1991. Default Value: 48 pixels
  1992. </para>
  1993. </summary>
  1994. </member>
  1995. <member name="F:SharpVectors.Converters.SvgControl.MessageOpacityProperty">
  1996. <summary>
  1997. The DependencyProperty for the MessageOpacity property.
  1998. <para>
  1999. Flags: Can be used in style rules
  2000. </para>
  2001. <para>
  2002. Default Value: 1 (full opacity)
  2003. </para>
  2004. </summary>
  2005. </member>
  2006. <member name="F:SharpVectors.Converters.SvgControl.MessageTextProperty">
  2007. <summary>
  2008. The DependencyProperty for the MessageText property.
  2009. <para>
  2010. Flags: Can be used in style rules
  2011. </para>
  2012. <para>
  2013. Default Value: "Loading..."
  2014. </para>
  2015. </summary>
  2016. </member>
  2017. <member name="F:SharpVectors.Converters.SvgControl.MessageBackgroundProperty">
  2018. <summary>
  2019. The DependencyProperty for the MessageBackground property.
  2020. <para>
  2021. Flags: Can be used in style rules
  2022. </para>
  2023. <para>
  2024. Default Value: <see cref="P:System.Windows.Media.Brushes.PapayaWhip"/>
  2025. </para>
  2026. </summary>
  2027. </member>
  2028. <member name="F:SharpVectors.Converters.SvgControl.MessageFillBrushProperty">
  2029. <summary>
  2030. The DependencyProperty for the MessageFillBrush property.
  2031. <para>
  2032. Flags: Can be used in style rules
  2033. </para>
  2034. <para>
  2035. Default Value: <see cref="P:System.Windows.Media.Brushes.Gold"/>
  2036. </para>
  2037. </summary>
  2038. </member>
  2039. <member name="F:SharpVectors.Converters.SvgControl.MessageStrokeBrushProperty">
  2040. <summary>
  2041. The DependencyProperty for the MessageStrokeBrush property.
  2042. <para>
  2043. Flags: Can be used in style rules
  2044. </para>
  2045. <para>
  2046. Default Value: <see cref="P:System.Windows.Media.Brushes.Maroon"/>
  2047. </para>
  2048. </summary>
  2049. </member>
  2050. <member name="P:SharpVectors.Converters.SvgControl.Source">
  2051. <summary>
  2052. Gets or sets the path to the SVG file to load into this
  2053. <see cref="T:System.Windows.Controls.Canvas"/>.
  2054. </summary>
  2055. <value>
  2056. A <see cref="T:System.Uri"/> specifying the path to the SVG source file.
  2057. The file can be located on a computer, network or assembly resources.
  2058. Settings this to <see langword="null"/> will close any opened diagram.
  2059. </value>
  2060. <seealso cref="P:SharpVectors.Converters.SvgControl.StreamSource"/>
  2061. </member>
  2062. <member name="P:SharpVectors.Converters.SvgControl.StreamSource">
  2063. <summary>
  2064. Gets or sets the <see cref="T:System.IO.Stream"/> to the SVG source to load into this
  2065. <see cref="T:System.Windows.Controls.Canvas"/>.
  2066. </summary>
  2067. <value>
  2068. A <see cref="T:System.IO.Stream"/> specifying the stream to the SVG source.
  2069. Settings this to <see langword="null"/> will close any opened diagram.
  2070. </value>
  2071. <remarks>
  2072. <para>
  2073. The stream source has precedence over the Uri <see cref="P:SharpVectors.Converters.SvgControl.Source"/> property.
  2074. If set (not <see langword="null"/>), the stream source will be rendered instead of the Uri source.
  2075. </para>
  2076. <para>
  2077. WPF controls do not implement the <see cref="T:System.IDisposable"/> interface and cannot properly dispose any
  2078. stream set to it. To avoid this issue and also any problem of the user accidentally closing the stream,
  2079. this control makes a copy of the stream to memory stream.
  2080. </para>
  2081. </remarks>
  2082. <seealso cref="P:SharpVectors.Converters.SvgControl.Source"/>
  2083. </member>
  2084. <member name="P:SharpVectors.Converters.SvgControl.AutoSize">
  2085. <summary>
  2086. Gets or sets a value indicating whether to automatically resize this
  2087. <see cref="T:System.Windows.Controls.Canvas"/> based on the size of the loaded drawing.
  2088. </summary>
  2089. <value>
  2090. This is <see langword="true"/> if this <see cref="T:System.Windows.Controls.Canvas"/> is
  2091. automatically resized based on the size of the loaded drawing;
  2092. otherwise, it is <see langword="false"/>. The default is
  2093. <see langword="false"/>, and the user-defined size or the parent assigned
  2094. layout size is used.
  2095. </value>
  2096. </member>
  2097. <member name="P:SharpVectors.Converters.SvgControl.OptimizePath">
  2098. <summary>
  2099. Gets or sets a value indicating whether the path geometry is
  2100. optimized using the <see cref="T:System.Windows.Media.StreamGeometry"/>.
  2101. </summary>
  2102. <value>
  2103. This is <see langword="true"/> if the path geometry is optimized
  2104. using the <see cref="T:System.Windows.Media.StreamGeometry"/>; otherwise, it is
  2105. <see langword="false"/>. The default is <see langword="true"/>.
  2106. </value>
  2107. </member>
  2108. <member name="P:SharpVectors.Converters.SvgControl.TextAsGeometry">
  2109. <summary>
  2110. Gets or sets a value indicating whether the texts are rendered as
  2111. path geometry.
  2112. </summary>
  2113. <value>
  2114. This is <see langword="true"/> if texts are rendered as path
  2115. geometries; otherwise, this is <see langword="false"/>. The default
  2116. is <see langword="false"/>.
  2117. </value>
  2118. </member>
  2119. <member name="P:SharpVectors.Converters.SvgControl.IncludeRuntime">
  2120. <summary>
  2121. Gets or sets a value indicating whether the <c>SharpVectors.Runtime.dll</c>
  2122. classes are used in the generated output.
  2123. </summary>
  2124. <value>
  2125. This is <see langword="true"/> if the <c>SharpVectors.Runtime.dll</c>
  2126. classes and types are used in the generated output; otherwise, it is
  2127. <see langword="false"/>. The default is <see langword="true"/>.
  2128. </value>
  2129. <remarks>
  2130. The use of the <c>SharpVectors.Runtime.dll</c> prevents the hard-coded
  2131. font path generated by the <see cref="T:System.Windows.Media.FormattedText"/> class, support
  2132. for embedded images etc.
  2133. </remarks>
  2134. </member>
  2135. <member name="P:SharpVectors.Converters.SvgControl.CultureInfo">
  2136. <summary>
  2137. Gets or sets the main culture information used for rendering texts.
  2138. </summary>
  2139. <value>
  2140. An instance of the <see cref="P:SharpVectors.Converters.SvgControl.CultureInfo"/> specifying the main
  2141. culture information for texts. The default is the English culture.
  2142. </value>
  2143. <remarks>
  2144. <para>
  2145. This is the culture information passed to the <see cref="T:System.Windows.Media.FormattedText"/>
  2146. class instance for the text rendering.
  2147. </para>
  2148. <para>
  2149. The library does not currently provide any means of splitting texts
  2150. into its multi-language parts.
  2151. </para>
  2152. </remarks>
  2153. </member>
  2154. <member name="P:SharpVectors.Converters.SvgControl.IgnoreRootViewbox">
  2155. <summary>
  2156. Gets or sets a value to indicate turning off viewbox at the root of the drawing.
  2157. </summary>
  2158. <value>
  2159. For image outputs, this will force the original size to be saved.
  2160. <para>
  2161. The default value is <see langword="false"/>.
  2162. </para>
  2163. </value>
  2164. <remarks>
  2165. There are reported cases where are diagrams displayed in Inkscape program, but will not
  2166. show when converted. These are diagrams on the drawing canvas of Inkspace but outside
  2167. the svg viewbox.
  2168. <para>
  2169. When converted the drawings are also converted but not displayed due to
  2170. clipping. Setting this property to <see langword="true"/> will clear the clipping region
  2171. on conversion.
  2172. </para>
  2173. </remarks>
  2174. </member>
  2175. <member name="P:SharpVectors.Converters.SvgControl.EnsureViewboxSize">
  2176. <summary>
  2177. Gets or sets a value to indicate preserving the original viewbox size when saving images.
  2178. </summary>
  2179. <value>
  2180. For image outputs, this will force the original size to be saved.
  2181. <para>
  2182. The default value is <see langword="false"/>. However, the ImageSvgConverter converted
  2183. sets this to <see langword="true"/> by default.
  2184. </para>
  2185. </value>
  2186. <remarks>
  2187. Setting this to <see langword="true"/> will cause the rendering process to draw a transparent
  2188. box around the output, if a viewbox is defined. This will ensure that the original image
  2189. size is saved.
  2190. </remarks>
  2191. </member>
  2192. <member name="P:SharpVectors.Converters.SvgControl.EnsureViewboxPosition">
  2193. <summary>
  2194. Gets or sets a value to indicate applying a translate transform to the viewbox to ensure
  2195. it is visible when rendered.
  2196. </summary>
  2197. <value>
  2198. This determines whether a transformation is applied to the rendered drawing. For drawings
  2199. where the top-left position of the viewbox is off the screen, due to negative values, this
  2200. will ensure the drawing is visible.
  2201. <para>
  2202. The default value is <see langword="true"/>. Set this value to <see langword="false"/> if
  2203. you wish to apply your own transformations to the drawings.
  2204. </para>
  2205. </value>
  2206. </member>
  2207. <member name="P:SharpVectors.Converters.SvgControl.Drawings">
  2208. <summary>
  2209. Gets the drawing from the SVG file conversion.
  2210. </summary>
  2211. <value>
  2212. An instance of the <see cref="T:System.Windows.Media.DrawingGroup"/> specifying the converted drawings
  2213. which is rendered in this canvas.
  2214. </value>
  2215. </member>
  2216. <member name="P:SharpVectors.Converters.SvgControl.MessageFontFamily">
  2217. <summary>
  2218. Gets or sets the font family of the desired font for the message text.
  2219. </summary>
  2220. <value>
  2221. A <see cref="T:System.Windows.Media.FontFamily"/> specifying the font for the message text.
  2222. The default value is <see cref="P:System.Windows.SystemFonts.MessageFontFamily"/>.
  2223. </value>
  2224. </member>
  2225. <member name="P:SharpVectors.Converters.SvgControl.MessageFontSize">
  2226. <summary>
  2227. Gets or sets the size of the desired font for the message text.
  2228. </summary>
  2229. <value>
  2230. A value specifying the font size of the message text. The default is 48 pixels.
  2231. The font size must be a positive number.
  2232. </value>
  2233. </member>
  2234. <member name="P:SharpVectors.Converters.SvgControl.MessageOpacity">
  2235. <summary>
  2236. Gets or sets the opacity factor applied to the entire message text when it is
  2237. rendered in the user interface (UI).
  2238. </summary>
  2239. <value>
  2240. The opacity factor. Default opacity is 1.0. Expected values are between 0.0 and 1.0.
  2241. </value>
  2242. </member>
  2243. <member name="P:SharpVectors.Converters.SvgControl.MessageText">
  2244. <summary>
  2245. Gets or sets the content of the message.
  2246. </summary>
  2247. <value>
  2248. A <see cref="T:System.String"/> specifying the content of the message text.
  2249. The default is "Loading...". This value can be overriden in the <see cref="M:SharpVectors.Converters.SvgControl.Unload(System.Boolean,System.String)"/> method.
  2250. </value>
  2251. </member>
  2252. <member name="P:SharpVectors.Converters.SvgControl.MessageBackground">
  2253. <summary>
  2254. Gets or sets a brush that describes the background of a message text.
  2255. </summary>
  2256. <value>
  2257. A <see cref="T:System.Windows.Media.Brush"/> specifying the brush that is used to fill the background of the
  2258. message text. The default is <see cref="P:System.Windows.Media.Brushes.PapayaWhip"/>. If set to <see langword="null"/>,
  2259. the background will not be drawn.
  2260. </value>
  2261. </member>
  2262. <member name="P:SharpVectors.Converters.SvgControl.MessageFillBrush">
  2263. <summary>
  2264. Gets or sets the brush with which to fill the message text.
  2265. This is optional, and can be <see langword="null"/>. If the brush is <see langword="null"/>, no fill is drawn.
  2266. </summary>
  2267. <value>
  2268. A <see cref="T:System.Windows.Media.Brush"/> specifying the fill of the message text. The default is <see cref="P:System.Windows.Media.Brushes.Gold"/>.
  2269. </value>
  2270. <remarks>
  2271. If both the fill and stroke brushes of the message text are <see langword="null"/>, no text is drawn.
  2272. </remarks>
  2273. </member>
  2274. <member name="P:SharpVectors.Converters.SvgControl.MessageStrokeBrush">
  2275. <summary>
  2276. Gets or sets the brush of the <see cref="T:System.Windows.Media.Pen"/> with which to stroke the message text.
  2277. This is optional, and can be <see langword="null"/>. If the brush is <see langword="null"/>, no stroke is drawn.
  2278. </summary>
  2279. <value>
  2280. A <see cref="T:System.Windows.Media.Brush"/> specifying the brush of the <see cref="T:System.Windows.Media.Pen"/> for stroking the message text.
  2281. The default is <see cref="P:System.Windows.Media.Brushes.Maroon"/>.
  2282. </value>
  2283. <remarks>
  2284. If both the fill and stroke brushes of the message text are <see langword="null"/>, no text is drawn.
  2285. </remarks>
  2286. </member>
  2287. <member name="P:SharpVectors.Converters.SvgControl.BaseUri">
  2288. <summary>
  2289. Gets or sets the base URI of the current application context.
  2290. </summary>
  2291. <value>
  2292. The base URI of the application context.
  2293. </value>
  2294. </member>
  2295. <member name="M:SharpVectors.Converters.SvgControl.Load(System.Uri,System.Boolean)">
  2296. <summary>
  2297. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgControl"/> by using the supplied Uniform Resource Identifier (URI)
  2298. and optionally processing the result asynchronously.
  2299. </summary>
  2300. <param name="uriSource">A reference to the SVG source file.</param>
  2301. <param name="useAsync">
  2302. A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
  2303. the SVG conversion is processed synchronously.
  2304. </param>
  2305. <returns>
  2306. A value that indicates whether the operation was successful. This is <see langword="true"/>
  2307. if successful, otherwise, it is <see langword="false"/>.
  2308. </returns>
  2309. </member>
  2310. <member name="M:SharpVectors.Converters.SvgControl.Load(System.IO.Stream,System.Boolean,System.Boolean)">
  2311. <summary>
  2312. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgControl"/> by accessing a stream
  2313. and optionally processing the result asynchronously.
  2314. </summary>
  2315. <param name="streamSource">The stream source that sets the SVG source value.</param>
  2316. <param name="useCopyStream">
  2317. A value specifying whether to use a copy of the stream. The default is <see langword="true"/>,
  2318. the SVG source stream is copied, rendered and stored.
  2319. </param>
  2320. <param name="useAsync">
  2321. A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
  2322. the SVG conversion is processed synchronously.
  2323. </param>
  2324. <returns>
  2325. A value that indicates whether the operation was successful. This is <see langword="true"/>
  2326. if successful, otherwise, it is <see langword="false"/>.
  2327. </returns>
  2328. <remarks>
  2329. The control will by default create a copy of the source stream to prevent any effect of disposing.
  2330. If the source stream is stored, then use the <paramref name="useCopyStream"/> to prevent the control
  2331. from creating its own copy.
  2332. </remarks>
  2333. </member>
  2334. <member name="M:SharpVectors.Converters.SvgControl.LoadAsync(System.Uri)">
  2335. <summary>
  2336. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgControl"/> by using the supplied Uniform Resource Identifier (URI)
  2337. and processing the result asynchronously.
  2338. </summary>
  2339. <param name="uriSource">A reference to the SVG source file.</param>
  2340. <returns>
  2341. A value that indicates whether the operation was successful. This is <see langword="true"/>
  2342. if successful, otherwise, it is <see langword="false"/>.
  2343. </returns>
  2344. </member>
  2345. <member name="M:SharpVectors.Converters.SvgControl.LoadAsync(System.IO.Stream,System.Boolean)">
  2346. <summary>
  2347. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgControl"/> by accessing a stream
  2348. and processing the result asynchronously.
  2349. </summary>
  2350. <param name="streamSource">The stream source that sets the SVG source value.</param>
  2351. <param name="useCopyStream">
  2352. A value specifying whether to use a copy of the stream. The default is <see langword="true"/>,
  2353. the SVG source stream is copied, rendered and stored.
  2354. </param>
  2355. <returns>
  2356. A value that indicates whether the operation was successful. This is <see langword="true"/>
  2357. if successful, otherwise, it is <see langword="false"/>.
  2358. </returns>
  2359. <remarks>
  2360. The control will by default create a copy of the source stream to prevent any effect of disposing.
  2361. If the source stream is stored, then use the <paramref name="useCopyStream"/> to prevent the control
  2362. from creating its own copy.
  2363. </remarks>
  2364. </member>
  2365. <member name="M:SharpVectors.Converters.SvgControl.Unload(System.Boolean,System.String)">
  2366. <summary>
  2367. This clears the <see cref="T:SharpVectors.Converters.SvgControl"/> of any drawn diagram and optionally displays a
  2368. message.
  2369. </summary>
  2370. <param name="displayMessage">
  2371. A value indicating whether to display a message after clearing the SVG rendered diagram.
  2372. The value is <see langword="false"/>, not message is displayed.
  2373. </param>
  2374. <param name="message">
  2375. This specifies the message to be displayed after clearing the diagram. Setting this parameter
  2376. to a non-empty text will override any message set in the <see cref="P:SharpVectors.Converters.SvgControl.MessageText"/>.
  2377. The default value is <see cref="F:System.String.Empty"/>.
  2378. </param>
  2379. </member>
  2380. <member name="M:SharpVectors.Converters.SvgControl.OnInitialized(System.EventArgs)">
  2381. <summary>
  2382. Raises the Initialized event. This method is invoked whenever IsInitialized is set to true.
  2383. </summary>
  2384. <param name="e">Event data for the event.</param>
  2385. </member>
  2386. <member name="M:SharpVectors.Converters.SvgControl.OnSettingsChanged">
  2387. <summary>
  2388. This handles changes in the rendering settings of this control.
  2389. </summary>
  2390. </member>
  2391. <member name="M:SharpVectors.Converters.SvgControl.OnAutoSizeChanged">
  2392. <summary>
  2393. This handles changes in the automatic resizing property of this control.
  2394. </summary>
  2395. </member>
  2396. <member name="M:SharpVectors.Converters.SvgControl.CreateDrawing">
  2397. <summary>
  2398. Performs the conversion of a valid SVG source to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
  2399. </summary>
  2400. <returns>
  2401. This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
  2402. returns <see langword="null"/>.
  2403. </returns>
  2404. </member>
  2405. <member name="M:SharpVectors.Converters.SvgControl.CreateDrawing(System.Uri,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  2406. <summary>
  2407. Performs the conversion of a valid SVG source file to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
  2408. </summary>
  2409. <param name="svgSource">A <see cref="T:System.Uri"/> defining the path to the SVG source.</param>
  2410. <param name="settings">
  2411. This specifies the settings used by the rendering or drawing engine.
  2412. If this is <see langword="null"/>, the default settings is used.
  2413. </param>
  2414. <returns>
  2415. This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
  2416. returns <see langword="null"/>.
  2417. </returns>
  2418. </member>
  2419. <member name="M:SharpVectors.Converters.SvgControl.CreateDrawing(System.IO.Stream,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  2420. <summary>
  2421. Performs the conversion of a valid SVG source stream to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
  2422. </summary>
  2423. <param name="svgStream">A stream providing access to the SVG source data.</param>
  2424. <param name="settings">
  2425. This specifies the settings used by the rendering or drawing engine.
  2426. If this is <see langword="null"/>, the default settings is used.
  2427. </param>
  2428. <returns>
  2429. This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
  2430. returns <see langword="null"/>.
  2431. </returns>
  2432. </member>
  2433. <member name="T:SharpVectors.Converters.SvgConverter">
  2434. <summary>
  2435. This is the <see langword="abstract"/> base class for all <c>SVG</c> to WPF converters.
  2436. </summary>
  2437. </member>
  2438. <member name="F:SharpVectors.Converters.SvgConverter._wpfWindow">
  2439. <summary>
  2440. Required designer variable.
  2441. </summary>
  2442. </member>
  2443. <member name="M:SharpVectors.Converters.SvgConverter.#ctor">
  2444. <overloads>
  2445. Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgConverter"/> class.
  2446. </overloads>
  2447. <summary>
  2448. Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgConverter"/> class
  2449. with the default parameters and settings.
  2450. </summary>
  2451. </member>
  2452. <member name="M:SharpVectors.Converters.SvgConverter.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  2453. <summary>
  2454. Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgConverter"/> class
  2455. with the specified drawing or rendering settings.
  2456. </summary>
  2457. <param name="settings">
  2458. This specifies the settings used by the rendering or drawing engine.
  2459. If this is <see langword="null"/>, the default settings is used.
  2460. </param>
  2461. </member>
  2462. <member name="M:SharpVectors.Converters.SvgConverter.#ctor(System.Boolean,System.Boolean,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  2463. <summary>
  2464. Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgConverter"/> class
  2465. with the specified drawing or rendering settings and the saving options.
  2466. </summary>
  2467. <param name="saveXaml">
  2468. This specifies whether to save result object tree in XAML file.
  2469. </param>
  2470. <param name="saveZaml">
  2471. This specifies whether to save result object tree in ZAML file. The
  2472. ZAML is simply a G-Zip compressed XAML format, similar to the SVGZ.
  2473. </param>
  2474. <param name="settings">
  2475. This specifies the settings used by the rendering or drawing engine.
  2476. If this is <see langword="null"/>, the default settings is used.
  2477. </param>
  2478. </member>
  2479. <member name="M:SharpVectors.Converters.SvgConverter.Finalize">
  2480. <summary>
  2481. This allows a converter to attempt to free resources and perform
  2482. other cleanup operations before the converter is reclaimed by
  2483. garbage collection.
  2484. </summary>
  2485. </member>
  2486. <member name="P:SharpVectors.Converters.SvgConverter.SaveXaml">
  2487. <summary>
  2488. Gets or sets a value indicating whether to save the conversion output to the <c>XAML</c> file.
  2489. </summary>
  2490. <value>
  2491. This is <see langword="true"/> if the conversion output is saved to the <c>XAML</c> file; otherwise,
  2492. it is <see langword="false"/>. The default depends on the converter.
  2493. </value>
  2494. </member>
  2495. <member name="P:SharpVectors.Converters.SvgConverter.SaveZaml">
  2496. <summary>
  2497. Gets or sets a value indicating whether to save the conversion output to the <c>ZAML</c> file.
  2498. </summary>
  2499. <value>
  2500. This is <see langword="true"/> if the conversion output is saved to the <c>ZAML</c> file; otherwise,
  2501. it is <see langword="false"/>. The default depends on the converter.
  2502. </value>
  2503. <remarks>
  2504. The <c>ZAML</c> is simply a G-Zip compressed <c>XAML</c> format, similar to the <c>SVGZ</c>.
  2505. </remarks>
  2506. </member>
  2507. <member name="P:SharpVectors.Converters.SvgConverter.UseFrameXamlWriter">
  2508. <summary>
  2509. Gets or sets a value indicating whether to use the .NET framework version of the XAML writer.
  2510. </summary>
  2511. <value>
  2512. This is <see langword="true"/> if the .NET framework version of the <c>XAML</c> writer is used; otherwise,
  2513. a customized XAML writer, <see cref="T:SharpVectors.Converters.XmlXamlWriter"/>, is used. The default is <see langword="false"/>.
  2514. </value>
  2515. <remarks>
  2516. The customized <c>XAML</c> writer is optimized for the conversion process, and it is recommended as the writer,
  2517. unless in cases where it fails to produce accurate result.
  2518. </remarks>
  2519. </member>
  2520. <member name="P:SharpVectors.Converters.SvgConverter.Background">
  2521. <summary>
  2522. Gets or sets a brush that describes the background of a image.
  2523. </summary>
  2524. <value>
  2525. The brush that is used to fill the background of the control.
  2526. The default is <see langword="null"/> or transparent.
  2527. </value>
  2528. </member>
  2529. <member name="P:SharpVectors.Converters.SvgConverter.DrawingSettings">
  2530. <summary>
  2531. Gets the settings used by the rendering or drawing engine.
  2532. </summary>
  2533. <value>
  2534. An instance of <see cref="T:SharpVectors.Renderers.Wpf.WpfDrawingSettings"/> specifying all
  2535. the options for rendering or drawing.
  2536. </value>
  2537. </member>
  2538. <member name="P:SharpVectors.Converters.SvgConverter.SvgWindow">
  2539. <summary>
  2540. Gets the <c>SVG</c> Window object created by this converter.
  2541. </summary>
  2542. <value>An instance of <see cref="T:SharpVectors.Renderers.Utils.WpfSvgWindow"/> specifying the <c>WPF</c> implementation of the <see cref="T:SharpVectors.Dom.Svg.ISvgWindow"/>.</value>
  2543. </member>
  2544. <member name="P:SharpVectors.Converters.SvgConverter.SvgDocument">
  2545. <summary>
  2546. Gets the current <c>SVG</c> Document created by this converter.
  2547. </summary>
  2548. <value>An instance of <see cref="P:SharpVectors.Converters.SvgConverter.SvgDocument"/> specifying the SVG DOM currently opened by the converter;
  2549. or <see langword="null"/> if no <c>SVG</c> document is currently opened.</value>
  2550. </member>
  2551. <member name="P:SharpVectors.Converters.SvgConverter.DpiX">
  2552. <summary>
  2553. Gets the horizontal dots per inch (dpi) of the static image.
  2554. </summary>
  2555. <value>The horizontal dots per inch (dpi) of the image; that is, the dots per inch (dpi) along the x-axis.</value>
  2556. </member>
  2557. <member name="P:SharpVectors.Converters.SvgConverter.DpiY">
  2558. <summary>
  2559. Gets the vertical dots per inch (dpi) of the static image.
  2560. </summary>
  2561. <value>The vertical dots per inch (dpi) of the image; that is, the dots per inch (dpi) along the y-axis.</value>
  2562. </member>
  2563. <member name="M:SharpVectors.Converters.SvgConverter.BeginProcessing(SharpVectors.Renderers.Wpf.WpfDrawingDocument)">
  2564. <summary>
  2565. </summary>
  2566. <param name="drawingDocument"></param>
  2567. </member>
  2568. <member name="M:SharpVectors.Converters.SvgConverter.EndProcessing">
  2569. <summary>
  2570. </summary>
  2571. </member>
  2572. <member name="M:SharpVectors.Converters.SvgConverter.GetBitmapEncoder(SharpVectors.Converters.ImageEncoderType)">
  2573. <summary>
  2574. </summary>
  2575. <param name="encoderType"></param>
  2576. <returns></returns>
  2577. </member>
  2578. <member name="M:SharpVectors.Converters.SvgConverter.GetImageFileExtention(SharpVectors.Converters.ImageEncoderType)">
  2579. <summary>
  2580. </summary>
  2581. <param name="encoderType"></param>
  2582. <returns></returns>
  2583. </member>
  2584. <member name="M:SharpVectors.Converters.SvgConverter.Dispose">
  2585. <overloads>
  2586. This releases all resources used by the <see cref="T:SharpVectors.Converters.SvgConverter"/> object.
  2587. </overloads>
  2588. <summary>
  2589. This releases all resources used by the <see cref="T:SharpVectors.Converters.SvgConverter"/> object.
  2590. </summary>
  2591. </member>
  2592. <member name="M:SharpVectors.Converters.SvgConverter.Dispose(System.Boolean)">
  2593. <summary>
  2594. This releases the unmanaged resources used by the <see cref="T:SharpVectors.Converters.SvgConverter"/>
  2595. and optionally releases the managed resources.
  2596. </summary>
  2597. <param name="disposing">
  2598. This is <see langword="true"/> if managed resources should be
  2599. disposed; otherwise, <see langword="false"/>.
  2600. </param>
  2601. </member>
  2602. <member name="T:SharpVectors.Converters.SvgIcon">
  2603. <summary>
  2604. This is an extension of the WPF <see cref="T:System.Windows.Controls.Image"/> control to provide SVG-based image sources.
  2605. </summary>
  2606. </member>
  2607. <member name="F:SharpVectors.Converters.SvgIcon.FillProperty">
  2608. <summary>
  2609. </summary>
  2610. </member>
  2611. <member name="F:SharpVectors.Converters.SvgIcon.StrokeProperty">
  2612. <summary>
  2613. </summary>
  2614. </member>
  2615. <member name="M:SharpVectors.Converters.SvgIcon.#ctor">
  2616. <summary>
  2617. Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgIcon"/> class.
  2618. </summary>
  2619. </member>
  2620. <member name="T:SharpVectors.Converters.SvgImageBase">
  2621. <summary>
  2622. This is an <see langword="abstract"/> implementation of a markup extension that enables the creation
  2623. of <see cref="T:System.Windows.Media.DrawingImage"/> from SVG sources.
  2624. </summary>
  2625. </member>
  2626. <member name="M:SharpVectors.Converters.SvgImageBase.#ctor">
  2627. <summary>
  2628. Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgImageBase"/>
  2629. class with the default parameters.
  2630. </summary>
  2631. </member>
  2632. <member name="P:SharpVectors.Converters.SvgImageBase.OptimizePath">
  2633. <summary>
  2634. Gets or sets a value indicating whether the path geometry is
  2635. optimized using the <see cref="T:System.Windows.Media.StreamGeometry"/>.
  2636. </summary>
  2637. <value>
  2638. This is <see langword="true"/> if the path geometry is optimized using the <see cref="T:System.Windows.Media.StreamGeometry"/>;
  2639. otherwise, it is <see langword="false"/>. The default is <see langword="true"/>.
  2640. </value>
  2641. </member>
  2642. <member name="P:SharpVectors.Converters.SvgImageBase.TextAsGeometry">
  2643. <summary>
  2644. Gets or sets a value indicating whether the texts are rendered as
  2645. path geometry.
  2646. </summary>
  2647. <value>
  2648. This is <see langword="true"/> if texts are rendered as path
  2649. geometries; otherwise, this is <see langword="false"/>. The default
  2650. is <see langword="false"/>.
  2651. </value>
  2652. </member>
  2653. <member name="P:SharpVectors.Converters.SvgImageBase.IncludeRuntime">
  2654. <summary>
  2655. Gets or sets a value indicating whether the <c>SharpVectors.Runtime.dll</c>
  2656. classes are used in the generated output.
  2657. </summary>
  2658. <value>
  2659. This is <see langword="true"/> if the <c>SharpVectors.Runtime.dll</c>
  2660. classes and types are used in the generated output; otherwise, it is
  2661. <see langword="false"/>. The default is <see langword="true"/>.
  2662. </value>
  2663. <remarks>
  2664. The use of the <c>SharpVectors.Runtime.dll</c> prevents the hard-coded
  2665. font path generated by the <see cref="T:System.Windows.Media.FormattedText"/> class, support
  2666. for embedded images etc.
  2667. </remarks>
  2668. </member>
  2669. <member name="P:SharpVectors.Converters.SvgImageBase.CultureInfo">
  2670. <summary>
  2671. Gets or sets the main culture information used for rendering texts.
  2672. </summary>
  2673. <value>
  2674. An instance of the <see cref="P:SharpVectors.Converters.SvgImageBase.CultureInfo"/> specifying the main
  2675. culture information for texts. The default is the English culture.
  2676. </value>
  2677. <remarks>
  2678. <para>
  2679. This is the culture information passed to the <see cref="T:System.Windows.Media.FormattedText"/>
  2680. class instance for the text rendering.
  2681. </para>
  2682. <para>
  2683. The library does not currently provide any means of splitting texts
  2684. into its multi-language parts.
  2685. </para>
  2686. </remarks>
  2687. </member>
  2688. <member name="P:SharpVectors.Converters.SvgImageBase.AppName">
  2689. <summary>
  2690. Gets or sets the project or application name of the target assembly.
  2691. </summary>
  2692. <value>
  2693. A string specifying the application project name.
  2694. </value>
  2695. <remarks>
  2696. This is optional and is only used to resolve the resource Uri at the design time.
  2697. </remarks>
  2698. </member>
  2699. <member name="M:SharpVectors.Converters.SvgImageBase.GetDrawing(System.Uri)">
  2700. <summary>
  2701. This converts the SVG resource specified by the Uri to <see cref="T:System.Windows.Media.DrawingGroup"/>.
  2702. </summary>
  2703. <param name="svgSource">A <see cref="T:System.Uri"/> specifying the source of the SVG resource.</param>
  2704. <returns>A <see cref="T:System.Windows.Media.DrawingGroup"/> of the converted SVG resource.</returns>
  2705. </member>
  2706. <member name="M:SharpVectors.Converters.SvgImageBase.GetImage(System.Uri)">
  2707. <summary>
  2708. This converts the SVG resource specified by the Uri to <see cref="T:System.Windows.Media.DrawingImage"/>.
  2709. </summary>
  2710. <param name="svgSource">A <see cref="T:System.Uri"/> specifying the source of the SVG resource.</param>
  2711. <returns>A <see cref="T:System.Windows.Media.DrawingImage"/> of the converted SVG resource.</returns>
  2712. <remarks>
  2713. This uses the <see cref="M:SharpVectors.Converters.SvgImageBase.GetDrawing(System.Uri)"/> method to convert the SVG resource to <see cref="T:System.Windows.Media.DrawingGroup"/>,
  2714. which is then wrapped in <see cref="T:System.Windows.Media.DrawingImage"/>.
  2715. </remarks>
  2716. </member>
  2717. <member name="T:SharpVectors.Converters.SvgImageConverterExtension">
  2718. <summary>
  2719. This implements a markup extension that enables the creation
  2720. of <see cref="T:System.Windows.Media.DrawingImage"/> from SVG sources.
  2721. </summary>
  2722. <remarks>
  2723. The SVG source file can be:
  2724. <list type="bullet">
  2725. <item>
  2726. <description>From the web</description>
  2727. </item>
  2728. <item>
  2729. <description>From the local computer (relative or absolute paths)</description>
  2730. </item>
  2731. <item>
  2732. <description>From the resources.</description>
  2733. </item>
  2734. </list>
  2735. <para>
  2736. The rendering settings are provided as properties for customizations.
  2737. </para>
  2738. </remarks>
  2739. </member>
  2740. <member name="M:SharpVectors.Converters.SvgImageConverterExtension.#ctor">
  2741. <overloads>
  2742. Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgImageConverterExtension"/> class.
  2743. </overloads>
  2744. <summary>
  2745. Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgImageConverterExtension"/>
  2746. class with the default parameters.
  2747. </summary>
  2748. </member>
  2749. <member name="M:SharpVectors.Converters.SvgImageConverterExtension.ProvideValue(System.IServiceProvider)">
  2750. <summary>
  2751. Performs the conversion of a valid SVG source file to the
  2752. <see cref="T:System.Windows.Media.DrawingImage"/> that is set as the value of the target
  2753. property for this markup extension.
  2754. </summary>
  2755. <param name="serviceProvider">
  2756. Object that can provide services for the markup extension.
  2757. </param>
  2758. <returns>
  2759. This returns <see cref="T:System.Windows.Media.DrawingImage"/> if successful; otherwise, it
  2760. returns <see langword="null"/>.
  2761. </returns>
  2762. </member>
  2763. <member name="M:SharpVectors.Converters.SvgImageConverterExtension.ResolveUri(System.String)">
  2764. <summary>
  2765. Converts the SVG source file to <see cref="T:System.Uri"/>
  2766. </summary>
  2767. <param name="inputParameter">
  2768. Object that can provide services for the markup extension.
  2769. </param>
  2770. <returns>
  2771. Returns the valid <see cref="T:System.Uri"/> of the SVG source path if
  2772. successful; otherwise, it returns <see langword="null"/>.
  2773. </returns>
  2774. </member>
  2775. <member name="T:SharpVectors.Converters.SvgImageExtension">
  2776. <summary>
  2777. This implements a markup extension that enables the creation
  2778. of <see cref="T:System.Windows.Media.DrawingImage"/> from SVG sources.
  2779. </summary>
  2780. <remarks>
  2781. The SVG source file can be:
  2782. <list type="bullet">
  2783. <item>
  2784. <description>From the web</description>
  2785. </item>
  2786. <item>
  2787. <description>From the local computer (relative or absolute paths)</description>
  2788. </item>
  2789. <item>
  2790. <description>From the resources.</description>
  2791. </item>
  2792. </list>
  2793. <para>
  2794. The rendering settings are provided as properties for customizations.
  2795. </para>
  2796. </remarks>
  2797. </member>
  2798. <member name="M:SharpVectors.Converters.SvgImageExtension.#ctor">
  2799. <overloads>
  2800. Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgImageExtension"/> class.
  2801. </overloads>
  2802. <summary>
  2803. Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgImageExtension"/>
  2804. class with the default parameters.
  2805. </summary>
  2806. </member>
  2807. <member name="M:SharpVectors.Converters.SvgImageExtension.#ctor(System.String)">
  2808. <summary>
  2809. Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgImageExtension"/>
  2810. class with the specified SVG file path.
  2811. </summary>
  2812. <param name="svgPath"></param>
  2813. </member>
  2814. <member name="P:SharpVectors.Converters.SvgImageExtension.Source">
  2815. <summary>
  2816. Gets or sets the SVG source file.
  2817. </summary>
  2818. <value>
  2819. A string specifying the path of the SVG source file.
  2820. The default is <see langword="null"/>.
  2821. </value>
  2822. </member>
  2823. <member name="M:SharpVectors.Converters.SvgImageExtension.ProvideValue(System.IServiceProvider)">
  2824. <summary>
  2825. Performs the conversion of a valid SVG source file to the
  2826. <see cref="T:System.Windows.Media.DrawingImage"/> that is set as the value of the target
  2827. property for this markup extension.
  2828. </summary>
  2829. <param name="serviceProvider">
  2830. Object that can provide services for the markup extension.
  2831. </param>
  2832. <returns>
  2833. This returns <see cref="T:System.Windows.Media.DrawingImage"/> if successful; otherwise, it
  2834. returns <see langword="null"/>.
  2835. </returns>
  2836. </member>
  2837. <member name="M:SharpVectors.Converters.SvgImageExtension.ResolveUri(System.IServiceProvider)">
  2838. <summary>
  2839. Converts the SVG source file to <see cref="T:System.Uri"/>
  2840. </summary>
  2841. <param name="serviceProvider">
  2842. Object that can provide services for the markup extension.
  2843. </param>
  2844. <returns>
  2845. Returns the valid <see cref="T:System.Uri"/> of the SVG source path if
  2846. successful; otherwise, it returns <see langword="null"/>.
  2847. </returns>
  2848. </member>
  2849. <member name="T:SharpVectors.Converters.SvgViewbox">
  2850. <summary>
  2851. This is a <see cref="T:System.Windows.Controls.Viewbox"/> control for viewing <c>SVG</c> file in <c>WPF</c> applications.
  2852. </summary>
  2853. <remarks>
  2854. It wraps the drawing canvas, <see cref="T:SharpVectors.Runtime.SvgDrawingCanvas"/>, instead of image control, therefore any
  2855. interactivity support implemented in the drawing canvas will be available in the <see cref="T:System.Windows.Controls.Viewbox"/>.
  2856. </remarks>
  2857. <seealso cref="T:SharpVectors.Converters.SvgCanvas"/>
  2858. </member>
  2859. <member name="F:SharpVectors.Converters.SvgViewbox.SourceProperty">
  2860. <summary>
  2861. Identifies the <see cref="P:SharpVectors.Converters.SvgViewbox.Source"/> dependency property.
  2862. </summary>
  2863. </member>
  2864. <member name="F:SharpVectors.Converters.SvgViewbox.UriSourceProperty">
  2865. <summary>
  2866. Identifies the <see cref="P:SharpVectors.Converters.SvgViewbox.UriSource"/> dependency property.
  2867. </summary>
  2868. </member>
  2869. <member name="F:SharpVectors.Converters.SvgViewbox.SvgSourceProperty">
  2870. <summary>
  2871. Identifies the <see cref="P:SharpVectors.Converters.SvgViewbox.SvgSource"/> dependency property.
  2872. </summary>
  2873. </member>
  2874. <member name="F:SharpVectors.Converters.SvgViewbox.StreamSourceProperty">
  2875. <summary>
  2876. Identifies the <see cref="P:SharpVectors.Converters.SvgViewbox.StreamSource"/> dependency property.
  2877. </summary>
  2878. </member>
  2879. <member name="F:SharpVectors.Converters.SvgViewbox.MessageFontFamilyProperty">
  2880. <summary>
  2881. The DependencyProperty for the MessageFontFamily property.
  2882. <para>
  2883. Flags: Can be used in style rules
  2884. </para>
  2885. <para>
  2886. Default Value: System Dialog Font
  2887. </para>
  2888. </summary>
  2889. </member>
  2890. <member name="F:SharpVectors.Converters.SvgViewbox.MessageFontSizeProperty">
  2891. <summary>
  2892. The DependencyProperty for the MessageFontSize property.
  2893. <para>
  2894. Flags: Can be used in style rules
  2895. </para>
  2896. <para>
  2897. Default Value: 48 pixels
  2898. </para>
  2899. </summary>
  2900. </member>
  2901. <member name="F:SharpVectors.Converters.SvgViewbox.MessageOpacityProperty">
  2902. <summary>
  2903. The DependencyProperty for the MessageOpacity property.
  2904. <para>
  2905. Flags: Can be used in style rules
  2906. </para>
  2907. <para>
  2908. Default Value: 1 (full opacity)
  2909. </para>
  2910. </summary>
  2911. </member>
  2912. <member name="F:SharpVectors.Converters.SvgViewbox.MessageTextProperty">
  2913. <summary>
  2914. The DependencyProperty for the MessageText property.
  2915. <para>
  2916. Flags: Can be used in style rules
  2917. </para>
  2918. <para>
  2919. Default Value: "Loading..."
  2920. </para>
  2921. </summary>
  2922. </member>
  2923. <member name="F:SharpVectors.Converters.SvgViewbox.MessageBackgroundProperty">
  2924. <summary>
  2925. The DependencyProperty for the MessageBackground property.
  2926. <para>
  2927. Flags: Can be used in style rules
  2928. </para>
  2929. <para>
  2930. Default Value: <see cref="P:System.Windows.Media.Brushes.PapayaWhip"/>
  2931. </para>
  2932. </summary>
  2933. </member>
  2934. <member name="F:SharpVectors.Converters.SvgViewbox.MessageFillBrushProperty">
  2935. <summary>
  2936. The DependencyProperty for the MessageFillBrush property.
  2937. <para>
  2938. Flags: Can be used in style rules
  2939. </para>
  2940. <para>
  2941. Default Value: <see cref="P:System.Windows.Media.Brushes.Gold"/>
  2942. </para>
  2943. </summary>
  2944. </member>
  2945. <member name="F:SharpVectors.Converters.SvgViewbox.MessageStrokeBrushProperty">
  2946. <summary>
  2947. The DependencyProperty for the MessageStrokeBrush property.
  2948. <para>
  2949. Flags: Can be used in style rules
  2950. </para>
  2951. <para>
  2952. Default Value: <see cref="P:System.Windows.Media.Brushes.Maroon"/>
  2953. </para>
  2954. </summary>
  2955. </member>
  2956. <member name="F:SharpVectors.Converters.SvgViewbox.AppNameProperty">
  2957. <summary>
  2958. The <see cref="T:System.Windows.DependencyProperty"/> for the <c>AppName</c> property.
  2959. </summary>
  2960. </member>
  2961. <member name="M:SharpVectors.Converters.SvgViewbox.#ctor">
  2962. <summary>
  2963. Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgViewbox"/> class.
  2964. </summary>
  2965. </member>
  2966. <member name="M:SharpVectors.Converters.SvgViewbox.#cctor">
  2967. <summary>
  2968. Static constructor to define metadata for the control (and link it to the style in Generic.xaml).
  2969. </summary>
  2970. </member>
  2971. <member name="E:SharpVectors.Converters.SvgViewbox.Alert">
  2972. <summary>
  2973. This event occurs when an alert message needs to be displayed.
  2974. </summary>
  2975. <remarks>
  2976. <para>If this event is not handled, the control may display the alert message using the standard message dialog.</para>
  2977. <para>
  2978. If you do not want to display the alert messages, handle this event and set <see cref="P:SharpVectors.Runtime.SvgAlertArgs.Handled"/>
  2979. property to <see langword="true"/>.
  2980. </para>
  2981. </remarks>
  2982. </member>
  2983. <member name="E:SharpVectors.Converters.SvgViewbox.Error">
  2984. <summary>
  2985. This event occurs when an error message needs to be displayed.
  2986. </summary>
  2987. <remarks>
  2988. <para>If this event is not handled, the control may display the error message using the standard message dialog.</para>
  2989. <para>
  2990. If you do not want to display the error messages, handle this event and set <see cref="P:SharpVectors.Runtime.SvgErrorArgs.Handled"/>
  2991. property to <see langword="true"/>.
  2992. </para>
  2993. </remarks>
  2994. </member>
  2995. <member name="P:SharpVectors.Converters.SvgViewbox.AppName">
  2996. <summary>
  2997. Gets or sets the <c>name</c> of the parent assembly for this element.
  2998. </summary>
  2999. <value>
  3000. A string containing the name of the parent assembly or the name of the assembly containing <c>SVG</c> file
  3001. referenced on this control in XAML, if the source type is <see cref="T:System.Uri"/>.
  3002. </value>
  3003. </member>
  3004. <member name="P:SharpVectors.Converters.SvgViewbox.AppTitle">
  3005. <summary>
  3006. Gets or sets the application title, which is used to display the alert and error messages not handled
  3007. by the user.
  3008. </summary>
  3009. <value>
  3010. A string containg the application title. This cannot be <see langword="null"/> or empty.
  3011. The default is <c>SharpVectors</c>.
  3012. </value>
  3013. </member>
  3014. <member name="P:SharpVectors.Converters.SvgViewbox.Source">
  3015. <summary>
  3016. Gets or sets the path to the <c>SVG</c> file to load into this <see cref="T:System.Windows.Controls.Viewbox"/>.
  3017. </summary>
  3018. <value>
  3019. A <see cref="T:System.Uri"/> specifying the path to the <c>SVG</c> source file. The file can be located on a computer,
  3020. network or assembly resources. Settings this to <see langword="null"/> will close any rendered <c>SVG</c> diagram.
  3021. </value>
  3022. <seealso cref="P:SharpVectors.Converters.SvgViewbox.UriSource"/>
  3023. <seealso cref="P:SharpVectors.Converters.SvgViewbox.SvgSource"/>
  3024. <seealso cref="P:SharpVectors.Converters.SvgViewbox.StreamSource"/>
  3025. </member>
  3026. <member name="P:SharpVectors.Converters.SvgViewbox.UriSource">
  3027. <summary>
  3028. Gets or sets the path to the <c>SVG</c> file to load into this <see cref="T:System.Windows.Controls.Viewbox"/>.
  3029. </summary>
  3030. <value>
  3031. A <see cref="T:System.Uri"/> specifying the path to the <c>SVG</c> source file. The file can be located on a computer,
  3032. network or assembly resources. Settings this to <see langword="null"/> will close any rendered <c>SVG</c> diagram.
  3033. </value>
  3034. <remarks>
  3035. This is the same as the <see cref="P:SharpVectors.Converters.SvgViewbox.Source"/> property, and added for consistency.
  3036. </remarks>
  3037. <seealso cref="P:SharpVectors.Converters.SvgViewbox.SvgSource"/>
  3038. <seealso cref="P:SharpVectors.Converters.SvgViewbox.StreamSource"/>
  3039. </member>
  3040. <member name="P:SharpVectors.Converters.SvgViewbox.SvgSource">
  3041. <summary>
  3042. Gets or sets the <c>SVG</c> contents to load into this <see cref="T:System.Windows.Controls.Viewbox"/>.
  3043. </summary>
  3044. <value>
  3045. A <see cref="T:System.String"/> specifying the embedded <c>SVG</c> contents.
  3046. Settings this to <see langword="null"/> will close any opened diagram.
  3047. </value>
  3048. <seealso cref="P:SharpVectors.Converters.SvgViewbox.UriSource"/>
  3049. <seealso cref="P:SharpVectors.Converters.SvgViewbox.StreamSource"/>
  3050. </member>
  3051. <member name="P:SharpVectors.Converters.SvgViewbox.StreamSource">
  3052. <summary>
  3053. Gets or sets the <see cref="T:System.IO.Stream"/> to the SVG source to load into this <see cref="T:System.Windows.Controls.Viewbox"/>.
  3054. </summary>
  3055. <value>
  3056. A <see cref="T:System.IO.Stream"/> specifying the stream to the SVG source.
  3057. Settings this to <see langword="null"/> will close any opened diagram.
  3058. </value>
  3059. <remarks>
  3060. <para>
  3061. The stream source has precedence over the Uri <see cref="P:SharpVectors.Converters.SvgViewbox.Source"/> property.
  3062. If set (not <see langword="null"/>), the stream source will be rendered instead of the Uri source.
  3063. </para>
  3064. <para>
  3065. WPF controls do not implement the <see cref="T:System.IDisposable"/> interface and cannot properly dispose any
  3066. stream set to it. To avoid this issue and also any problem of the user accidentally closing the stream,
  3067. this control makes a copy of the stream to memory stream.
  3068. </para>
  3069. </remarks>
  3070. <seealso cref="P:SharpVectors.Converters.SvgViewbox.Source"/>
  3071. <seealso cref="P:SharpVectors.Converters.SvgViewbox.SvgSource"/>
  3072. <seealso cref="P:SharpVectors.Converters.SvgViewbox.UriSource"/>
  3073. </member>
  3074. <member name="P:SharpVectors.Converters.SvgViewbox.DrawingCanvas">
  3075. <summary>
  3076. Gets the drawing canvas, which is the child of this <see cref="T:System.Windows.Controls.Viewbox"/>.
  3077. </summary>
  3078. <value>
  3079. An instance of the <see cref="T:SharpVectors.Runtime.SvgDrawingCanvas"/> specifying the child
  3080. of this <see cref="T:System.Windows.Controls.Viewbox"/>, which handles the rendering.
  3081. </value>
  3082. </member>
  3083. <member name="P:SharpVectors.Converters.SvgViewbox.Drawings">
  3084. <summary>
  3085. Gets the drawing from the SVG file conversion.
  3086. </summary>
  3087. <value>
  3088. An instance of the <see cref="T:System.Windows.Media.DrawingGroup"/> specifying the converted drawings
  3089. which is rendered in the canvas and displayed in the this viewbox.
  3090. </value>
  3091. </member>
  3092. <member name="P:SharpVectors.Converters.SvgViewbox.AutoSize">
  3093. <summary>
  3094. Gets or sets a value indicating whether to automatically resize this
  3095. <see cref="T:System.Windows.Controls.Viewbox"/> based on the size of the loaded drawing.
  3096. </summary>
  3097. <value>
  3098. This is <see langword="true"/> if this <see cref="T:System.Windows.Controls.Viewbox"/> is automatically resized based on the size of
  3099. the loaded drawing; otherwise, it is <see langword="false"/>. The default is <see langword="false"/>, and
  3100. the user-defined size or the parent assigned layout size is used.
  3101. </value>
  3102. </member>
  3103. <member name="P:SharpVectors.Converters.SvgViewbox.OptimizePath">
  3104. <summary>
  3105. Gets or sets a value indicating whether the path geometry is
  3106. optimized using the <see cref="T:System.Windows.Media.StreamGeometry"/>.
  3107. </summary>
  3108. <value>
  3109. This is <see langword="true"/> if the path geometry is optimized using the <see cref="T:System.Windows.Media.StreamGeometry"/>;
  3110. otherwise, it is <see langword="false"/>. The default is <see langword="true"/>.
  3111. </value>
  3112. </member>
  3113. <member name="P:SharpVectors.Converters.SvgViewbox.TextAsGeometry">
  3114. <summary>
  3115. Gets or sets a value indicating whether the texts are rendered as path geometry.
  3116. </summary>
  3117. <value>
  3118. This is <see langword="true"/> if texts are rendered as path geometries; otherwise, this is
  3119. <see langword="false"/>. The default is <see langword="false"/>.
  3120. </value>
  3121. <remarks>
  3122. The text features of the <c>SVG</c> format are complex and difficult to fully support without directly reverting
  3123. the text paths (or glyph geometry). This options will, therefore, be removed in future versions of the library,
  3124. as it is not always honored when set to <see langword="false"/>.
  3125. </remarks>
  3126. </member>
  3127. <member name="P:SharpVectors.Converters.SvgViewbox.IncludeRuntime">
  3128. <summary>
  3129. Gets or sets a value indicating whether the <c>SharpVectors.Runtime.dll</c>
  3130. classes are used in the generated output.
  3131. </summary>
  3132. <value>
  3133. This is <see langword="true"/> if the <c>SharpVectors.Runtime.dll</c> classes and types are used in the
  3134. generated output; otherwise, it is <see langword="false"/>. The default is <see langword="true"/>.
  3135. </value>
  3136. <remarks>
  3137. The use of the <c>SharpVectors.Runtime.dll</c> prevents the hard-coded font path generated by the
  3138. <see cref="T:System.Windows.Media.FormattedText"/> class, support for embedded images etc.
  3139. </remarks>
  3140. </member>
  3141. <member name="P:SharpVectors.Converters.SvgViewbox.CultureInfo">
  3142. <summary>
  3143. Gets or sets the main culture information used for rendering texts.
  3144. </summary>
  3145. <value>
  3146. An instance of the <see cref="P:SharpVectors.Converters.SvgViewbox.CultureInfo"/> specifying the main
  3147. culture information for texts. The default is the English culture.
  3148. </value>
  3149. <remarks>
  3150. <para>
  3151. This is the culture information passed to the <see cref="T:System.Windows.Media.FormattedText"/>
  3152. class instance for the text rendering.
  3153. </para>
  3154. <para>
  3155. The library does not currently provide any means of splitting texts into its multi-language parts.
  3156. </para>
  3157. </remarks>
  3158. </member>
  3159. <member name="P:SharpVectors.Converters.SvgViewbox.IgnoreRootViewbox">
  3160. <summary>
  3161. Gets or sets a value to indicate turning off viewbox at the root of the drawing.
  3162. </summary>
  3163. <value>
  3164. For image outputs, this will force the original size to be saved.
  3165. <para>
  3166. The default value is <see langword="false"/>.
  3167. </para>
  3168. </value>
  3169. <remarks>
  3170. There are reported cases where are diagrams displayed in Inkscape program, but will not show when converted.
  3171. These are diagrams on the drawing canvas of Inkspace but outside the svg viewbox.
  3172. <para>
  3173. When converted the drawings are also converted but not displayed due to clipping. Setting this property
  3174. to <see langword="true"/> will clear the clipping region on conversion.
  3175. </para>
  3176. </remarks>
  3177. </member>
  3178. <member name="P:SharpVectors.Converters.SvgViewbox.EnsureViewboxSize">
  3179. <summary>
  3180. Gets or sets a value to indicate preserving the original viewbox size when saving images.
  3181. </summary>
  3182. <value>
  3183. For image outputs, this will force the original size to be saved.
  3184. <para>
  3185. The default value is <see langword="false"/>. However, the ImageSvgConverter converted
  3186. sets this to <see langword="true"/> by default.
  3187. </para>
  3188. </value>
  3189. <remarks>
  3190. Setting this to <see langword="true"/> will cause the rendering process to draw a transparent
  3191. box around the output, if a viewbox is defined. This will ensure that the original image size is saved.
  3192. </remarks>
  3193. </member>
  3194. <member name="P:SharpVectors.Converters.SvgViewbox.EnsureViewboxPosition">
  3195. <summary>
  3196. Gets or sets a value to indicate applying a translate transform to the viewbox to ensure
  3197. it is visible when rendered.
  3198. </summary>
  3199. <value>
  3200. This determines whether a transformation is applied to the rendered drawing. For drawings where the top-left
  3201. position of the viewbox is off the screen, due to negative values, this will ensure the drawing is visible.
  3202. <para>
  3203. The default value is <see langword="true"/>. Set this value to <see langword="false"/> if
  3204. you wish to apply your own transformations to the drawings.
  3205. </para>
  3206. </value>
  3207. </member>
  3208. <member name="P:SharpVectors.Converters.SvgViewbox.MessageFontFamily">
  3209. <summary>
  3210. Gets or sets the font family of the desired font for the message text.
  3211. </summary>
  3212. <value>
  3213. A <see cref="T:System.Windows.Media.FontFamily"/> specifying the font for the message text.
  3214. The default value is <see cref="P:System.Windows.SystemFonts.MessageFontFamily"/>.
  3215. </value>
  3216. </member>
  3217. <member name="P:SharpVectors.Converters.SvgViewbox.MessageFontSize">
  3218. <summary>
  3219. Gets or sets the size of the desired font for the message text.
  3220. </summary>
  3221. <value>
  3222. A value specifying the font size of the message text. The default is 48 pixels.
  3223. The font size must be a positive number.
  3224. </value>
  3225. </member>
  3226. <member name="P:SharpVectors.Converters.SvgViewbox.MessageOpacity">
  3227. <summary>
  3228. Gets or sets the opacity factor applied to the entire message text when it is
  3229. rendered in the user interface (UI).
  3230. </summary>
  3231. <value>
  3232. The opacity factor. Default opacity is 1.0. Expected values are between 0.0 and 1.0.
  3233. </value>
  3234. </member>
  3235. <member name="P:SharpVectors.Converters.SvgViewbox.MessageText">
  3236. <summary>
  3237. Gets or sets the content of the message.
  3238. </summary>
  3239. <value>
  3240. A <see cref="T:System.String"/> specifying the content of the message text.
  3241. The default is "Loading...". This value can be overriden in the <see cref="M:SharpVectors.Converters.SvgViewbox.Unload(System.Boolean,System.String)"/> method.
  3242. </value>
  3243. </member>
  3244. <member name="P:SharpVectors.Converters.SvgViewbox.MessageBackground">
  3245. <summary>
  3246. Gets or sets a brush that describes the background of a message text.
  3247. </summary>
  3248. <value>
  3249. A <see cref="T:System.Windows.Media.Brush"/> specifying the brush that is used to fill the background of the
  3250. message text. The default is <see cref="P:System.Windows.Media.Brushes.PapayaWhip"/>. If set to <see langword="null"/>,
  3251. the background will not be drawn.
  3252. </value>
  3253. </member>
  3254. <member name="P:SharpVectors.Converters.SvgViewbox.MessageFillBrush">
  3255. <summary>
  3256. Gets or sets the brush with which to fill the message text.
  3257. This is optional, and can be <see langword="null"/>. If the brush is <see langword="null"/>, no fill is drawn.
  3258. </summary>
  3259. <value>
  3260. A <see cref="T:System.Windows.Media.Brush"/> specifying the fill of the message text. The default is <see cref="P:System.Windows.Media.Brushes.Gold"/>.
  3261. </value>
  3262. <remarks>
  3263. If both the fill and stroke brushes of the message text are <see langword="null"/>, no text is drawn.
  3264. </remarks>
  3265. </member>
  3266. <member name="P:SharpVectors.Converters.SvgViewbox.MessageStrokeBrush">
  3267. <summary>
  3268. Gets or sets the brush of the <see cref="T:System.Windows.Media.Pen"/> with which to stroke the message text.
  3269. This is optional, and can be <see langword="null"/>. If the brush is <see langword="null"/>, no stroke is drawn.
  3270. </summary>
  3271. <value>
  3272. A <see cref="T:System.Windows.Media.Brush"/> specifying the brush of the <see cref="T:System.Windows.Media.Pen"/> for stroking the message text.
  3273. The default is <see cref="P:System.Windows.Media.Brushes.Maroon"/>.
  3274. </value>
  3275. <remarks>
  3276. If both the fill and stroke brushes of the message text are <see langword="null"/>, no text is drawn.
  3277. </remarks>
  3278. </member>
  3279. <member name="P:SharpVectors.Converters.SvgViewbox.InteractiveMode">
  3280. <summary>
  3281. Gets or sets a value specifying the interactive mode, which controls the level of information attached
  3282. to the generated drawing.
  3283. </summary>
  3284. <value>An enumeration of the type <see cref="T:SharpVectors.Runtime.SvgInteractiveModes"/> specifying the interactive mode.
  3285. The default is <see cref="F:SharpVectors.Runtime.SvgInteractiveModes.None"/>; no interactivity and may change in the future.</value>
  3286. </member>
  3287. <member name="M:SharpVectors.Converters.SvgViewbox.Load(System.Uri,System.Boolean)">
  3288. <summary>
  3289. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgViewbox"/> by using the supplied Uniform Resource Identifier (URI)
  3290. and optionally processing the result asynchronously.
  3291. </summary>
  3292. <param name="uriSource">A reference to the SVG source file.</param>
  3293. <param name="useAsync">
  3294. A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
  3295. the SVG conversion is processed synchronously.
  3296. </param>
  3297. <returns>
  3298. A value that indicates whether the operation was successful. This is <see langword="true"/>
  3299. if successful, otherwise, it is <see langword="false"/>.
  3300. </returns>
  3301. </member>
  3302. <member name="M:SharpVectors.Converters.SvgViewbox.Load(System.String,System.Boolean)">
  3303. <summary>
  3304. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgViewbox"/> by accessing text contents
  3305. and optionally processing the result asynchronously.
  3306. </summary>
  3307. <param name="svgSource">The stream source that sets the SVG source value.</param>
  3308. <param name="useCopyStream">
  3309. A value specifying whether to use a copy of the stream. The default is <see langword="true"/>,
  3310. the SVG source stream is copied, rendered and stored.
  3311. </param>
  3312. <param name="useAsync">
  3313. A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
  3314. the SVG conversion is processed synchronously.
  3315. </param>
  3316. <returns>
  3317. A value that indicates whether the operation was successful. This is <see langword="true"/>
  3318. if successful, otherwise, it is <see langword="false"/>.
  3319. </returns>
  3320. </member>
  3321. <member name="M:SharpVectors.Converters.SvgViewbox.Load(System.IO.Stream,System.Boolean,System.Boolean)">
  3322. <summary>
  3323. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgViewbox"/> by accessing a stream
  3324. and optionally processing the result asynchronously.
  3325. </summary>
  3326. <param name="streamSource">The stream source that sets the SVG source value.</param>
  3327. <param name="useCopyStream">
  3328. A value specifying whether to use a copy of the stream. The default is <see langword="true"/>,
  3329. the SVG source stream is copied, rendered and stored.
  3330. </param>
  3331. <param name="useAsync">
  3332. A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
  3333. the SVG conversion is processed synchronously.
  3334. </param>
  3335. <returns>
  3336. A value that indicates whether the operation was successful. This is <see langword="true"/>
  3337. if successful, otherwise, it is <see langword="false"/>.
  3338. </returns>
  3339. <remarks>
  3340. The control will by default create a copy of the source stream to prevent any effect of disposing.
  3341. If the source stream is stored, then use the <paramref name="useCopyStream"/> to prevent the control
  3342. from creating its own copy.
  3343. </remarks>
  3344. </member>
  3345. <member name="M:SharpVectors.Converters.SvgViewbox.LoadAsync(System.Uri)">
  3346. <summary>
  3347. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgViewbox"/> by using the supplied Uniform Resource Identifier (URI)
  3348. and processing the result asynchronously.
  3349. </summary>
  3350. <param name="uriSource">A reference to the SVG source file.</param>
  3351. <returns>
  3352. A value that indicates whether the operation was successful. This is <see langword="true"/>
  3353. if successful, otherwise, it is <see langword="false"/>.
  3354. </returns>
  3355. </member>
  3356. <member name="M:SharpVectors.Converters.SvgViewbox.LoadAsync(System.String)">
  3357. <summary>
  3358. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgViewbox"/> by accessing text contents
  3359. and processing the result asynchronously.
  3360. </summary>
  3361. <param name="svgSource">The stream source that sets the SVG source value.</param>
  3362. <returns>
  3363. A value that indicates whether the operation was successful. This is <see langword="true"/>
  3364. if successful, otherwise, it is <see langword="false"/>.
  3365. </returns>
  3366. </member>
  3367. <member name="M:SharpVectors.Converters.SvgViewbox.LoadAsync(System.IO.Stream,System.Boolean)">
  3368. <summary>
  3369. This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgViewbox"/> by accessing a stream
  3370. and processing the result asynchronously.
  3371. </summary>
  3372. <param name="streamSource">The stream source that sets the SVG source value.</param>
  3373. <param name="useCopyStream">
  3374. A value specifying whether to use a copy of the stream. The default is <see langword="true"/>,
  3375. the SVG source stream is copied, rendered and stored.
  3376. </param>
  3377. <returns>
  3378. A value that indicates whether the operation was successful. This is <see langword="true"/>
  3379. if successful, otherwise, it is <see langword="false"/>.
  3380. </returns>
  3381. <remarks>
  3382. The control will by default create a copy of the source stream to prevent any effect of disposing.
  3383. If the source stream is stored, then use the <paramref name="useCopyStream"/> to prevent the control
  3384. from creating its own copy.
  3385. </remarks>
  3386. </member>
  3387. <member name="M:SharpVectors.Converters.SvgViewbox.Unload(System.Boolean,System.String)">
  3388. <summary>
  3389. This clears the <see cref="T:SharpVectors.Converters.SvgViewbox"/> of any drawn diagram and optionally displays a
  3390. message.
  3391. </summary>
  3392. <param name="displayMessage">
  3393. A value indicating whether to display a message after clearing the SVG rendered diagram.
  3394. The value is <see langword="false"/>, not message is displayed.
  3395. </param>
  3396. <param name="message">
  3397. This specifies the message to be displayed after clearing the diagram. Setting this parameter
  3398. to a non-empty text will override any message set in the <see cref="P:SharpVectors.Converters.SvgViewbox.MessageText"/>.
  3399. The default value is <see cref="F:System.String.Empty"/>.
  3400. </param>
  3401. </member>
  3402. <member name="M:SharpVectors.Converters.SvgViewbox.GetDrawingSettings">
  3403. <summary>
  3404. Gets the rendering settings or options to be used in rendering the SVG in this control.
  3405. </summary>
  3406. <returns>
  3407. An instance of <see cref="T:SharpVectors.Renderers.Wpf.WpfDrawingSettings"/> specifying the rendering options or settings.
  3408. </returns>
  3409. </member>
  3410. <member name="M:SharpVectors.Converters.SvgViewbox.OnInitialized(System.EventArgs)">
  3411. <summary>
  3412. Raises the Initialized event. This method is invoked whenever IsInitialized is set to true.
  3413. </summary>
  3414. <param name="e">Event data for the event.</param>
  3415. </member>
  3416. <member name="M:SharpVectors.Converters.SvgViewbox.OnSettingsChanged">
  3417. <summary>
  3418. This handles changes in the rendering settings of this control.
  3419. </summary>
  3420. </member>
  3421. <member name="M:SharpVectors.Converters.SvgViewbox.OnAutoSizeChanged">
  3422. <summary>
  3423. This handles changes in the automatic resizing property of this control.
  3424. </summary>
  3425. </member>
  3426. <member name="M:SharpVectors.Converters.SvgViewbox.CreateDrawing">
  3427. <summary>
  3428. Performs the conversion of a valid SVG source to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
  3429. </summary>
  3430. <returns>
  3431. This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it returns <see langword="null"/>.
  3432. </returns>
  3433. </member>
  3434. <member name="M:SharpVectors.Converters.SvgViewbox.CreateDrawing(System.Uri,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  3435. <summary>
  3436. Performs the conversion of a valid SVG source file to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
  3437. </summary>
  3438. <param name="svgSource">A <see cref="T:System.Uri"/> defining the path to the SVG source.</param>
  3439. <param name="settings">
  3440. This specifies the settings used by the rendering or drawing engine.
  3441. If this is <see langword="null"/>, the default settings is used.
  3442. </param>
  3443. <returns>
  3444. This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it returns <see langword="null"/>.
  3445. </returns>
  3446. </member>
  3447. <member name="M:SharpVectors.Converters.SvgViewbox.CreateDrawing(System.IO.Stream,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  3448. <summary>
  3449. Performs the conversion of a valid SVG source stream to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
  3450. </summary>
  3451. <param name="svgStream">A stream providing access to the SVG source data.</param>
  3452. <param name="settings">
  3453. This specifies the settings used by the rendering or drawing engine.
  3454. If this is <see langword="null"/>, the default settings is used.
  3455. </param>
  3456. <returns>
  3457. This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it returns <see langword="null"/>.
  3458. </returns>
  3459. </member>
  3460. <member name="M:SharpVectors.Converters.SvgViewbox.CreateDrawing(System.String,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  3461. <summary>
  3462. Performs the conversion of a valid SVG source stream to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
  3463. </summary>
  3464. <param name="svgSource">A stream providing access to the SVG source data.</param>
  3465. <param name="settings">
  3466. This specifies the settings used by the rendering or drawing engine.
  3467. If this is <see langword="null"/>, the default settings is used.
  3468. </param>
  3469. <returns>
  3470. This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it returns <see langword="null"/>.
  3471. </returns>
  3472. </member>
  3473. <member name="P:SharpVectors.Converters.SvgViewbox.BaseUri">
  3474. <summary>
  3475. Gets or sets the base URI of the current application context.
  3476. </summary>
  3477. <value>
  3478. The base URI of the application context.
  3479. </value>
  3480. </member>
  3481. <member name="P:SharpVectors.Converters.SvgViewbox.DesignMode">
  3482. <inheritdoc/>
  3483. </member>
  3484. <member name="P:SharpVectors.Converters.SvgViewbox.SharpVectors#Dom#Svg#ISvgControl#Width">
  3485. <inheritdoc/>
  3486. </member>
  3487. <member name="P:SharpVectors.Converters.SvgViewbox.SharpVectors#Dom#Svg#ISvgControl#Height">
  3488. <inheritdoc/>
  3489. </member>
  3490. <member name="M:SharpVectors.Converters.SvgViewbox.SharpVectors#Dom#Svg#ISvgControl#HandleAlert(System.String)">
  3491. <inheritdoc/>
  3492. </member>
  3493. <member name="M:SharpVectors.Converters.SvgViewbox.SharpVectors#Dom#Svg#ISvgControl#HandleError(System.String)">
  3494. <inheritdoc/>
  3495. </member>
  3496. <member name="M:SharpVectors.Converters.SvgViewbox.SharpVectors#Dom#Svg#ISvgControl#HandleError(System.Exception)">
  3497. <inheritdoc/>
  3498. </member>
  3499. <member name="M:SharpVectors.Converters.SvgViewbox.SharpVectors#Dom#Svg#ISvgControl#HandleError(System.String,System.Exception)">
  3500. <inheritdoc/>
  3501. </member>
  3502. <member name="T:SharpVectors.Converters.Utils.DirectoryUtils">
  3503. <summary>
  3504. Copies a file or a directory and its contents to a new location.
  3505. </summary>
  3506. </member>
  3507. <member name="P:SharpVectors.Converters.Utils.DirectoryUtils.Recursive">
  3508. <summary>
  3509. Gets or sets a value indicating whether the directory copying is
  3510. recursive, that is includes the sub-directories.
  3511. </summary>
  3512. <value>
  3513. This property is <see langword="true"/> if the sub-directories are
  3514. included in the directory copy; otherwise, it is <see langword="false"/>.
  3515. The default is <see langword="true"/>.
  3516. </value>
  3517. </member>
  3518. <member name="P:SharpVectors.Converters.Utils.DirectoryUtils.Overwrite">
  3519. <summary>
  3520. Gets or sets a value indicating whether an existing file is overwritten.
  3521. </summary>
  3522. <value>
  3523. This property is <see langword="true"/> if existing file is overwritten;
  3524. otherwise, it is <see langword="false"/>. The default is <see langword="true"/>.
  3525. </value>
  3526. </member>
  3527. <member name="P:SharpVectors.Converters.Utils.DirectoryUtils.IncludeSecurity">
  3528. <summary>
  3529. Gets or sets a value indicating whether the security settings of the
  3530. copied file is retained.
  3531. </summary>
  3532. <value>
  3533. This property is <see langword="true"/> if the security settings of the
  3534. file is also copied; otherwise, it is <see langword="false"/>. The
  3535. default is <see langword="false"/>.
  3536. </value>
  3537. </member>
  3538. <member name="P:SharpVectors.Converters.Utils.DirectoryUtils.IncludeHidden">
  3539. <summary>
  3540. Gets or sets a value indicating whether the copy operation includes
  3541. hidden directories and files.
  3542. </summary>
  3543. <value>
  3544. This property is <see langword="true"/> if hidden directories and files
  3545. are included in the copy operation; otherwise, it is
  3546. <see langword="false"/>. The default is <see langword="false"/>.
  3547. </value>
  3548. </member>
  3549. <member name="M:SharpVectors.Converters.Utils.DirectoryUtils.Copy(System.String,System.String)">
  3550. <summary>
  3551. </summary>
  3552. <param name="sourceDir">
  3553. The path of the file or directory to copy.
  3554. </param>
  3555. <param name="targetDir">
  3556. The path to the new location.
  3557. </param>
  3558. </member>
  3559. <member name="T:SharpVectors.Converters.XmlXamlWriter">
  3560. <summary>
  3561. This is a customized XAML writer, which provides Extensible Application
  3562. Markup Language (XAML) serialization of provided runtime objects into XAML.
  3563. </summary>
  3564. <remarks>
  3565. <para>
  3566. This is designed to be used by the SVG to XAML converters, and may not be useful in general applications.
  3567. </para>
  3568. <para>The writer is created with help from the following posts (Archived Forums):</para>
  3569. <para>
  3570. <see href="https://social.msdn.microsoft.com/Forums/vstudio/en-US/c9225e3d-298d-4012-b6c4-663973c426ed/xaml-serialization-replacement?forum=wpf">
  3571. XAML Serialization Replacement
  3572. </see>
  3573. </para>
  3574. <para>
  3575. <see href="https://social.msdn.microsoft.com/Forums/vstudio/en-us/aa271e51-5e56-4e5c-995c-c91804ea55d1/saving-and-loading-of-interface-in-xaml-format-seems-to-have-problems?forum=wpf">
  3576. Saving and Loading of Interface in XAML Format
  3577. </see>
  3578. </para>
  3579. <para>
  3580. <see href="https://social.msdn.microsoft.com/Forums/vstudio/en-US/08aebbf1-0a61-4305-83b2-a0a37bb24002/xamlwriter-markupobject-how-to-?forum=wpf">
  3581. XamlWriter, MarkupObject How to?
  3582. </see>
  3583. </para>
  3584. </remarks>
  3585. </member>
  3586. <member name="M:SharpVectors.Converters.XmlXamlWriter.#ctor">
  3587. <overloads>
  3588. Initializes a new instance of the <see cref="T:SharpVectors.Converters.XmlXamlWriter"/> class.
  3589. </overloads>
  3590. <summary>
  3591. Initializes a new instance of the <see cref="T:SharpVectors.Converters.XmlXamlWriter"/> class with the default settings.
  3592. </summary>
  3593. </member>
  3594. <member name="M:SharpVectors.Converters.XmlXamlWriter.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
  3595. <summary>
  3596. Initializes a new instance of the <see cref="T:SharpVectors.Converters.XmlXamlWriter"/> class with the specified settings.
  3597. </summary>
  3598. <param name="settings">
  3599. An instance of <see cref="T:SharpVectors.Renderers.Wpf.WpfDrawingSettings"/> specifying the rendering options.
  3600. </param>
  3601. </member>
  3602. <member name="P:SharpVectors.Converters.XmlXamlWriter.IncludeNullExtension">
  3603. <summary>
  3604. Gets or sets a value indicating whether to include a null markup extension in the output XAML.
  3605. </summary>
  3606. <value>
  3607. This is <see langword="true"/> if the null markup extension is included in the output XAML; otherwise,
  3608. it is <see langword="false"/>. The default is <see langword="false"/>.
  3609. </value>
  3610. </member>
  3611. <member name="P:SharpVectors.Converters.XmlXamlWriter.IndentSpaces">
  3612. <summary>
  3613. Gets or sets the number of character string to use when indenting.
  3614. </summary>
  3615. <value>
  3616. A non-negative value (from 0 to 8) specifying the number of character string.
  3617. The default is 2 or two spaces.
  3618. </value>
  3619. </member>
  3620. <member name="M:SharpVectors.Converters.XmlXamlWriter.Convert(System.Object)">
  3621. <summary>
  3622. Returns a Extensible Application Markup Language (XAML) string that serializes the provided object.
  3623. </summary>
  3624. <param name="obj">The element to be serialized. Typically, this is the root element of a page or application.</param>
  3625. <returns>
  3626. Extensible Application Markup Language (XAML) string that can be written to a stream or file.
  3627. The logical tree of all elements that fall under the provided obj element will be serialized.
  3628. </returns>
  3629. </member>
  3630. <member name="M:SharpVectors.Converters.XmlXamlWriter.Save(System.Object)">
  3631. <summary>
  3632. Returns a Extensible Application Markup Language (XAML) string that serializes the provided object.
  3633. </summary>
  3634. <param name="obj">The element to be serialized. Typically, this is the root element of a page or application.</param>
  3635. <returns>
  3636. Extensible Application Markup Language (XAML) string that can be written to a stream or file.
  3637. The logical tree of all elements that fall under the provided obj element will be serialized.
  3638. </returns>
  3639. </member>
  3640. <member name="M:SharpVectors.Converters.XmlXamlWriter.Save(System.Object,System.IO.Stream)">
  3641. <summary>
  3642. Saves Extensible Application Markup Language (XAML) information into a provided
  3643. stream to serialize the provided object.
  3644. </summary>
  3645. <param name="obj">The element to be serialized. Typically, this is the root element of a page or application.</param>
  3646. <param name="stream">Destination stream for the serialized XAML information.</param>
  3647. </member>
  3648. <member name="M:SharpVectors.Converters.XmlXamlWriter.Save(System.Object,System.IO.TextWriter)">
  3649. <summary>
  3650. Saves Extensible Application Markup Language (XAML) information as the source for a provided text writer object.
  3651. The output of the text writer can then be used to serialize the provided object.
  3652. </summary>
  3653. <param name="obj">The element to be serialized. Typically, this is the root element of a page or application.</param>
  3654. <param name="writer">TextWriter instance to use to write the serialized XAML information.</param>
  3655. </member>
  3656. <member name="M:SharpVectors.Converters.XmlXamlWriter.Save(System.Object,System.Xml.XmlWriter)">
  3657. <summary>
  3658. Saves Extensible Application Markup Language (XAML) information as the source for a provided XML writer object.
  3659. The output of the XML writer can then be used to serialize the provided object.
  3660. </summary>
  3661. <param name="obj">The element to be serialized. Typically, this is the root element of a page or application.</param>
  3662. <param name="xmlWriter">Writer to use to write the serialized XAML information.</param>
  3663. </member>
  3664. <member name="T:SharpVectors.Converters.XmlXamlWriter.NamespaceCache">
  3665. <summary>
  3666. Xml namespace caching class.
  3667. </summary>
  3668. </member>
  3669. <member name="T:SharpVectors.Converters.XmlXamlWriter.NamespaceMap">
  3670. <summary>
  3671. A class encapsulating XML name prefix to namespace map.
  3672. </summary>
  3673. </member>
  3674. </members>
  3675. </doc>