1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>SharpVectors.Converters.Wpf</name>
- </assembly>
- <members>
- <member name="T:SharpVectors.Converters.DirectorySvgConverter">
- <summary>
- This converts a directory (and optionally the sub-directories) of SVG files to XAML files in a specified directory,
- maintaining the original directory structure.
- <para>
- It uses <see cref="T:SharpVectors.Converters.FileSvgConverter"/> or <see cref="T:SharpVectors.Converters.ImageSvgConverter"/> converter to process each SVG file
- in the specified directory.
- </para>
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.DirectorySvgConverter.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Renderers.Wpf.WpfDrawingSettings"/>
- class with the specified drawing or rendering settings.
- </summary>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- </member>
- <member name="P:SharpVectors.Converters.DirectorySvgConverter.Recursive">
- <summary>
- Gets or sets a value indicating whether the directory copying is
- recursive, that is includes the sub-directories.
- </summary>
- <value>
- This property is <see langword="true"/> if the sub-directories are
- included in the directory copy; otherwise, it is <see langword="false"/>.
- The default is <see langword="true"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.DirectorySvgConverter.Overwrite">
- <summary>
- Gets or sets a value indicating whether an existing file is overwritten.
- </summary>
- <value>
- This property is <see langword="true"/> if existing file is overwritten;
- otherwise, it is <see langword="false"/>. The default is <see langword="true"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.DirectorySvgConverter.IncludeSecurity">
- <summary>
- Gets or sets a value indicating whether the security settings of the
- copied file is retained.
- </summary>
- <value>
- This property is <see langword="true"/> if the security settings of the
- file is also copied; otherwise, it is <see langword="false"/>. The
- default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.DirectorySvgConverter.IncludeHidden">
- <summary>
- Gets or sets a value indicating whether the copy operation includes
- hidden directories and files.
- </summary>
- <value>
- This property is <see langword="true"/> if hidden directories and files
- are included in the copy operation; otherwise, it is
- <see langword="false"/>. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.DirectorySvgConverter.WriterErrorOccurred">
- <summary>
- Gets a value indicating whether a writer error occurred when
- using the custom XAML writer.
- </summary>
- <value>
- This is <see langword="true"/> if an error occurred when using
- the custom XAML writer; otherwise, it is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.DirectorySvgConverter.FallbackOnWriterError">
- <summary>
- Gets or sets a value indicating whether to fall back and use
- the .NET Framework XAML writer when an error occurred in using the
- custom writer.
- </summary>
- <value>
- This is <see langword="true"/> if the converter falls back to using
- the system XAML writer when an error occurred in using the custom
- writer; otherwise, it is <see langword="false"/>. If <see langword="false"/>,
- an exception, which occurred in using the custom writer will be
- thrown. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.DirectorySvgConverter.SourceDir">
- <summary>
- Gets the source directory of the SVG files to be converted.
- </summary>
- <value>
- A <see cref="T:System.IO.DirectoryInfo"/> specifying the source directory of
- the SVG files.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.DirectorySvgConverter.DestinationDir">
- <summary>
- Gets the destination directory of the converted XAML files.
- </summary>
- <value>
- A <see cref="T:System.IO.DirectoryInfo"/> specifying the destination directory of
- the converted XAML files.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.DirectorySvgConverter.ErrorFile">
- <summary>
- Gets the full path of the last SVG file not successfully converted.
- </summary>
- <value>
- A string containing the full path of the last SVG file not
- successfully converted to the XAML
- </value>
- <remarks>
- Whenever an error occurred in the conversion of a file, the
- conversion process will stop. Use this property to retrieve the full
- path of the SVG file causing the error.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.DirectorySvgConverter.SaveImage">
- <summary>
- Gets or sets a value indicating whether to save static or bitmap image output.
- </summary>
- <value>
- This is <see langword="true"/> if the conversion saves static or bitmap image file; otherwise,
- it is <see langword="false"/>. The default value is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.DirectorySvgConverter.EncoderType">
- <summary>
- Gets or set the bitmap encoder type to use in encoding the drawing
- to an image file.
- </summary>
- <value>
- An enumeration of the type <see cref="T:SharpVectors.Converters.ImageEncoderType"/> specifying
- the bitmap encoder. The default is the <see cref="F:SharpVectors.Converters.ImageEncoderType.PngBitmap"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.DirectorySvgConverter.Encoder">
- <summary>
- Gets or sets a custom bitmap encoder to use in encoding the drawing
- to an image file.
- </summary>
- <value>
- A derived <see cref="T:System.Windows.Media.Imaging.BitmapEncoder"/> object specifying the bitmap
- encoder for encoding the images. The default is <see langword="null"/>,
- and the <see cref="P:SharpVectors.Converters.DirectorySvgConverter.EncoderType"/> property determines the encoder used.
- </value>
- <remarks>
- If the value of this is set, it must match the MIME type or file
- extension defined by the <see cref="P:SharpVectors.Converters.DirectorySvgConverter.EncoderType"/> property for it
- to be used.
- </remarks>
- </member>
- <member name="M:SharpVectors.Converters.DirectorySvgConverter.Convert(System.IO.DirectoryInfo,System.IO.DirectoryInfo)">
- <summary>
- Convert the SVG files in the specified source directory, saving the
- results in the specified destination directory.
- </summary>
- <param name="sourceInfo">
- A <see cref="T:System.IO.DirectoryInfo"/> specifying the source directory of
- the SVG files.
- </param>
- <param name="destInfo">
- A <see cref="T:System.IO.DirectoryInfo"/> specifying the source directory of
- the SVG files.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <para>
- If the <paramref name="sourceInfo"/> is <see langword="null"/>.
- </para>
- <para>
- -or-
- </para>
- <para>
- If the <paramref name="destInfo"/> is <see langword="null"/>.
- </para>
- </exception>
- <exception cref="T:System.ArgumentException">
- If the directory specified by <paramref name="sourceInfo"/> does not
- exists.
- </exception>
- </member>
- <member name="T:SharpVectors.Converters.FileSvgConverter">
- <summary>
- <para>
- This converts an SVG file to the corresponding XAML file, which can be viewed in WPF application.
- </para>
- <para>The root object in the converted file is <see cref="T:System.Windows.Media.DrawingGroup"/>.</para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.FileSvgConverter._drawing">
- <summary>
- This is the last drawing generated.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgConverter.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <overloads>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.FileSvgConverter"/> class.
- </overloads>
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.FileSvgConverter"/> class
- with the specified drawing or rendering settings.
- </summary>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgConverter.#ctor(System.Boolean,System.Boolean,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.FileSvgConverter"/> class
- with the specified drawing or rendering settings and the saving options.
- </summary>
- <param name="saveXaml">
- This specifies whether to save result object tree in XAML file.
- </param>
- <param name="saveZaml">
- This specifies whether to save result object tree in ZAML file. The
- ZAML is simply a G-Zip compressed XAML format, similar to the SVGZ.
- </param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- </member>
- <member name="P:SharpVectors.Converters.FileSvgConverter.WriterErrorOccurred">
- <summary>
- Gets a value indicating whether a writer error occurred when
- using the custom XAML writer.
- </summary>
- <value>
- This is <see langword="true"/> if an error occurred when using
- the custom XAML writer; otherwise, it is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.FileSvgConverter.FallbackOnWriterError">
- <summary>
- Gets or sets a value indicating whether to fall back and use
- the .NET Framework XAML writer when an error occurred in using the
- custom writer.
- </summary>
- <value>
- This is <see langword="true"/> if the converter falls back to using
- the system XAML writer when an error occurred in using the custom
- writer; otherwise, it is <see langword="false"/>. If <see langword="false"/>,
- an exception, which occurred in using the custom writer will be
- thrown. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.FileSvgConverter.Drawing">
- <summary>
- Gets the last created drawing.
- </summary>
- <value>
- A <see cref="T:System.Windows.Media.DrawingGroup"/> specifying the last converted drawing.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.FileSvgConverter.XamlFile">
- <summary>
- Gets the output XAML file path if generated.
- </summary>
- <value>
- A string containing the full path to the XAML if generated; otherwise,
- it is <see langword="null"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.FileSvgConverter.ZamlFile">
- <summary>
- Gets the output ZAML file path if generated.
- </summary>
- <value>
- A string containing the full path to the ZAML if generated; otherwise,
- it is <see langword="null"/>.
- </value>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgConverter.Convert(System.String)">
- <overloads>
- This performs the conversion of the specified SVG file, and saves
- the output to an XAML file.
- </overloads>
- <summary>
- This performs the conversion of the specified SVG file, and saves
- the output to an XAML file with the same file name.
- </summary>
- <param name="svgFileName">
- The full path of the SVG source file.
- </param>
- <returns>
- This returns <see langword="true"/> if the conversion is successful;
- otherwise, it return <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="svgFileName"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="svgFileName"/> is empty.
- <para>-or-</para>
- If the <paramref name="svgFileName"/> does not exists.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgConverter.Convert(System.String,System.String)">
- <summary>
- This performs the conversion of the specified SVG file, and saves
- the output to the specified XAML file.
- </summary>
- <param name="svgFileName">
- The full path of the SVG source file.
- </param>
- <param name="xamlFileName">
- The output XAML file. This is optional. If not specified, an XAML
- file is created in the same directory as the SVG file.
- </param>
- <returns>
- This returns <see langword="true"/> if the conversion is successful;
- otherwise, it return <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="svgFileName"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="svgFileName"/> is empty.
- <para>-or-</para>
- If the <paramref name="svgFileName"/> does not exists.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgConverter.Convert(System.IO.Stream,System.String)">
- <summary>
- This performs the conversion of the specified SVG source, and saves
- the output to the specified XAML file.
- </summary>
- <param name="svgStream">
- A stream providing access to the SVG source data.
- </param>
- <param name="xamlFileName">
- The output XAML file. This is optional. If not specified, an XAML
- file is created in the same directory as the SVG file.
- </param>
- <returns>
- This returns <see langword="true"/> if the conversion is successful;
- otherwise, it return <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="xamlFileName"/> is <see langword="null"/>.
- <para>-or-</para>
- If the <paramref name="svgStream"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="xamlFileName"/> is empty.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgConverter.Convert(System.IO.TextReader,System.String)">
- <summary>
- This performs the conversion of the specified SVG source, and saves
- the output to the specified XAML file.
- </summary>
- <param name="svgTextReader">
- A text reader providing access to the SVG source data.
- </param>
- <param name="xamlFileName">
- The output XAML file. This is optional. If not specified, an XAML
- file is created in the same directory as the SVG file.
- </param>
- <returns>
- This returns <see langword="true"/> if the conversion is successful;
- otherwise, it return <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="xamlFileName"/> is <see langword="null"/>.
- <para>-or-</para>
- If the <paramref name="svgTextReader"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="xamlFileName"/> is empty.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgConverter.Convert(System.Xml.XmlReader,System.String)">
- <summary>
- This performs the conversion of the specified SVG source, and saves
- the output to the specified XAML file.
- </summary>
- <param name="svgXmlReader">
- An XML reader providing access to the SVG source data.
- </param>
- <param name="xamlFileName">
- The output XAML file. This is optional. If not specified, an XAML
- file is created in the same directory as the SVG file.
- </param>
- <returns>
- This returns <see langword="true"/> if the conversion is successful;
- otherwise, it return <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="xamlFileName"/> is <see langword="null"/>.
- <para>-or-</para>
- If the <paramref name="svgXmlReader"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="xamlFileName"/> is empty.
- </exception>
- </member>
- <member name="T:SharpVectors.Converters.FileSvgReader">
- <summary>
- This converts a SVG file to <see cref="T:System.Windows.Media.DrawingGroup"/> object, and can
- optionally save the result to a file as XAML.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.FileSvgReader._drawing">
- <summary>
- This is the last drawing generated.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgReader.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings,System.Boolean)">
- <overloads>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.FileSvgReader"/> class.
- </overloads>
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.FileSvgReader"/> class
- with the specified drawing or rendering settings.
- </summary>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- <param name="isEmbedded">A value indicating whether this converter is embedded or not.</param>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgReader.#ctor(System.Boolean,System.Boolean,System.IO.DirectoryInfo,SharpVectors.Renderers.Wpf.WpfDrawingSettings,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.FileSvgConverter"/> class
- with the specified drawing or rendering settings, the saving options
- and the working directory.
- </summary>
- <param name="saveXaml">
- This specifies whether to save result object tree in XAML file.
- </param>
- <param name="saveZaml">
- This specifies whether to save result object tree in ZAML file. The
- ZAML is simply a G-Zip compressed XAML format, similar to the SVGZ.
- </param>
- <param name="workingDir">
- The working directory, where converted outputs are saved.
- </param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- </member>
- <member name="P:SharpVectors.Converters.FileSvgReader.WriterErrorOccurred">
- <summary>
- Gets a value indicating whether a writer error occurred when
- using the custom XAML writer.
- </summary>
- <value>
- This is <see langword="true"/> if an error occurred when using
- the custom XAML writer; otherwise, it is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.FileSvgReader.FallbackOnWriterError">
- <summary>
- Gets or sets a value indicating whether to fall back and use
- the .NET Framework XAML writer when an error occurred in using the
- custom writer.
- </summary>
- <value>
- This is <see langword="true"/> if the converter falls back to using
- the system XAML writer when an error occurred in using the custom
- writer; otherwise, it is <see langword="false"/>. If <see langword="false"/>,
- an exception, which occurred in using the custom writer will be
- thrown. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.FileSvgReader.ImageFile">
- <summary>
- Gets the output image file path if generated.
- </summary>
- <value>
- A string containing the full path to the image if generated; otherwise,
- it is <see langword="null"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.FileSvgReader.XamlFile">
- <summary>
- Gets the output XAML file path if generated.
- </summary>
- <value>
- A string containing the full path to the XAML if generated; otherwise,
- it is <see langword="null"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.FileSvgReader.ZamlFile">
- <summary>
- Gets the output ZAML file path if generated.
- </summary>
- <value>
- A string containing the full path to the ZAML if generated; otherwise,
- it is <see langword="null"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.FileSvgReader.Drawing">
- <summary>
- Gets or sets the last created drawing.
- </summary>
- <value>
- A <see cref="T:System.Windows.Media.DrawingGroup"/> specifying the last converted drawing.
- </value>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgReader.Read(System.String)">
- <overloads>
- Reads in the specified SVG file and converts it to WPF drawing.
- </overloads>
- <summary>
- Reads in the specified SVG file and converts it to WPF drawing.
- </summary>
- <param name="svgFileName">
- The full path of the SVG source file.
- </param>
- <returns>
- This returns the <see cref="T:System.Windows.Media.DrawingGroup"/> representing the SVG file,
- if successful; otherwise, it returns <see langword="null"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="svgFileName"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="svgFileName"/> is empty.
- <para>-or-</para>
- If the <paramref name="svgFileName"/> does not exists.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgReader.Read(System.Uri)">
- <summary>
- Reads in the specified SVG file and converts it to WPF drawing.
- </summary>
- <param name="svgUri">
- A <see cref="T:System.Uri"/> specifying the path to the SVG file.
- </param>
- <returns>
- This returns the <see cref="T:System.Windows.Media.DrawingGroup"/> representing the SVG file,
- if successful; otherwise, it returns <see langword="null"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="svgUri"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgReader.Read(System.IO.Stream)">
- <summary>
- Reads in the specified SVG file stream and converts it to WPF drawing.
- </summary>
- <param name="svgStream">The source SVG file stream.</param>
- <returns>
- This returns the <see cref="T:System.Windows.Media.DrawingGroup"/> representing the SVG file,
- if successful; otherwise, it returns <see langword="null"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="svgStream"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgReader.Read(System.IO.TextReader)">
- <summary>
- Reads in the specified source from the SVG file reader and converts
- it to WPF drawing.
- </summary>
- <param name="svgTextReader">
- A text reader providing access to the SVG file data.
- </param>
- <returns>
- This returns the <see cref="T:System.Windows.Media.DrawingGroup"/> representing the SVG file,
- if successful; otherwise, it returns <see langword="null"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="svgTextReader"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgReader.Read(System.Xml.XmlReader)">
- <summary>
- Reads in the specified source SVG file reader and converts it to
- WPF drawing.
- </summary>
- <param name="svgXmlReader">
- An XML reader providing access to the SVG file data.
- </param>
- <returns>
- This returns the <see cref="T:System.Windows.Media.DrawingGroup"/> representing the SVG file,
- if successful; otherwise, it returns <see langword="null"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="svgXmlReader"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgReader.Read(System.String,System.IO.DirectoryInfo)">
- <summary>
- Reads in the specified SVG file, converting it to WPF drawing and
- saving the results to the specified directory if successful.
- </summary>
- <param name="svgFileName">
- The full path of the SVG source file.
- </param>
- <param name="destinationDir">
- The destination of the output XAML file, if the saving properties
- are enabled.
- </param>
- <returns>
- This returns the <see cref="T:System.Windows.Media.DrawingGroup"/> representing the SVG file,
- if successful; otherwise, it returns <see langword="null"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="svgFileName"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="svgFileName"/> is empty.
- <para>-or-</para>
- If the <paramref name="svgFileName"/> does not exists.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgReader.Save(System.String,System.Boolean,System.Boolean)">
- <summary>
- Saves the last converted file to the specified file name.
- </summary>
- <param name="fileName">
- The full path of the output file.
- </param>
- <param name="asXaml">
- A value indicating whether to save the output to XAML file.
- </param>
- <param name="asZaml">
- A value indicating whether to save the output to ZAML file, which
- is a G-zip compression of the XAML file.
- </param>
- <returns>
- This returns <see langword="true"/> if either <paramref name="asXaml"/>
- or <paramref name="asZaml"/> is <see langword="true"/> and the operation
- is successful.
- </returns>
- <remarks>
- <para>
- If the output serialization properties are not enabled, this method
- can be used to save the output to a file.
- </para>
- <para>
- This will not change the output serialization properties of this object.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">
- If there is no converted drawing from a previous conversion process
- to be saved.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.FileSvgReader.Dispose(System.Boolean)">
- <summary>
- This releases the unmanaged resources used by the <see cref="T:SharpVectors.Converters.SvgConverter"/>
- and optionally releases the managed resources.
- </summary>
- <param name="disposing">
- This is <see langword="true"/> if managed resources should be
- disposed; otherwise, <see langword="false"/>.
- </param>
- </member>
- <member name="T:SharpVectors.Converters.ImageEncoderType">
- <summary>
- <para>
- This specifies the encoder type used to encode a collection of
- bitmap frame objects to an image stream.
- </para>
- <para>
- This is used by the <see cref="T:SharpVectors.Converters.ImageSvgConverter"/> converter.
- </para>
- </summary>
- <seealso cref="T:SharpVectors.Converters.ImageSvgConverter"/>
- </member>
- <member name="F:SharpVectors.Converters.ImageEncoderType.BmpBitmap">
- <summary>
- Specifies an encoder that is used to encode bitmap (BMP)
- format images, that is
- <see cref="T:System.Windows.Media.Imaging.BmpBitmapEncoder"/>.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.ImageEncoderType.GifBitmap">
- <summary>
- Specifies an encoder that is used to encode Graphics Interchange
- Format (GIF) images, that is
- <see cref="T:System.Windows.Media.Imaging.GifBitmapEncoder"/>.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.ImageEncoderType.JpegBitmap">
- <summary>
- Specifies an encoder that is used to encode Joint Photographics
- Experts Group (JPEG) format images, that is
- <see cref="T:System.Windows.Media.Imaging.JpegBitmapEncoder"/>.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.ImageEncoderType.PngBitmap">
- <summary>
- Specifies an encoder that is used to encode Portable Network
- Graphics (PNG) format images, that is
- <see cref="T:System.Windows.Media.Imaging.PngBitmapEncoder"/>.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.ImageEncoderType.TiffBitmap">
- <summary>
- Specifies an encoder that is used to encode Tagged Image File
- Format (TIFF) images, that is
- <see cref="T:System.Windows.Media.Imaging.TiffBitmapEncoder"/>.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.ImageEncoderType.WmpBitmap">
- <summary>
- Specifies an encoder that is used to Microsoft Windows Media Photo
- (WDP) images, that is
- <see cref="T:System.Windows.Media.Imaging.WmpBitmapEncoder"/>.
- </summary>
- </member>
- <member name="T:SharpVectors.Converters.ImageSvgConverter">
- <summary>
- This converts the SVG file to static or bitmap image, which is saved to a file.
- </summary>
- <remarks>
- <para>
- The image is save with the <see cref="P:System.Windows.Media.PixelFormats.Pbgra32"/> format,
- since that is the only pixel format which does not throw an exception
- with the <see cref="T:System.Windows.Media.Imaging.RenderTargetBitmap"/>.
- </para>
- <para>
- The DPI used is 96.
- </para>
- </remarks>
- </member>
- <member name="F:SharpVectors.Converters.ImageSvgConverter._drawing">
- <summary>
- This is the last drawing generated.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.ImageSvgConverter.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <overloads>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.ImageSvgConverter"/> class.
- </overloads>
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.ImageSvgConverter"/> class
- with the specified drawing or rendering settings.
- </summary>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- </member>
- <member name="M:SharpVectors.Converters.ImageSvgConverter.#ctor(System.Boolean,System.Boolean,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.ImageSvgConverter"/> class
- with the specified drawing or rendering settings and the saving options.
- </summary>
- <param name="saveXaml">
- This specifies whether to save result object tree in image file.
- </param>
- <param name="saveZaml">
- This specifies whether to save result object tree in ZAML file. The
- ZAML is simply a G-Zip compressed image format, similar to the SVGZ.
- </param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- </member>
- <member name="P:SharpVectors.Converters.ImageSvgConverter.WriterErrorOccurred">
- <summary>
- Gets a value indicating whether a writer error occurred when
- using the custom image writer.
- </summary>
- <value>
- This is <see langword="true"/> if an error occurred when using
- the custom image writer; otherwise, it is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.ImageSvgConverter.FallbackOnWriterError">
- <summary>
- Gets or sets a value indicating whether to fall back and use
- the .NET Framework image writer when an error occurred in using the
- custom writer.
- </summary>
- <value>
- This is <see langword="true"/> if the converter falls back to using
- the system image writer when an error occurred in using the custom
- writer; otherwise, it is <see langword="false"/>. If <see langword="false"/>,
- an exception, which occurred in using the custom writer will be
- thrown. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.ImageSvgConverter.EncoderType">
- <summary>
- Gets or set the bitmap encoder type to use in encoding the drawing
- to an image file.
- </summary>
- <value>
- An enumeration of the type <see cref="T:SharpVectors.Converters.ImageEncoderType"/> specifying
- the bitmap encoder. The default is the <see cref="F:SharpVectors.Converters.ImageEncoderType.PngBitmap"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.ImageSvgConverter.Encoder">
- <summary>
- Gets or sets a custom bitmap encoder to use in encoding the drawing
- to an image file.
- </summary>
- <value>
- A derived <see cref="T:System.Windows.Media.Imaging.BitmapEncoder"/> object specifying the bitmap
- encoder for encoding the images. The default is <see langword="null"/>,
- and the <see cref="P:SharpVectors.Converters.ImageSvgConverter.EncoderType"/> property determines the encoder used.
- </value>
- <remarks>
- If the value of this is set, it must match the MIME type or file
- extension defined by the <see cref="P:SharpVectors.Converters.ImageSvgConverter.EncoderType"/> property for it
- to be used.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.ImageSvgConverter.Drawing">
- <summary>
- Gets the last created drawing.
- </summary>
- <value>
- A <see cref="T:System.Windows.Media.DrawingGroup"/> specifying the last converted drawing.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.ImageSvgConverter.XamlFile">
- <summary>
- Gets the output XAML file path if generated.
- </summary>
- <value>
- A string containing the full path to the XAML if generated; otherwise,
- it is <see langword="null"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.ImageSvgConverter.ZamlFile">
- <summary>
- Gets the output ZAML file path if generated.
- </summary>
- <value>
- A string containing the full path to the ZAML if generated; otherwise,
- it is <see langword="null"/>.
- </value>
- </member>
- <member name="M:SharpVectors.Converters.ImageSvgConverter.Convert(System.String)">
- <overloads>
- This performs the conversion of the specified SVG file, and saves
- the output to an image file.
- </overloads>
- <summary>
- This performs the conversion of the specified SVG file, and saves
- the output to an image file with the same file name.
- </summary>
- <param name="svgFileName">
- The full path of the SVG source file.
- </param>
- <returns>
- This returns <see langword="true"/> if the conversion is successful;
- otherwise, it return <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="svgFileName"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="svgFileName"/> is empty.
- <para>-or-</para>
- If the <paramref name="svgFileName"/> does not exists.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.ImageSvgConverter.Convert(System.String,System.String)">
- <summary>
- This performs the conversion of the specified SVG file, and saves
- the output to the specified image file.
- </summary>
- <param name="svgFileName">
- The full path of the SVG source file.
- </param>
- <param name="imageFileName">
- The output image file. This is optional. If not specified, an image
- file is created in the same directory as the SVG file.
- </param>
- <returns>
- This returns <see langword="true"/> if the conversion is successful;
- otherwise, it return <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="svgFileName"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="svgFileName"/> is empty.
- <para>-or-</para>
- If the <paramref name="svgFileName"/> does not exists.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.ImageSvgConverter.Convert(System.IO.Stream,System.String)">
- <summary>
- This performs the conversion of the specified SVG source, and saves
- the output to the specified image file.
- </summary>
- <param name="svgStream">
- A stream providing access to the SVG source data.
- </param>
- <param name="imageFileName">
- The output image file. This is optional. If not specified, an image
- file is created in the same directory as the SVG file.
- </param>
- <returns>
- This returns <see langword="true"/> if the conversion is successful;
- otherwise, it return <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="imageFileName"/> is <see langword="null"/>.
- <para>-or-</para>
- If the <paramref name="svgStream"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="imageFileName"/> is empty.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.ImageSvgConverter.Convert(System.IO.TextReader,System.String)">
- <summary>
- This performs the conversion of the specified SVG source, and saves
- the output to the specified image file.
- </summary>
- <param name="svgTextReader">
- A text reader providing access to the SVG source data.
- </param>
- <param name="imageFileName">
- The output image file. This is optional. If not specified, an image
- file is created in the same directory as the SVG file.
- </param>
- <returns>
- This returns <see langword="true"/> if the conversion is successful;
- otherwise, it return <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="imageFileName"/> is <see langword="null"/>.
- <para>-or-</para>
- If the <paramref name="svgTextReader"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="imageFileName"/> is empty.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.ImageSvgConverter.Convert(System.Xml.XmlReader,System.String)">
- <summary>
- This performs the conversion of the specified SVG source, and saves
- the output to the specified image file.
- </summary>
- <param name="svgXmlReader">
- An XML reader providing access to the SVG source data.
- </param>
- <param name="imageFileName">
- The output image file. This is optional. If not specified, an image
- file is created in the same directory as the SVG file.
- </param>
- <returns>
- This returns <see langword="true"/> if the conversion is successful;
- otherwise, it return <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="imageFileName"/> is <see langword="null"/>.
- <para>-or-</para>
- If the <paramref name="svgXmlReader"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="imageFileName"/> is empty.
- </exception>
- </member>
- <member name="T:SharpVectors.Converters.Properties.Resources">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:SharpVectors.Converters.Properties.Resources.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:SharpVectors.Converters.Properties.Resources.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="T:SharpVectors.Converters.ResourceSvgConverter">
- <summary>
-
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.ResourceSvgConverter.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.ResourceSvgConverter"/>
- class with the specified drawing or rendering settings.
- </summary>
- <param name="drawingSettings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- </member>
- <member name="T:SharpVectors.Converters.ShapeSvgCanvas">
- <summary>
- Component that visualizes svg document contents.
- </summary>
- </member>
- <member name="P:SharpVectors.Converters.ShapeSvgCanvas.Source">
- <summary>
- Gets or sets svg document source.
- </summary>
- </member>
- <member name="P:SharpVectors.Converters.ShapeSvgCanvas.ItemStyle">
- <summary>
- Gets or sets an item style that will be applied to all svg elements.
- </summary>
- <remarks>
- This style will be used as a BasedOn style for all shapes created from
- svg elements.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.ShapeSvgCanvas.Bounds">
- <summary>
- Gets the bounding box of the svg document.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.ShapeSvgCanvas.UnloadDiagrams">
- <summary>
- Unloads loaded svg.
- </summary>
- </member>
- <member name="T:SharpVectors.Converters.StreamSvgConverter">
- <summary>
- This converts the SVG file to static or bitmap image, which is saved to a file.
- </summary>
- <remarks>
- <para>
- The image is save with the <see cref="P:System.Windows.Media.PixelFormats.Pbgra32"/> format,
- since that is the only pixel format which does not throw an exception
- with the <see cref="T:System.Windows.Media.Imaging.RenderTargetBitmap"/>.
- </para>
- <para>The DPI used is 96.</para>
- </remarks>
- </member>
- <member name="F:SharpVectors.Converters.StreamSvgConverter._drawing">
- <summary>
- This is the last drawing generated.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.StreamSvgConverter.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <overloads>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.StreamSvgConverter"/> class.
- </overloads>
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.StreamSvgConverter"/> class
- with the specified drawing or rendering settings.
- </summary>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- </member>
- <member name="M:SharpVectors.Converters.StreamSvgConverter.#ctor(System.Boolean,System.Boolean,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.StreamSvgConverter"/> class
- with the specified drawing or rendering settings and the saving options.
- </summary>
- <param name="saveXaml">
- This specifies whether to save result object tree in image file.
- </param>
- <param name="saveZaml">
- This specifies whether to save result object tree in ZAML file. The
- ZAML is simply a G-Zip compressed image format, similar to the SVGZ.
- </param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- </member>
- <member name="P:SharpVectors.Converters.StreamSvgConverter.WriterErrorOccurred">
- <summary>
- Gets a value indicating whether a writer error occurred when
- using the custom image writer.
- </summary>
- <value>
- This is <see langword="true"/> if an error occurred when using
- the custom image writer; otherwise, it is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.StreamSvgConverter.FallbackOnWriterError">
- <summary>
- Gets or sets a value indicating whether to fall back and use
- the .NET Framework image writer when an error occurred in using the
- custom writer.
- </summary>
- <value>
- This is <see langword="true"/> if the converter falls back to using
- the system image writer when an error occurred in using the custom
- writer; otherwise, it is <see langword="false"/>. If <see langword="false"/>,
- an exception, which occurred in using the custom writer will be
- thrown. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.StreamSvgConverter.EncoderType">
- <summary>
- Gets or set the bitmap encoder type to use in encoding the drawing
- to an image file.
- </summary>
- <value>
- An enumeration of the type <see cref="T:SharpVectors.Converters.ImageEncoderType"/> specifying
- the bitmap encoder. The default is the <see cref="F:SharpVectors.Converters.ImageEncoderType.PngBitmap"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.StreamSvgConverter.Encoder">
- <summary>
- Gets or sets a custom bitmap encoder to use in encoding the drawing
- to an image file.
- </summary>
- <value>
- A derived <see cref="T:System.Windows.Media.Imaging.BitmapEncoder"/> object specifying the bitmap
- encoder for encoding the images. The default is <see langword="null"/>,
- and the <see cref="P:SharpVectors.Converters.StreamSvgConverter.EncoderType"/> property determines the encoder used.
- </value>
- <remarks>
- If the value of this is set, it must match the MIME type or file
- extension defined by the <see cref="P:SharpVectors.Converters.StreamSvgConverter.EncoderType"/> property for it
- to be used.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.StreamSvgConverter.Drawing">
- <summary>
- Gets the last created drawing.
- </summary>
- <value>
- A <see cref="T:System.Windows.Media.DrawingGroup"/> specifying the last converted drawing.
- </value>
- </member>
- <member name="M:SharpVectors.Converters.StreamSvgConverter.Convert(System.String,System.IO.Stream)">
- <overloads>
- This performs the conversion of the specified SVG file, and saves
- the output to an image file.
- </overloads>
- <summary>
- This performs the conversion of the specified SVG file, and saves
- the output to the specified image file.
- </summary>
- <param name="svgFileName">
- The full path of the SVG source file.
- </param>
- <param name="imageStream">
- The output image file. This is optional. If not specified, an image
- file is created in the same directory as the SVG file.
- </param>
- <returns>
- This returns <see langword="true"/> if the conversion is successful;
- otherwise, it return <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="svgFileName"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="svgFileName"/> is empty.
- <para>-or-</para>
- If the <paramref name="svgFileName"/> does not exists.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.StreamSvgConverter.Convert(System.IO.Stream,System.IO.Stream)">
- <summary>
- This performs the conversion of the specified SVG source, and saves
- the output to the specified image file.
- </summary>
- <param name="svgStream">
- A stream providing access to the SVG source data.
- </param>
- <param name="imageStream">
- The output image file. This is optional. If not specified, an image
- file is created in the same directory as the SVG file.
- </param>
- <returns>
- This returns <see langword="true"/> if the conversion is successful;
- otherwise, it return <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="imageStream"/> is <see langword="null"/>.
- <para>-or-</para>
- If the <paramref name="svgStream"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="imageStream"/> is empty.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.StreamSvgConverter.Convert(System.IO.TextReader,System.IO.Stream)">
- <summary>
- This performs the conversion of the specified SVG source, and saves
- the output to the specified image file.
- </summary>
- <param name="svgTextReader">
- A text reader providing access to the SVG source data.
- </param>
- <param name="imageStream">
- The output image file. This is optional. If not specified, an image
- file is created in the same directory as the SVG file.
- </param>
- <returns>
- This returns <see langword="true"/> if the conversion is successful;
- otherwise, it return <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="imageStream"/> is <see langword="null"/>.
- <para>-or-</para>
- If the <paramref name="svgTextReader"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="imageStream"/> is empty.
- </exception>
- </member>
- <member name="M:SharpVectors.Converters.StreamSvgConverter.Convert(System.Xml.XmlReader,System.IO.Stream)">
- <summary>
- This performs the conversion of the specified SVG source, and saves
- the output to the specified image file.
- </summary>
- <param name="svgXmlReader">
- An XML reader providing access to the SVG source data.
- </param>
- <param name="imageStream">
- The output image file. This is optional. If not specified, an image
- file is created in the same directory as the SVG file.
- </param>
- <returns>
- This returns <see langword="true"/> if the conversion is successful;
- otherwise, it return <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException">
- If the <paramref name="imageStream"/> is <see langword="null"/>.
- <para>-or-</para>
- If the <paramref name="svgXmlReader"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- If the <paramref name="imageStream"/> is empty.
- </exception>
- </member>
- <member name="T:SharpVectors.Converters.SvgBitmap">
- <summary>
- This is an extension of the WPF <see cref="T:System.Windows.Controls.Image"/> control to provide SVG-based image sources.
- </summary>
- <seealso cref="T:SharpVectors.Converters.SvgIcon"/>
- </member>
- <member name="F:SharpVectors.Converters.SvgBitmap.UriSourceProperty">
- <summary>
- Identifies the <see cref="P:SharpVectors.Converters.SvgBitmap.UriSource"/> dependency property.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgBitmap.SvgSourceProperty">
- <summary>
- Identifies the <see cref="P:SharpVectors.Converters.SvgBitmap.SvgSource"/> dependency property.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgBitmap.AppNameProperty">
- <summary>
- The <see cref="T:System.Windows.DependencyProperty"/> for the <c>AppName</c> property.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgBitmap.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgBitmap"/> class.
- </summary>
- </member>
- <member name="P:SharpVectors.Converters.SvgBitmap.AppName">
- <summary>
- Gets or sets the <c>name</c> of the parent assembly for this element.
- </summary>
- <value>
- A string containing the name of the parent assembly or the name of the assembly containing <c>SVG</c> file
- referenced on this control in XAML, if the source type is <see cref="T:System.Uri"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgBitmap.UriSource">
- <summary>
- Gets or sets the path to the SVG file to load into this <see cref="T:SharpVectors.Converters.SvgBitmap"/>.
- </summary>
- <value>
- A <see cref="T:System.Uri"/> specifying the path to the SVG source file.
- The file can be located on a computer, network or assembly resources.
- Settings this to <see langword="null"/> will close any opened diagram.
- </value>
- <remarks>
- This is the same as the <see cref="!:Source"/> property, and added for consistency.
- </remarks>
- <seealso cref="P:SharpVectors.Converters.SvgBitmap.SvgSource"/>
- </member>
- <member name="P:SharpVectors.Converters.SvgBitmap.SvgSource">
- <summary>
- Gets or sets the SVG contents to load into this <see cref="T:SharpVectors.Converters.SvgBitmap"/>.
- </summary>
- <value>
- A <see cref="T:System.String"/> specifying the embedded SVG contents.
- Settings this to <see langword="null"/> will close any opened diagram.
- </value>
- <seealso cref="P:SharpVectors.Converters.SvgBitmap.UriSource"/>
- </member>
- <member name="M:SharpVectors.Converters.SvgBitmap.OnInitialized(System.EventArgs)">
- <summary>
- Raises the Initialized event. This method is invoked whenever IsInitialized is set to true.
- </summary>
- <param name="e">Event data for the event.</param>
- </member>
- <member name="M:SharpVectors.Converters.SvgBitmap.OnSettingsChanged">
- <summary>
- This handles changes in the rendering settings of this control.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgBitmap.CreateDrawing">
- <summary>
- Performs the conversion of a valid SVG source to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
- returns <see langword="null"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgBitmap.CreateDrawing(System.Uri,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Performs the conversion of a valid SVG source file to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <param name="svgSource">A <see cref="T:System.Uri"/> defining the path to the SVG source.</param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
- returns <see langword="null"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgBitmap.CreateDrawing(System.String,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Performs the conversion of a valid SVG source stream to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <param name="svgSource">A stream providing access to the SVG source data.</param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
- returns <see langword="null"/>.
- </returns>
- </member>
- <member name="T:SharpVectors.Converters.SvgCanvas">
- <summary>
- This is a <see cref="T:System.Windows.Controls.Canvas"/> control for viewing <c>SVG</c> file in <c>WPF</c> applications.
- </summary>
- <remarks>
- It extends the drawing canvas, <see cref="T:SharpVectors.Runtime.SvgDrawingCanvas"/>, instead of generic <see cref="T:System.Windows.Controls.Canvas"/> control,
- therefore any interactivity support implemented in the drawing canvas will be available in the <see cref="T:System.Windows.Controls.Canvas"/>.
- </remarks>
- <seealso cref="T:SharpVectors.Converters.SvgViewbox"/>
- </member>
- <member name="F:SharpVectors.Converters.SvgCanvas.SourceProperty">
- <summary>
- Identifies the <see cref="P:SharpVectors.Converters.SvgCanvas.Source"/> dependency property.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgCanvas.UriSourceProperty">
- <summary>
- Identifies the <see cref="P:SharpVectors.Converters.SvgCanvas.UriSource"/> dependency property.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgCanvas.SvgSourceProperty">
- <summary>
- Identifies the <see cref="P:SharpVectors.Converters.SvgCanvas.SvgSource"/> dependency property.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgCanvas.StreamSourceProperty">
- <summary>
- Identifies the <see cref="P:SharpVectors.Converters.SvgCanvas.StreamSource"/> dependency property.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgCanvas.MessageFontFamilyProperty">
- <summary>
- The DependencyProperty for the MessageFontFamily property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: System Dialog Font
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgCanvas.MessageFontSizeProperty">
- <summary>
- The DependencyProperty for the MessageFontSize property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: 48 pixels
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgCanvas.MessageOpacityProperty">
- <summary>
- The DependencyProperty for the MessageOpacity property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: 1 (full opacity)
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgCanvas.MessageTextProperty">
- <summary>
- The DependencyProperty for the MessageText property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: "Loading..."
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgCanvas.MessageBackgroundProperty">
- <summary>
- The DependencyProperty for the MessageBackground property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: <see cref="P:System.Windows.Media.Brushes.PapayaWhip"/>
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgCanvas.MessageFillBrushProperty">
- <summary>
- The DependencyProperty for the MessageFillBrush property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: <see cref="P:System.Windows.Media.Brushes.Gold"/>
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgCanvas.MessageStrokeBrushProperty">
- <summary>
- The DependencyProperty for the MessageStrokeBrush property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: <see cref="P:System.Windows.Media.Brushes.Maroon"/>
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgCanvas.AppNameProperty">
- <summary>
- The <see cref="T:System.Windows.DependencyProperty"/> for the <c>AppName</c> property.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgCanvas"/> class.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.#cctor">
- <summary>
- Static constructor to define metadata for the control (and link it to the style in Generic.xaml).
- </summary>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.AppName">
- <summary>
- Gets or sets the <c>name</c> of the parent assembly for this element.
- </summary>
- <value>
- A string containing the name of the parent assembly or the name of the assembly containing <c>SVG</c> file
- referenced on this control in XAML, if the source type is <see cref="T:System.Uri"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.Source">
- <summary>
- Gets or sets the path to the <c>SVG</c> file to load into this <see cref="T:System.Windows.Controls.Canvas"/>.
- </summary>
- <value>
- A <see cref="T:System.Uri"/> specifying the path to the <c>SVG</c> source file. The file can be located on
- a computer, network or assembly resources.
- Settings this to <see langword="null"/> will close any rendered <c>SVG</c> diagram.
- </value>
- <seealso cref="P:SharpVectors.Converters.SvgCanvas.UriSource"/>
- <seealso cref="P:SharpVectors.Converters.SvgCanvas.StreamSource"/>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.UriSource">
- <summary>
- Gets or sets the path to the <c>SVG</c> file to load into this <see cref="T:System.Windows.Controls.Canvas"/>.
- </summary>
- <value>
- A <see cref="T:System.Uri"/> specifying the path to the <c>SVG</c> source file.
- The <c>SVG</c> file can be located on a computer, network or assembly resources.
- Settings this to <see langword="null"/> will close any rendered <c>SVG</c> diagram.
- </value>
- <remarks>
- 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.
- </remarks>
- <seealso cref="P:SharpVectors.Converters.SvgCanvas.Source"/>
- <seealso cref="P:SharpVectors.Converters.SvgCanvas.SvgSource"/>
- <seealso cref="P:SharpVectors.Converters.SvgCanvas.StreamSource"/>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.SvgSource">
- <summary>
- Gets or sets the <c>SVG</c> contents to load into this <see cref="T:System.Windows.Controls.Canvas"/>.
- </summary>
- <value>
- A <see cref="T:System.String"/> specifying the embedded <c>SVG</c> contents.
- Settings this to <see langword="null"/> will close any opened diagram.
- </value>
- <seealso cref="P:SharpVectors.Converters.SvgCanvas.Source"/>
- <seealso cref="P:SharpVectors.Converters.SvgCanvas.UriSource"/>
- <seealso cref="P:SharpVectors.Converters.SvgCanvas.StreamSource"/>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.StreamSource">
- <summary>
- Gets or sets the <see cref="T:System.IO.Stream"/> to the <c>SVG</c> source to load into this
- <see cref="T:System.Windows.Controls.Canvas"/>.
- </summary>
- <value>
- A <see cref="T:System.IO.Stream"/> specifying the stream to the SVG source.
- Settings this to <see langword="null"/> will close any opened diagram.
- </value>
- <remarks>
- <para>
- The stream source has precedence over the Uri <see cref="P:SharpVectors.Converters.SvgCanvas.Source"/> property.
- If set (not <see langword="null"/>), the stream source will be rendered instead of the Uri source.
- </para>
- <para>
- WPF controls do not implement the <see cref="T:System.IDisposable"/> interface and cannot properly dispose any
- stream set to it. To avoid this issue and also any problem of the user accidentally closing the stream,
- this control makes a copy of the stream to memory stream.
- </para>
- </remarks>
- <seealso cref="P:SharpVectors.Converters.SvgCanvas.Source"/>
- <seealso cref="P:SharpVectors.Converters.SvgCanvas.UriSource"/>
- <seealso cref="P:SharpVectors.Converters.SvgCanvas.SvgSource"/>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.AutoSize">
- <summary>
- Gets or sets a value indicating whether to automatically resize this
- <see cref="T:System.Windows.Controls.Canvas"/> based on the size of the loaded drawing.
- </summary>
- <value>
- This is <see langword="true"/> if this <see cref="T:System.Windows.Controls.Canvas"/> is automatically resized based on the size of the
- loaded drawing; otherwise, it is <see langword="false"/>. The default is <see langword="false"/>, and the
- user-defined size or the parent assigned layout size is used.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.OptimizePath">
- <summary>
- Gets or sets a value indicating whether the path geometry is optimized using the <see cref="T:System.Windows.Media.StreamGeometry"/>.
- </summary>
- <value>
- This is <see langword="true"/> if the path geometry is optimized using the <see cref="T:System.Windows.Media.StreamGeometry"/>;
- otherwise, it is <see langword="false"/>. The default is <see langword="true"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.TextAsGeometry">
- <summary>
- Gets or sets a value indicating whether the texts are rendered as path geometry.
- </summary>
- <value>
- This is <see langword="true"/> if texts are rendered as path geometries; otherwise, this is
- <see langword="false"/>. The default is <see langword="true"/>.
- </value>
- <remarks>
- The text features of the <c>SVG</c> format are complex and difficult to fully support without directly reverting
- the text paths (or glyph geometry). This options will, therefore, be removed in future versions of the library,
- as it is not always honored when set to <see langword="false"/>.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.IncludeRuntime">
- <summary>
- Gets or sets a value indicating whether the <c>SharpVectors.Runtime.dll</c> classes are used in the
- generated output.
- </summary>
- <value>
- This is <see langword="true"/> if the <c>SharpVectors.Runtime.dll</c> classes and types are used in the
- generated output; otherwise, it is <see langword="false"/>. The default is <see langword="true"/>.
- </value>
- <remarks>
- The use of the <c>SharpVectors.Runtime.dll</c> prevents the hard-coded font path generated by the
- <see cref="T:System.Windows.Media.FormattedText"/> class, support for embedded images etc.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.CultureInfo">
- <summary>
- Gets or sets the main culture information used for rendering texts.
- </summary>
- <value>
- An instance of the <see cref="P:SharpVectors.Converters.SvgCanvas.CultureInfo"/> specifying the main
- culture information for texts. The default is the English culture.
- </value>
- <remarks>
- <para>
- This is the culture information passed to the <see cref="T:System.Windows.Media.FormattedText"/> class instance for the text rendering.
- </para>
- <para>
- The library does not currently provide any means of splitting texts into its multi-language parts.
- </para>
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.IgnoreRootViewbox">
- <summary>
- Gets or sets a value to indicate turning off viewbox at the root of the drawing.
- </summary>
- <value>
- For image outputs, this will force the original size to be saved.
- <para>
- The default value is <see langword="false"/>.
- </para>
- </value>
- <remarks>
- There are reported cases where are diagrams displayed in Inkscape program, but will not show when converted.
- These are diagrams on the drawing canvas of Inkspace but outside the svg viewbox.
- <para>
- When converted the drawings are also converted but not displayed due to clipping. Setting this property
- to <see langword="true"/> will clear the clipping region on conversion.
- </para>
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.EnsureViewboxSize">
- <summary>
- Gets or sets a value to indicate preserving the original viewbox size when saving images.
- </summary>
- <value>
- For image outputs, this will force the original size to be saved.
- <para>
- The default value is <see langword="false"/>. However, the ImageSvgConverter converted
- sets this to <see langword="true"/> by default.
- </para>
- </value>
- <remarks>
- Setting this to <see langword="true"/> will cause the rendering process to draw a transparent box around
- the output, if a viewbox is defined. This will ensure that the original image size is saved.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.EnsureViewboxPosition">
- <summary>
- Gets or sets a value to indicate applying a translate transform to the viewbox to ensure
- it is visible when rendered.
- </summary>
- <value>
- This determines whether a transformation is applied to the rendered drawing. For drawings where the top-left
- position of the viewbox is off the screen, due to negative values, this will ensure the drawing is visible.
- <para>
- The default value is <see langword="true"/>. Set this value to <see langword="false"/> if
- you wish to apply your own transformations to the drawings.
- </para>
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.Drawings">
- <summary>
- Gets the drawing from the SVG file conversion.
- </summary>
- <value>
- An instance of the <see cref="T:System.Windows.Media.DrawingGroup"/> specifying the converted drawings
- which is rendered in this canvas.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.MessageFontFamily">
- <summary>
- Gets or sets the font family of the desired font for the message text.
- </summary>
- <value>
- A <see cref="T:System.Windows.Media.FontFamily"/> specifying the font for the message text.
- The default value is <see cref="P:System.Windows.SystemFonts.MessageFontFamily"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.MessageFontSize">
- <summary>
- Gets or sets the size of the desired font for the message text.
- </summary>
- <value>
- A value specifying the font size of the message text. The default is 48 pixels.
- The font size must be a positive number.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.MessageOpacity">
- <summary>
- Gets or sets the opacity factor applied to the entire message text when it is
- rendered in the user interface (UI).
- </summary>
- <value>
- The opacity factor. Default opacity is 1.0. Expected values are between 0.0 and 1.0.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.MessageText">
- <summary>
- Gets or sets the content of the message.
- </summary>
- <value>
- A <see cref="T:System.String"/> specifying the content of the message text.
- The default is "Loading...". This value can be overriden in the <see cref="M:SharpVectors.Converters.SvgCanvas.Unload(System.Boolean,System.String)"/> method.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.MessageBackground">
- <summary>
- Gets or sets a brush that describes the background of a message text.
- </summary>
- <value>
- A <see cref="T:System.Windows.Media.Brush"/> specifying the brush that is used to fill the background of the
- message text. The default is <see cref="P:System.Windows.Media.Brushes.PapayaWhip"/>. If set to <see langword="null"/>,
- the background will not be drawn.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.MessageFillBrush">
- <summary>
- Gets or sets the brush with which to fill the message text.
- This is optional, and can be <see langword="null"/>. If the brush is <see langword="null"/>, no fill is drawn.
- </summary>
- <value>
- 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"/>.
- </value>
- <remarks>
- If both the fill and stroke brushes of the message text are <see langword="null"/>, no text is drawn.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.MessageStrokeBrush">
- <summary>
- Gets or sets the brush of the <see cref="T:System.Windows.Media.Pen"/> with which to stroke the message text.
- This is optional, and can be <see langword="null"/>. If the brush is <see langword="null"/>, no stroke is drawn.
- </summary>
- <value>
- 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.
- The default is <see cref="P:System.Windows.Media.Brushes.Maroon"/>.
- </value>
- <remarks>
- If both the fill and stroke brushes of the message text are <see langword="null"/>, no text is drawn.
- </remarks>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.Load(System.Uri,System.Boolean)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgCanvas"/> by using the supplied Uniform Resource Identifier (URI)
- and optionally processing the result asynchronously.
- </summary>
- <param name="uriSource">A reference to the SVG source file.</param>
- <param name="useAsync">
- A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
- the SVG conversion is processed synchronously.
- </param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.Load(System.String,System.Boolean)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgCanvas"/> by accessing text content
- and optionally processing the result asynchronously.
- </summary>
- <param name="svgSource">The stream source that sets the SVG source value.</param>
- <param name="useAsync">
- A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
- the SVG conversion is processed synchronously.
- </param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.Load(System.IO.Stream,System.Boolean,System.Boolean)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgCanvas"/> by accessing a stream
- and optionally processing the result asynchronously.
- </summary>
- <param name="streamSource">The stream source that sets the SVG source value.</param>
- <param name="useCopyStream">
- A value specifying whether to use a copy of the stream. The default is <see langword="true"/>,
- the SVG source stream is copied, rendered and stored.
- </param>
- <param name="useAsync">
- A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
- the SVG conversion is processed synchronously.
- </param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- <remarks>
- The control will by default create a copy of the source stream to prevent any effect of disposing.
- If the source stream is stored, then use the <paramref name="useCopyStream"/> to prevent the control
- from creating its own copy.
- </remarks>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.LoadAsync(System.Uri)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgCanvas"/> by using the supplied Uniform Resource Identifier (URI)
- and processing the result asynchronously.
- </summary>
- <param name="uriSource">A reference to the SVG source file.</param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.LoadAsync(System.String)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgCanvas"/> by accessing text contents
- and processing the result asynchronously.
- </summary>
- <param name="svgSource">The stream source that sets the SVG source value.</param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.LoadAsync(System.IO.Stream,System.Boolean)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgCanvas"/> by accessing a stream
- and processing the result asynchronously.
- </summary>
- <param name="streamSource">The stream source that sets the SVG source value.</param>
- <param name="useCopyStream">
- A value specifying whether to use a copy of the stream. The default is <see langword="true"/>,
- the SVG source stream is copied, rendered and stored.
- </param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- <remarks>
- The control will by default create a copy of the source stream to prevent any effect of disposing.
- If the source stream is stored, then use the <paramref name="useCopyStream"/> to prevent the control
- from creating its own copy.
- </remarks>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.Unload(System.Boolean,System.String)">
- <summary>
- This clears the <see cref="T:SharpVectors.Converters.SvgCanvas"/> of any drawn diagram and optionally displays a
- message.
- </summary>
- <param name="displayMessage">
- A value indicating whether to display a message after clearing the SVG rendered diagram.
- The value is <see langword="false"/>, not message is displayed.
- </param>
- <param name="message">
- This specifies the message to be displayed after clearing the diagram. Setting this parameter
- to a non-empty text will override any message set in the <see cref="P:SharpVectors.Converters.SvgCanvas.MessageText"/>.
- The default value is <see cref="F:System.String.Empty"/>.
- </param>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.OnInitialized(System.EventArgs)">
- <summary>
- Raises the Initialized event. This method is invoked whenever IsInitialized is set to true.
- </summary>
- <param name="e">Event data for the event.</param>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.GetDrawingSettings">
- <summary>
- Gets the rendering settings or options to be used in rendering the SVG in this control.
- </summary>
- <returns>
- An instance of <see cref="T:SharpVectors.Renderers.Wpf.WpfDrawingSettings"/> specifying the rendering options or settings.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.OnSettingsChanged">
- <summary>
- This handles changes in the rendering settings of this control.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.OnAutoSizeChanged">
- <summary>
- This handles changes in the automatic resizing property of this control.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.CreateDrawing">
- <summary>
- Performs the conversion of a valid SVG source to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
- returns <see langword="null"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.CreateDrawing(System.Uri,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Performs the conversion of a valid SVG source file to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <param name="svgSource">A <see cref="T:System.Uri"/> defining the path to the SVG source.</param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
- returns <see langword="null"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.CreateDrawing(System.IO.Stream,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Performs the conversion of a valid SVG source stream to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <param name="svgStream">A stream providing access to the SVG source data.</param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it returns <see langword="null"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.CreateDrawing(System.String,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Performs the conversion of a valid SVG source stream to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <param name="svgSource">A stream providing access to the SVG source data.</param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it returns <see langword="null"/>.
- </returns>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.BaseUri">
- <summary>
- Gets or sets the base URI of the current application context.
- </summary>
- <value>
- The base URI of the application context.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.SharpVectors#Dom#Svg#ISvgControl#Width">
- <inheritdoc/>
- </member>
- <member name="P:SharpVectors.Converters.SvgCanvas.SharpVectors#Dom#Svg#ISvgControl#Height">
- <inheritdoc/>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.SharpVectors#Dom#Svg#ISvgControl#HandleAlert(System.String)">
- <inheritdoc/>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.SharpVectors#Dom#Svg#ISvgControl#HandleError(System.String)">
- <inheritdoc/>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.SharpVectors#Dom#Svg#ISvgControl#HandleError(System.Exception)">
- <inheritdoc/>
- </member>
- <member name="M:SharpVectors.Converters.SvgCanvas.SharpVectors#Dom#Svg#ISvgControl#HandleError(System.String,System.Exception)">
- <inheritdoc/>
- </member>
- <member name="T:SharpVectors.Converters.SvgControlSizeMode">
- <summary>
-
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgControlSizeMode.None">
- <summary></summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgControlSizeMode.ContentToSizeNoStretch">
- <summary></summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgControlSizeMode.ContentToSizeStretch">
- <summary></summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgControlSizeMode.SizeToContent">
- <summary></summary>
- </member>
- <member name="T:SharpVectors.Converters.SvgControl">
- <summary>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgControl.SourceProperty">
- <summary>
- Identifies the <see cref="P:SharpVectors.Converters.SvgControl.Source"/> dependency property.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgControl.StreamSourceProperty">
- <summary>
- Identifies the <see cref="P:SharpVectors.Converters.SvgControl.StreamSource"/> dependency property.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgControl.MessageFontFamilyProperty">
- <summary>
- The DependencyProperty for the MessageFontFamily property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: System Dialog Font
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgControl.MessageFontSizeProperty">
- <summary>
- The DependencyProperty for the MessageFontSize property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: 48 pixels
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgControl.MessageOpacityProperty">
- <summary>
- The DependencyProperty for the MessageOpacity property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: 1 (full opacity)
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgControl.MessageTextProperty">
- <summary>
- The DependencyProperty for the MessageText property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: "Loading..."
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgControl.MessageBackgroundProperty">
- <summary>
- The DependencyProperty for the MessageBackground property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: <see cref="P:System.Windows.Media.Brushes.PapayaWhip"/>
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgControl.MessageFillBrushProperty">
- <summary>
- The DependencyProperty for the MessageFillBrush property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: <see cref="P:System.Windows.Media.Brushes.Gold"/>
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgControl.MessageStrokeBrushProperty">
- <summary>
- The DependencyProperty for the MessageStrokeBrush property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: <see cref="P:System.Windows.Media.Brushes.Maroon"/>
- </para>
- </summary>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.Source">
- <summary>
- Gets or sets the path to the SVG file to load into this
- <see cref="T:System.Windows.Controls.Canvas"/>.
- </summary>
- <value>
- A <see cref="T:System.Uri"/> specifying the path to the SVG source file.
- The file can be located on a computer, network or assembly resources.
- Settings this to <see langword="null"/> will close any opened diagram.
- </value>
- <seealso cref="P:SharpVectors.Converters.SvgControl.StreamSource"/>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.StreamSource">
- <summary>
- Gets or sets the <see cref="T:System.IO.Stream"/> to the SVG source to load into this
- <see cref="T:System.Windows.Controls.Canvas"/>.
- </summary>
- <value>
- A <see cref="T:System.IO.Stream"/> specifying the stream to the SVG source.
- Settings this to <see langword="null"/> will close any opened diagram.
- </value>
- <remarks>
- <para>
- The stream source has precedence over the Uri <see cref="P:SharpVectors.Converters.SvgControl.Source"/> property.
- If set (not <see langword="null"/>), the stream source will be rendered instead of the Uri source.
- </para>
- <para>
- WPF controls do not implement the <see cref="T:System.IDisposable"/> interface and cannot properly dispose any
- stream set to it. To avoid this issue and also any problem of the user accidentally closing the stream,
- this control makes a copy of the stream to memory stream.
- </para>
- </remarks>
- <seealso cref="P:SharpVectors.Converters.SvgControl.Source"/>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.AutoSize">
- <summary>
- Gets or sets a value indicating whether to automatically resize this
- <see cref="T:System.Windows.Controls.Canvas"/> based on the size of the loaded drawing.
- </summary>
- <value>
- This is <see langword="true"/> if this <see cref="T:System.Windows.Controls.Canvas"/> is
- automatically resized based on the size of the loaded drawing;
- otherwise, it is <see langword="false"/>. The default is
- <see langword="false"/>, and the user-defined size or the parent assigned
- layout size is used.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.OptimizePath">
- <summary>
- Gets or sets a value indicating whether the path geometry is
- optimized using the <see cref="T:System.Windows.Media.StreamGeometry"/>.
- </summary>
- <value>
- This is <see langword="true"/> if the path geometry is optimized
- using the <see cref="T:System.Windows.Media.StreamGeometry"/>; otherwise, it is
- <see langword="false"/>. The default is <see langword="true"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.TextAsGeometry">
- <summary>
- Gets or sets a value indicating whether the texts are rendered as
- path geometry.
- </summary>
- <value>
- This is <see langword="true"/> if texts are rendered as path
- geometries; otherwise, this is <see langword="false"/>. The default
- is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.IncludeRuntime">
- <summary>
- Gets or sets a value indicating whether the <c>SharpVectors.Runtime.dll</c>
- classes are used in the generated output.
- </summary>
- <value>
- This is <see langword="true"/> if the <c>SharpVectors.Runtime.dll</c>
- classes and types are used in the generated output; otherwise, it is
- <see langword="false"/>. The default is <see langword="true"/>.
- </value>
- <remarks>
- The use of the <c>SharpVectors.Runtime.dll</c> prevents the hard-coded
- font path generated by the <see cref="T:System.Windows.Media.FormattedText"/> class, support
- for embedded images etc.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.CultureInfo">
- <summary>
- Gets or sets the main culture information used for rendering texts.
- </summary>
- <value>
- An instance of the <see cref="P:SharpVectors.Converters.SvgControl.CultureInfo"/> specifying the main
- culture information for texts. The default is the English culture.
- </value>
- <remarks>
- <para>
- This is the culture information passed to the <see cref="T:System.Windows.Media.FormattedText"/>
- class instance for the text rendering.
- </para>
- <para>
- The library does not currently provide any means of splitting texts
- into its multi-language parts.
- </para>
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.IgnoreRootViewbox">
- <summary>
- Gets or sets a value to indicate turning off viewbox at the root of the drawing.
- </summary>
- <value>
- For image outputs, this will force the original size to be saved.
- <para>
- The default value is <see langword="false"/>.
- </para>
- </value>
- <remarks>
- There are reported cases where are diagrams displayed in Inkscape program, but will not
- show when converted. These are diagrams on the drawing canvas of Inkspace but outside
- the svg viewbox.
- <para>
- When converted the drawings are also converted but not displayed due to
- clipping. Setting this property to <see langword="true"/> will clear the clipping region
- on conversion.
- </para>
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.EnsureViewboxSize">
- <summary>
- Gets or sets a value to indicate preserving the original viewbox size when saving images.
- </summary>
- <value>
- For image outputs, this will force the original size to be saved.
- <para>
- The default value is <see langword="false"/>. However, the ImageSvgConverter converted
- sets this to <see langword="true"/> by default.
- </para>
- </value>
- <remarks>
- Setting this to <see langword="true"/> will cause the rendering process to draw a transparent
- box around the output, if a viewbox is defined. This will ensure that the original image
- size is saved.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.EnsureViewboxPosition">
- <summary>
- Gets or sets a value to indicate applying a translate transform to the viewbox to ensure
- it is visible when rendered.
- </summary>
- <value>
- This determines whether a transformation is applied to the rendered drawing. For drawings
- where the top-left position of the viewbox is off the screen, due to negative values, this
- will ensure the drawing is visible.
- <para>
- The default value is <see langword="true"/>. Set this value to <see langword="false"/> if
- you wish to apply your own transformations to the drawings.
- </para>
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.Drawings">
- <summary>
- Gets the drawing from the SVG file conversion.
- </summary>
- <value>
- An instance of the <see cref="T:System.Windows.Media.DrawingGroup"/> specifying the converted drawings
- which is rendered in this canvas.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.MessageFontFamily">
- <summary>
- Gets or sets the font family of the desired font for the message text.
- </summary>
- <value>
- A <see cref="T:System.Windows.Media.FontFamily"/> specifying the font for the message text.
- The default value is <see cref="P:System.Windows.SystemFonts.MessageFontFamily"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.MessageFontSize">
- <summary>
- Gets or sets the size of the desired font for the message text.
- </summary>
- <value>
- A value specifying the font size of the message text. The default is 48 pixels.
- The font size must be a positive number.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.MessageOpacity">
- <summary>
- Gets or sets the opacity factor applied to the entire message text when it is
- rendered in the user interface (UI).
- </summary>
- <value>
- The opacity factor. Default opacity is 1.0. Expected values are between 0.0 and 1.0.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.MessageText">
- <summary>
- Gets or sets the content of the message.
- </summary>
- <value>
- A <see cref="T:System.String"/> specifying the content of the message text.
- The default is "Loading...". This value can be overriden in the <see cref="M:SharpVectors.Converters.SvgControl.Unload(System.Boolean,System.String)"/> method.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.MessageBackground">
- <summary>
- Gets or sets a brush that describes the background of a message text.
- </summary>
- <value>
- A <see cref="T:System.Windows.Media.Brush"/> specifying the brush that is used to fill the background of the
- message text. The default is <see cref="P:System.Windows.Media.Brushes.PapayaWhip"/>. If set to <see langword="null"/>,
- the background will not be drawn.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.MessageFillBrush">
- <summary>
- Gets or sets the brush with which to fill the message text.
- This is optional, and can be <see langword="null"/>. If the brush is <see langword="null"/>, no fill is drawn.
- </summary>
- <value>
- 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"/>.
- </value>
- <remarks>
- If both the fill and stroke brushes of the message text are <see langword="null"/>, no text is drawn.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.MessageStrokeBrush">
- <summary>
- Gets or sets the brush of the <see cref="T:System.Windows.Media.Pen"/> with which to stroke the message text.
- This is optional, and can be <see langword="null"/>. If the brush is <see langword="null"/>, no stroke is drawn.
- </summary>
- <value>
- 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.
- The default is <see cref="P:System.Windows.Media.Brushes.Maroon"/>.
- </value>
- <remarks>
- If both the fill and stroke brushes of the message text are <see langword="null"/>, no text is drawn.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgControl.BaseUri">
- <summary>
- Gets or sets the base URI of the current application context.
- </summary>
- <value>
- The base URI of the application context.
- </value>
- </member>
- <member name="M:SharpVectors.Converters.SvgControl.Load(System.Uri,System.Boolean)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgControl"/> by using the supplied Uniform Resource Identifier (URI)
- and optionally processing the result asynchronously.
- </summary>
- <param name="uriSource">A reference to the SVG source file.</param>
- <param name="useAsync">
- A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
- the SVG conversion is processed synchronously.
- </param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgControl.Load(System.IO.Stream,System.Boolean,System.Boolean)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgControl"/> by accessing a stream
- and optionally processing the result asynchronously.
- </summary>
- <param name="streamSource">The stream source that sets the SVG source value.</param>
- <param name="useCopyStream">
- A value specifying whether to use a copy of the stream. The default is <see langword="true"/>,
- the SVG source stream is copied, rendered and stored.
- </param>
- <param name="useAsync">
- A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
- the SVG conversion is processed synchronously.
- </param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- <remarks>
- The control will by default create a copy of the source stream to prevent any effect of disposing.
- If the source stream is stored, then use the <paramref name="useCopyStream"/> to prevent the control
- from creating its own copy.
- </remarks>
- </member>
- <member name="M:SharpVectors.Converters.SvgControl.LoadAsync(System.Uri)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgControl"/> by using the supplied Uniform Resource Identifier (URI)
- and processing the result asynchronously.
- </summary>
- <param name="uriSource">A reference to the SVG source file.</param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgControl.LoadAsync(System.IO.Stream,System.Boolean)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgControl"/> by accessing a stream
- and processing the result asynchronously.
- </summary>
- <param name="streamSource">The stream source that sets the SVG source value.</param>
- <param name="useCopyStream">
- A value specifying whether to use a copy of the stream. The default is <see langword="true"/>,
- the SVG source stream is copied, rendered and stored.
- </param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- <remarks>
- The control will by default create a copy of the source stream to prevent any effect of disposing.
- If the source stream is stored, then use the <paramref name="useCopyStream"/> to prevent the control
- from creating its own copy.
- </remarks>
- </member>
- <member name="M:SharpVectors.Converters.SvgControl.Unload(System.Boolean,System.String)">
- <summary>
- This clears the <see cref="T:SharpVectors.Converters.SvgControl"/> of any drawn diagram and optionally displays a
- message.
- </summary>
- <param name="displayMessage">
- A value indicating whether to display a message after clearing the SVG rendered diagram.
- The value is <see langword="false"/>, not message is displayed.
- </param>
- <param name="message">
- This specifies the message to be displayed after clearing the diagram. Setting this parameter
- to a non-empty text will override any message set in the <see cref="P:SharpVectors.Converters.SvgControl.MessageText"/>.
- The default value is <see cref="F:System.String.Empty"/>.
- </param>
- </member>
- <member name="M:SharpVectors.Converters.SvgControl.OnInitialized(System.EventArgs)">
- <summary>
- Raises the Initialized event. This method is invoked whenever IsInitialized is set to true.
- </summary>
- <param name="e">Event data for the event.</param>
- </member>
- <member name="M:SharpVectors.Converters.SvgControl.OnSettingsChanged">
- <summary>
- This handles changes in the rendering settings of this control.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgControl.OnAutoSizeChanged">
- <summary>
- This handles changes in the automatic resizing property of this control.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgControl.CreateDrawing">
- <summary>
- Performs the conversion of a valid SVG source to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
- returns <see langword="null"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgControl.CreateDrawing(System.Uri,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Performs the conversion of a valid SVG source file to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <param name="svgSource">A <see cref="T:System.Uri"/> defining the path to the SVG source.</param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
- returns <see langword="null"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgControl.CreateDrawing(System.IO.Stream,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Performs the conversion of a valid SVG source stream to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <param name="svgStream">A stream providing access to the SVG source data.</param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it
- returns <see langword="null"/>.
- </returns>
- </member>
- <member name="T:SharpVectors.Converters.SvgConverter">
- <summary>
- This is the <see langword="abstract"/> base class for all <c>SVG</c> to WPF converters.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgConverter._wpfWindow">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgConverter.#ctor">
- <overloads>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgConverter"/> class.
- </overloads>
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgConverter"/> class
- with the default parameters and settings.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgConverter.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgConverter"/> class
- with the specified drawing or rendering settings.
- </summary>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- </member>
- <member name="M:SharpVectors.Converters.SvgConverter.#ctor(System.Boolean,System.Boolean,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgConverter"/> class
- with the specified drawing or rendering settings and the saving options.
- </summary>
- <param name="saveXaml">
- This specifies whether to save result object tree in XAML file.
- </param>
- <param name="saveZaml">
- This specifies whether to save result object tree in ZAML file. The
- ZAML is simply a G-Zip compressed XAML format, similar to the SVGZ.
- </param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- </member>
- <member name="M:SharpVectors.Converters.SvgConverter.Finalize">
- <summary>
- This allows a converter to attempt to free resources and perform
- other cleanup operations before the converter is reclaimed by
- garbage collection.
- </summary>
- </member>
- <member name="P:SharpVectors.Converters.SvgConverter.SaveXaml">
- <summary>
- Gets or sets a value indicating whether to save the conversion output to the <c>XAML</c> file.
- </summary>
- <value>
- This is <see langword="true"/> if the conversion output is saved to the <c>XAML</c> file; otherwise,
- it is <see langword="false"/>. The default depends on the converter.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgConverter.SaveZaml">
- <summary>
- Gets or sets a value indicating whether to save the conversion output to the <c>ZAML</c> file.
- </summary>
- <value>
- This is <see langword="true"/> if the conversion output is saved to the <c>ZAML</c> file; otherwise,
- it is <see langword="false"/>. The default depends on the converter.
- </value>
- <remarks>
- The <c>ZAML</c> is simply a G-Zip compressed <c>XAML</c> format, similar to the <c>SVGZ</c>.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgConverter.UseFrameXamlWriter">
- <summary>
- Gets or sets a value indicating whether to use the .NET framework version of the XAML writer.
- </summary>
- <value>
- This is <see langword="true"/> if the .NET framework version of the <c>XAML</c> writer is used; otherwise,
- a customized XAML writer, <see cref="T:SharpVectors.Converters.XmlXamlWriter"/>, is used. The default is <see langword="false"/>.
- </value>
- <remarks>
- The customized <c>XAML</c> writer is optimized for the conversion process, and it is recommended as the writer,
- unless in cases where it fails to produce accurate result.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgConverter.Background">
- <summary>
- Gets or sets a brush that describes the background of a image.
- </summary>
- <value>
- The brush that is used to fill the background of the control.
- The default is <see langword="null"/> or transparent.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgConverter.DrawingSettings">
- <summary>
- Gets the settings used by the rendering or drawing engine.
- </summary>
- <value>
- An instance of <see cref="T:SharpVectors.Renderers.Wpf.WpfDrawingSettings"/> specifying all
- the options for rendering or drawing.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgConverter.SvgWindow">
- <summary>
- Gets the <c>SVG</c> Window object created by this converter.
- </summary>
- <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>
- </member>
- <member name="P:SharpVectors.Converters.SvgConverter.SvgDocument">
- <summary>
- Gets the current <c>SVG</c> Document created by this converter.
- </summary>
- <value>An instance of <see cref="P:SharpVectors.Converters.SvgConverter.SvgDocument"/> specifying the SVG DOM currently opened by the converter;
- or <see langword="null"/> if no <c>SVG</c> document is currently opened.</value>
- </member>
- <member name="P:SharpVectors.Converters.SvgConverter.DpiX">
- <summary>
- Gets the horizontal dots per inch (dpi) of the static image.
- </summary>
- <value>The horizontal dots per inch (dpi) of the image; that is, the dots per inch (dpi) along the x-axis.</value>
- </member>
- <member name="P:SharpVectors.Converters.SvgConverter.DpiY">
- <summary>
- Gets the vertical dots per inch (dpi) of the static image.
- </summary>
- <value>The vertical dots per inch (dpi) of the image; that is, the dots per inch (dpi) along the y-axis.</value>
- </member>
- <member name="M:SharpVectors.Converters.SvgConverter.BeginProcessing(SharpVectors.Renderers.Wpf.WpfDrawingDocument)">
- <summary>
-
- </summary>
- <param name="drawingDocument"></param>
- </member>
- <member name="M:SharpVectors.Converters.SvgConverter.EndProcessing">
- <summary>
-
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgConverter.GetBitmapEncoder(SharpVectors.Converters.ImageEncoderType)">
- <summary>
-
- </summary>
- <param name="encoderType"></param>
- <returns></returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgConverter.GetImageFileExtention(SharpVectors.Converters.ImageEncoderType)">
- <summary>
-
- </summary>
- <param name="encoderType"></param>
- <returns></returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgConverter.Dispose">
- <overloads>
- This releases all resources used by the <see cref="T:SharpVectors.Converters.SvgConverter"/> object.
- </overloads>
- <summary>
- This releases all resources used by the <see cref="T:SharpVectors.Converters.SvgConverter"/> object.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgConverter.Dispose(System.Boolean)">
- <summary>
- This releases the unmanaged resources used by the <see cref="T:SharpVectors.Converters.SvgConverter"/>
- and optionally releases the managed resources.
- </summary>
- <param name="disposing">
- This is <see langword="true"/> if managed resources should be
- disposed; otherwise, <see langword="false"/>.
- </param>
- </member>
- <member name="T:SharpVectors.Converters.SvgIcon">
- <summary>
- This is an extension of the WPF <see cref="T:System.Windows.Controls.Image"/> control to provide SVG-based image sources.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgIcon.FillProperty">
- <summary>
-
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgIcon.StrokeProperty">
- <summary>
-
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgIcon.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgIcon"/> class.
- </summary>
- </member>
- <member name="T:SharpVectors.Converters.SvgImageBase">
- <summary>
- This is an <see langword="abstract"/> implementation of a markup extension that enables the creation
- of <see cref="T:System.Windows.Media.DrawingImage"/> from SVG sources.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgImageBase.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgImageBase"/>
- class with the default parameters.
- </summary>
- </member>
- <member name="P:SharpVectors.Converters.SvgImageBase.OptimizePath">
- <summary>
- Gets or sets a value indicating whether the path geometry is
- optimized using the <see cref="T:System.Windows.Media.StreamGeometry"/>.
- </summary>
- <value>
- This is <see langword="true"/> if the path geometry is optimized using the <see cref="T:System.Windows.Media.StreamGeometry"/>;
- otherwise, it is <see langword="false"/>. The default is <see langword="true"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgImageBase.TextAsGeometry">
- <summary>
- Gets or sets a value indicating whether the texts are rendered as
- path geometry.
- </summary>
- <value>
- This is <see langword="true"/> if texts are rendered as path
- geometries; otherwise, this is <see langword="false"/>. The default
- is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgImageBase.IncludeRuntime">
- <summary>
- Gets or sets a value indicating whether the <c>SharpVectors.Runtime.dll</c>
- classes are used in the generated output.
- </summary>
- <value>
- This is <see langword="true"/> if the <c>SharpVectors.Runtime.dll</c>
- classes and types are used in the generated output; otherwise, it is
- <see langword="false"/>. The default is <see langword="true"/>.
- </value>
- <remarks>
- The use of the <c>SharpVectors.Runtime.dll</c> prevents the hard-coded
- font path generated by the <see cref="T:System.Windows.Media.FormattedText"/> class, support
- for embedded images etc.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgImageBase.CultureInfo">
- <summary>
- Gets or sets the main culture information used for rendering texts.
- </summary>
- <value>
- An instance of the <see cref="P:SharpVectors.Converters.SvgImageBase.CultureInfo"/> specifying the main
- culture information for texts. The default is the English culture.
- </value>
- <remarks>
- <para>
- This is the culture information passed to the <see cref="T:System.Windows.Media.FormattedText"/>
- class instance for the text rendering.
- </para>
- <para>
- The library does not currently provide any means of splitting texts
- into its multi-language parts.
- </para>
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgImageBase.AppName">
- <summary>
- Gets or sets the project or application name of the target assembly.
- </summary>
- <value>
- A string specifying the application project name.
- </value>
- <remarks>
- This is optional and is only used to resolve the resource Uri at the design time.
- </remarks>
- </member>
- <member name="M:SharpVectors.Converters.SvgImageBase.GetDrawing(System.Uri)">
- <summary>
- This converts the SVG resource specified by the Uri to <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <param name="svgSource">A <see cref="T:System.Uri"/> specifying the source of the SVG resource.</param>
- <returns>A <see cref="T:System.Windows.Media.DrawingGroup"/> of the converted SVG resource.</returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgImageBase.GetImage(System.Uri)">
- <summary>
- This converts the SVG resource specified by the Uri to <see cref="T:System.Windows.Media.DrawingImage"/>.
- </summary>
- <param name="svgSource">A <see cref="T:System.Uri"/> specifying the source of the SVG resource.</param>
- <returns>A <see cref="T:System.Windows.Media.DrawingImage"/> of the converted SVG resource.</returns>
- <remarks>
- 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"/>,
- which is then wrapped in <see cref="T:System.Windows.Media.DrawingImage"/>.
- </remarks>
- </member>
- <member name="T:SharpVectors.Converters.SvgImageConverterExtension">
- <summary>
- This implements a markup extension that enables the creation
- of <see cref="T:System.Windows.Media.DrawingImage"/> from SVG sources.
- </summary>
- <remarks>
- The SVG source file can be:
- <list type="bullet">
- <item>
- <description>From the web</description>
- </item>
- <item>
- <description>From the local computer (relative or absolute paths)</description>
- </item>
- <item>
- <description>From the resources.</description>
- </item>
- </list>
- <para>
- The rendering settings are provided as properties for customizations.
- </para>
- </remarks>
- </member>
- <member name="M:SharpVectors.Converters.SvgImageConverterExtension.#ctor">
- <overloads>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgImageConverterExtension"/> class.
- </overloads>
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgImageConverterExtension"/>
- class with the default parameters.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgImageConverterExtension.ProvideValue(System.IServiceProvider)">
- <summary>
- Performs the conversion of a valid SVG source file to the
- <see cref="T:System.Windows.Media.DrawingImage"/> that is set as the value of the target
- property for this markup extension.
- </summary>
- <param name="serviceProvider">
- Object that can provide services for the markup extension.
- </param>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingImage"/> if successful; otherwise, it
- returns <see langword="null"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgImageConverterExtension.ResolveUri(System.String)">
- <summary>
- Converts the SVG source file to <see cref="T:System.Uri"/>
- </summary>
- <param name="inputParameter">
- Object that can provide services for the markup extension.
- </param>
- <returns>
- Returns the valid <see cref="T:System.Uri"/> of the SVG source path if
- successful; otherwise, it returns <see langword="null"/>.
- </returns>
- </member>
- <member name="T:SharpVectors.Converters.SvgImageExtension">
- <summary>
- This implements a markup extension that enables the creation
- of <see cref="T:System.Windows.Media.DrawingImage"/> from SVG sources.
- </summary>
- <remarks>
- The SVG source file can be:
- <list type="bullet">
- <item>
- <description>From the web</description>
- </item>
- <item>
- <description>From the local computer (relative or absolute paths)</description>
- </item>
- <item>
- <description>From the resources.</description>
- </item>
- </list>
- <para>
- The rendering settings are provided as properties for customizations.
- </para>
- </remarks>
- </member>
- <member name="M:SharpVectors.Converters.SvgImageExtension.#ctor">
- <overloads>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgImageExtension"/> class.
- </overloads>
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgImageExtension"/>
- class with the default parameters.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgImageExtension.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgImageExtension"/>
- class with the specified SVG file path.
- </summary>
- <param name="svgPath"></param>
- </member>
- <member name="P:SharpVectors.Converters.SvgImageExtension.Source">
- <summary>
- Gets or sets the SVG source file.
- </summary>
- <value>
- A string specifying the path of the SVG source file.
- The default is <see langword="null"/>.
- </value>
- </member>
- <member name="M:SharpVectors.Converters.SvgImageExtension.ProvideValue(System.IServiceProvider)">
- <summary>
- Performs the conversion of a valid SVG source file to the
- <see cref="T:System.Windows.Media.DrawingImage"/> that is set as the value of the target
- property for this markup extension.
- </summary>
- <param name="serviceProvider">
- Object that can provide services for the markup extension.
- </param>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingImage"/> if successful; otherwise, it
- returns <see langword="null"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgImageExtension.ResolveUri(System.IServiceProvider)">
- <summary>
- Converts the SVG source file to <see cref="T:System.Uri"/>
- </summary>
- <param name="serviceProvider">
- Object that can provide services for the markup extension.
- </param>
- <returns>
- Returns the valid <see cref="T:System.Uri"/> of the SVG source path if
- successful; otherwise, it returns <see langword="null"/>.
- </returns>
- </member>
- <member name="T:SharpVectors.Converters.SvgViewbox">
- <summary>
- This is a <see cref="T:System.Windows.Controls.Viewbox"/> control for viewing <c>SVG</c> file in <c>WPF</c> applications.
- </summary>
- <remarks>
- It wraps the drawing canvas, <see cref="T:SharpVectors.Runtime.SvgDrawingCanvas"/>, instead of image control, therefore any
- interactivity support implemented in the drawing canvas will be available in the <see cref="T:System.Windows.Controls.Viewbox"/>.
- </remarks>
- <seealso cref="T:SharpVectors.Converters.SvgCanvas"/>
- </member>
- <member name="F:SharpVectors.Converters.SvgViewbox.SourceProperty">
- <summary>
- Identifies the <see cref="P:SharpVectors.Converters.SvgViewbox.Source"/> dependency property.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgViewbox.UriSourceProperty">
- <summary>
- Identifies the <see cref="P:SharpVectors.Converters.SvgViewbox.UriSource"/> dependency property.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgViewbox.SvgSourceProperty">
- <summary>
- Identifies the <see cref="P:SharpVectors.Converters.SvgViewbox.SvgSource"/> dependency property.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgViewbox.StreamSourceProperty">
- <summary>
- Identifies the <see cref="P:SharpVectors.Converters.SvgViewbox.StreamSource"/> dependency property.
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgViewbox.MessageFontFamilyProperty">
- <summary>
- The DependencyProperty for the MessageFontFamily property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: System Dialog Font
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgViewbox.MessageFontSizeProperty">
- <summary>
- The DependencyProperty for the MessageFontSize property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: 48 pixels
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgViewbox.MessageOpacityProperty">
- <summary>
- The DependencyProperty for the MessageOpacity property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: 1 (full opacity)
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgViewbox.MessageTextProperty">
- <summary>
- The DependencyProperty for the MessageText property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: "Loading..."
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgViewbox.MessageBackgroundProperty">
- <summary>
- The DependencyProperty for the MessageBackground property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: <see cref="P:System.Windows.Media.Brushes.PapayaWhip"/>
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgViewbox.MessageFillBrushProperty">
- <summary>
- The DependencyProperty for the MessageFillBrush property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: <see cref="P:System.Windows.Media.Brushes.Gold"/>
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgViewbox.MessageStrokeBrushProperty">
- <summary>
- The DependencyProperty for the MessageStrokeBrush property.
- <para>
- Flags: Can be used in style rules
- </para>
- <para>
- Default Value: <see cref="P:System.Windows.Media.Brushes.Maroon"/>
- </para>
- </summary>
- </member>
- <member name="F:SharpVectors.Converters.SvgViewbox.AppNameProperty">
- <summary>
- The <see cref="T:System.Windows.DependencyProperty"/> for the <c>AppName</c> property.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.SvgViewbox"/> class.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.#cctor">
- <summary>
- Static constructor to define metadata for the control (and link it to the style in Generic.xaml).
- </summary>
- </member>
- <member name="E:SharpVectors.Converters.SvgViewbox.Alert">
- <summary>
- This event occurs when an alert message needs to be displayed.
- </summary>
- <remarks>
- <para>If this event is not handled, the control may display the alert message using the standard message dialog.</para>
- <para>
- If you do not want to display the alert messages, handle this event and set <see cref="P:SharpVectors.Runtime.SvgAlertArgs.Handled"/>
- property to <see langword="true"/>.
- </para>
- </remarks>
- </member>
- <member name="E:SharpVectors.Converters.SvgViewbox.Error">
- <summary>
- This event occurs when an error message needs to be displayed.
- </summary>
- <remarks>
- <para>If this event is not handled, the control may display the error message using the standard message dialog.</para>
- <para>
- If you do not want to display the error messages, handle this event and set <see cref="P:SharpVectors.Runtime.SvgErrorArgs.Handled"/>
- property to <see langword="true"/>.
- </para>
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.AppName">
- <summary>
- Gets or sets the <c>name</c> of the parent assembly for this element.
- </summary>
- <value>
- A string containing the name of the parent assembly or the name of the assembly containing <c>SVG</c> file
- referenced on this control in XAML, if the source type is <see cref="T:System.Uri"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.AppTitle">
- <summary>
- Gets or sets the application title, which is used to display the alert and error messages not handled
- by the user.
- </summary>
- <value>
- A string containg the application title. This cannot be <see langword="null"/> or empty.
- The default is <c>SharpVectors</c>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.Source">
- <summary>
- Gets or sets the path to the <c>SVG</c> file to load into this <see cref="T:System.Windows.Controls.Viewbox"/>.
- </summary>
- <value>
- A <see cref="T:System.Uri"/> specifying the path to the <c>SVG</c> source file. The file can be located on a computer,
- network or assembly resources. Settings this to <see langword="null"/> will close any rendered <c>SVG</c> diagram.
- </value>
- <seealso cref="P:SharpVectors.Converters.SvgViewbox.UriSource"/>
- <seealso cref="P:SharpVectors.Converters.SvgViewbox.SvgSource"/>
- <seealso cref="P:SharpVectors.Converters.SvgViewbox.StreamSource"/>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.UriSource">
- <summary>
- Gets or sets the path to the <c>SVG</c> file to load into this <see cref="T:System.Windows.Controls.Viewbox"/>.
- </summary>
- <value>
- A <see cref="T:System.Uri"/> specifying the path to the <c>SVG</c> source file. The file can be located on a computer,
- network or assembly resources. Settings this to <see langword="null"/> will close any rendered <c>SVG</c> diagram.
- </value>
- <remarks>
- This is the same as the <see cref="P:SharpVectors.Converters.SvgViewbox.Source"/> property, and added for consistency.
- </remarks>
- <seealso cref="P:SharpVectors.Converters.SvgViewbox.SvgSource"/>
- <seealso cref="P:SharpVectors.Converters.SvgViewbox.StreamSource"/>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.SvgSource">
- <summary>
- Gets or sets the <c>SVG</c> contents to load into this <see cref="T:System.Windows.Controls.Viewbox"/>.
- </summary>
- <value>
- A <see cref="T:System.String"/> specifying the embedded <c>SVG</c> contents.
- Settings this to <see langword="null"/> will close any opened diagram.
- </value>
- <seealso cref="P:SharpVectors.Converters.SvgViewbox.UriSource"/>
- <seealso cref="P:SharpVectors.Converters.SvgViewbox.StreamSource"/>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.StreamSource">
- <summary>
- 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"/>.
- </summary>
- <value>
- A <see cref="T:System.IO.Stream"/> specifying the stream to the SVG source.
- Settings this to <see langword="null"/> will close any opened diagram.
- </value>
- <remarks>
- <para>
- The stream source has precedence over the Uri <see cref="P:SharpVectors.Converters.SvgViewbox.Source"/> property.
- If set (not <see langword="null"/>), the stream source will be rendered instead of the Uri source.
- </para>
- <para>
- WPF controls do not implement the <see cref="T:System.IDisposable"/> interface and cannot properly dispose any
- stream set to it. To avoid this issue and also any problem of the user accidentally closing the stream,
- this control makes a copy of the stream to memory stream.
- </para>
- </remarks>
- <seealso cref="P:SharpVectors.Converters.SvgViewbox.Source"/>
- <seealso cref="P:SharpVectors.Converters.SvgViewbox.SvgSource"/>
- <seealso cref="P:SharpVectors.Converters.SvgViewbox.UriSource"/>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.DrawingCanvas">
- <summary>
- Gets the drawing canvas, which is the child of this <see cref="T:System.Windows.Controls.Viewbox"/>.
- </summary>
- <value>
- An instance of the <see cref="T:SharpVectors.Runtime.SvgDrawingCanvas"/> specifying the child
- of this <see cref="T:System.Windows.Controls.Viewbox"/>, which handles the rendering.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.Drawings">
- <summary>
- Gets the drawing from the SVG file conversion.
- </summary>
- <value>
- An instance of the <see cref="T:System.Windows.Media.DrawingGroup"/> specifying the converted drawings
- which is rendered in the canvas and displayed in the this viewbox.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.AutoSize">
- <summary>
- Gets or sets a value indicating whether to automatically resize this
- <see cref="T:System.Windows.Controls.Viewbox"/> based on the size of the loaded drawing.
- </summary>
- <value>
- This is <see langword="true"/> if this <see cref="T:System.Windows.Controls.Viewbox"/> is automatically resized based on the size of
- the loaded drawing; otherwise, it is <see langword="false"/>. The default is <see langword="false"/>, and
- the user-defined size or the parent assigned layout size is used.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.OptimizePath">
- <summary>
- Gets or sets a value indicating whether the path geometry is
- optimized using the <see cref="T:System.Windows.Media.StreamGeometry"/>.
- </summary>
- <value>
- This is <see langword="true"/> if the path geometry is optimized using the <see cref="T:System.Windows.Media.StreamGeometry"/>;
- otherwise, it is <see langword="false"/>. The default is <see langword="true"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.TextAsGeometry">
- <summary>
- Gets or sets a value indicating whether the texts are rendered as path geometry.
- </summary>
- <value>
- This is <see langword="true"/> if texts are rendered as path geometries; otherwise, this is
- <see langword="false"/>. The default is <see langword="false"/>.
- </value>
- <remarks>
- The text features of the <c>SVG</c> format are complex and difficult to fully support without directly reverting
- the text paths (or glyph geometry). This options will, therefore, be removed in future versions of the library,
- as it is not always honored when set to <see langword="false"/>.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.IncludeRuntime">
- <summary>
- Gets or sets a value indicating whether the <c>SharpVectors.Runtime.dll</c>
- classes are used in the generated output.
- </summary>
- <value>
- This is <see langword="true"/> if the <c>SharpVectors.Runtime.dll</c> classes and types are used in the
- generated output; otherwise, it is <see langword="false"/>. The default is <see langword="true"/>.
- </value>
- <remarks>
- The use of the <c>SharpVectors.Runtime.dll</c> prevents the hard-coded font path generated by the
- <see cref="T:System.Windows.Media.FormattedText"/> class, support for embedded images etc.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.CultureInfo">
- <summary>
- Gets or sets the main culture information used for rendering texts.
- </summary>
- <value>
- An instance of the <see cref="P:SharpVectors.Converters.SvgViewbox.CultureInfo"/> specifying the main
- culture information for texts. The default is the English culture.
- </value>
- <remarks>
- <para>
- This is the culture information passed to the <see cref="T:System.Windows.Media.FormattedText"/>
- class instance for the text rendering.
- </para>
- <para>
- The library does not currently provide any means of splitting texts into its multi-language parts.
- </para>
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.IgnoreRootViewbox">
- <summary>
- Gets or sets a value to indicate turning off viewbox at the root of the drawing.
- </summary>
- <value>
- For image outputs, this will force the original size to be saved.
- <para>
- The default value is <see langword="false"/>.
- </para>
- </value>
- <remarks>
- There are reported cases where are diagrams displayed in Inkscape program, but will not show when converted.
- These are diagrams on the drawing canvas of Inkspace but outside the svg viewbox.
- <para>
- When converted the drawings are also converted but not displayed due to clipping. Setting this property
- to <see langword="true"/> will clear the clipping region on conversion.
- </para>
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.EnsureViewboxSize">
- <summary>
- Gets or sets a value to indicate preserving the original viewbox size when saving images.
- </summary>
- <value>
- For image outputs, this will force the original size to be saved.
- <para>
- The default value is <see langword="false"/>. However, the ImageSvgConverter converted
- sets this to <see langword="true"/> by default.
- </para>
- </value>
- <remarks>
- Setting this to <see langword="true"/> will cause the rendering process to draw a transparent
- box around the output, if a viewbox is defined. This will ensure that the original image size is saved.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.EnsureViewboxPosition">
- <summary>
- Gets or sets a value to indicate applying a translate transform to the viewbox to ensure
- it is visible when rendered.
- </summary>
- <value>
- This determines whether a transformation is applied to the rendered drawing. For drawings where the top-left
- position of the viewbox is off the screen, due to negative values, this will ensure the drawing is visible.
- <para>
- The default value is <see langword="true"/>. Set this value to <see langword="false"/> if
- you wish to apply your own transformations to the drawings.
- </para>
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.MessageFontFamily">
- <summary>
- Gets or sets the font family of the desired font for the message text.
- </summary>
- <value>
- A <see cref="T:System.Windows.Media.FontFamily"/> specifying the font for the message text.
- The default value is <see cref="P:System.Windows.SystemFonts.MessageFontFamily"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.MessageFontSize">
- <summary>
- Gets or sets the size of the desired font for the message text.
- </summary>
- <value>
- A value specifying the font size of the message text. The default is 48 pixels.
- The font size must be a positive number.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.MessageOpacity">
- <summary>
- Gets or sets the opacity factor applied to the entire message text when it is
- rendered in the user interface (UI).
- </summary>
- <value>
- The opacity factor. Default opacity is 1.0. Expected values are between 0.0 and 1.0.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.MessageText">
- <summary>
- Gets or sets the content of the message.
- </summary>
- <value>
- A <see cref="T:System.String"/> specifying the content of the message text.
- The default is "Loading...". This value can be overriden in the <see cref="M:SharpVectors.Converters.SvgViewbox.Unload(System.Boolean,System.String)"/> method.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.MessageBackground">
- <summary>
- Gets or sets a brush that describes the background of a message text.
- </summary>
- <value>
- A <see cref="T:System.Windows.Media.Brush"/> specifying the brush that is used to fill the background of the
- message text. The default is <see cref="P:System.Windows.Media.Brushes.PapayaWhip"/>. If set to <see langword="null"/>,
- the background will not be drawn.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.MessageFillBrush">
- <summary>
- Gets or sets the brush with which to fill the message text.
- This is optional, and can be <see langword="null"/>. If the brush is <see langword="null"/>, no fill is drawn.
- </summary>
- <value>
- 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"/>.
- </value>
- <remarks>
- If both the fill and stroke brushes of the message text are <see langword="null"/>, no text is drawn.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.MessageStrokeBrush">
- <summary>
- Gets or sets the brush of the <see cref="T:System.Windows.Media.Pen"/> with which to stroke the message text.
- This is optional, and can be <see langword="null"/>. If the brush is <see langword="null"/>, no stroke is drawn.
- </summary>
- <value>
- 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.
- The default is <see cref="P:System.Windows.Media.Brushes.Maroon"/>.
- </value>
- <remarks>
- If both the fill and stroke brushes of the message text are <see langword="null"/>, no text is drawn.
- </remarks>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.InteractiveMode">
- <summary>
- Gets or sets a value specifying the interactive mode, which controls the level of information attached
- to the generated drawing.
- </summary>
- <value>An enumeration of the type <see cref="T:SharpVectors.Runtime.SvgInteractiveModes"/> specifying the interactive mode.
- The default is <see cref="F:SharpVectors.Runtime.SvgInteractiveModes.None"/>; no interactivity and may change in the future.</value>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.Load(System.Uri,System.Boolean)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgViewbox"/> by using the supplied Uniform Resource Identifier (URI)
- and optionally processing the result asynchronously.
- </summary>
- <param name="uriSource">A reference to the SVG source file.</param>
- <param name="useAsync">
- A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
- the SVG conversion is processed synchronously.
- </param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.Load(System.String,System.Boolean)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgViewbox"/> by accessing text contents
- and optionally processing the result asynchronously.
- </summary>
- <param name="svgSource">The stream source that sets the SVG source value.</param>
- <param name="useCopyStream">
- A value specifying whether to use a copy of the stream. The default is <see langword="true"/>,
- the SVG source stream is copied, rendered and stored.
- </param>
- <param name="useAsync">
- A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
- the SVG conversion is processed synchronously.
- </param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.Load(System.IO.Stream,System.Boolean,System.Boolean)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgViewbox"/> by accessing a stream
- and optionally processing the result asynchronously.
- </summary>
- <param name="streamSource">The stream source that sets the SVG source value.</param>
- <param name="useCopyStream">
- A value specifying whether to use a copy of the stream. The default is <see langword="true"/>,
- the SVG source stream is copied, rendered and stored.
- </param>
- <param name="useAsync">
- A value indicating whether to process the result asynchronously. The default value is <see langword="false"/>,
- the SVG conversion is processed synchronously.
- </param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- <remarks>
- The control will by default create a copy of the source stream to prevent any effect of disposing.
- If the source stream is stored, then use the <paramref name="useCopyStream"/> to prevent the control
- from creating its own copy.
- </remarks>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.LoadAsync(System.Uri)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgViewbox"/> by using the supplied Uniform Resource Identifier (URI)
- and processing the result asynchronously.
- </summary>
- <param name="uriSource">A reference to the SVG source file.</param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.LoadAsync(System.String)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgViewbox"/> by accessing text contents
- and processing the result asynchronously.
- </summary>
- <param name="svgSource">The stream source that sets the SVG source value.</param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.LoadAsync(System.IO.Stream,System.Boolean)">
- <summary>
- This sets the source SVG for a <see cref="T:SharpVectors.Converters.SvgViewbox"/> by accessing a stream
- and processing the result asynchronously.
- </summary>
- <param name="streamSource">The stream source that sets the SVG source value.</param>
- <param name="useCopyStream">
- A value specifying whether to use a copy of the stream. The default is <see langword="true"/>,
- the SVG source stream is copied, rendered and stored.
- </param>
- <returns>
- A value that indicates whether the operation was successful. This is <see langword="true"/>
- if successful, otherwise, it is <see langword="false"/>.
- </returns>
- <remarks>
- The control will by default create a copy of the source stream to prevent any effect of disposing.
- If the source stream is stored, then use the <paramref name="useCopyStream"/> to prevent the control
- from creating its own copy.
- </remarks>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.Unload(System.Boolean,System.String)">
- <summary>
- This clears the <see cref="T:SharpVectors.Converters.SvgViewbox"/> of any drawn diagram and optionally displays a
- message.
- </summary>
- <param name="displayMessage">
- A value indicating whether to display a message after clearing the SVG rendered diagram.
- The value is <see langword="false"/>, not message is displayed.
- </param>
- <param name="message">
- This specifies the message to be displayed after clearing the diagram. Setting this parameter
- to a non-empty text will override any message set in the <see cref="P:SharpVectors.Converters.SvgViewbox.MessageText"/>.
- The default value is <see cref="F:System.String.Empty"/>.
- </param>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.GetDrawingSettings">
- <summary>
- Gets the rendering settings or options to be used in rendering the SVG in this control.
- </summary>
- <returns>
- An instance of <see cref="T:SharpVectors.Renderers.Wpf.WpfDrawingSettings"/> specifying the rendering options or settings.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.OnInitialized(System.EventArgs)">
- <summary>
- Raises the Initialized event. This method is invoked whenever IsInitialized is set to true.
- </summary>
- <param name="e">Event data for the event.</param>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.OnSettingsChanged">
- <summary>
- This handles changes in the rendering settings of this control.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.OnAutoSizeChanged">
- <summary>
- This handles changes in the automatic resizing property of this control.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.CreateDrawing">
- <summary>
- Performs the conversion of a valid SVG source to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it returns <see langword="null"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.CreateDrawing(System.Uri,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Performs the conversion of a valid SVG source file to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <param name="svgSource">A <see cref="T:System.Uri"/> defining the path to the SVG source.</param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it returns <see langword="null"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.CreateDrawing(System.IO.Stream,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Performs the conversion of a valid SVG source stream to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <param name="svgStream">A stream providing access to the SVG source data.</param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it returns <see langword="null"/>.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.CreateDrawing(System.String,SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Performs the conversion of a valid SVG source stream to the <see cref="T:System.Windows.Media.DrawingGroup"/>.
- </summary>
- <param name="svgSource">A stream providing access to the SVG source data.</param>
- <param name="settings">
- This specifies the settings used by the rendering or drawing engine.
- If this is <see langword="null"/>, the default settings is used.
- </param>
- <returns>
- This returns <see cref="T:System.Windows.Media.DrawingGroup"/> if successful; otherwise, it returns <see langword="null"/>.
- </returns>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.BaseUri">
- <summary>
- Gets or sets the base URI of the current application context.
- </summary>
- <value>
- The base URI of the application context.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.DesignMode">
- <inheritdoc/>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.SharpVectors#Dom#Svg#ISvgControl#Width">
- <inheritdoc/>
- </member>
- <member name="P:SharpVectors.Converters.SvgViewbox.SharpVectors#Dom#Svg#ISvgControl#Height">
- <inheritdoc/>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.SharpVectors#Dom#Svg#ISvgControl#HandleAlert(System.String)">
- <inheritdoc/>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.SharpVectors#Dom#Svg#ISvgControl#HandleError(System.String)">
- <inheritdoc/>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.SharpVectors#Dom#Svg#ISvgControl#HandleError(System.Exception)">
- <inheritdoc/>
- </member>
- <member name="M:SharpVectors.Converters.SvgViewbox.SharpVectors#Dom#Svg#ISvgControl#HandleError(System.String,System.Exception)">
- <inheritdoc/>
- </member>
- <member name="T:SharpVectors.Converters.Utils.DirectoryUtils">
- <summary>
- Copies a file or a directory and its contents to a new location.
- </summary>
- </member>
- <member name="P:SharpVectors.Converters.Utils.DirectoryUtils.Recursive">
- <summary>
- Gets or sets a value indicating whether the directory copying is
- recursive, that is includes the sub-directories.
- </summary>
- <value>
- This property is <see langword="true"/> if the sub-directories are
- included in the directory copy; otherwise, it is <see langword="false"/>.
- The default is <see langword="true"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.Utils.DirectoryUtils.Overwrite">
- <summary>
- Gets or sets a value indicating whether an existing file is overwritten.
- </summary>
- <value>
- This property is <see langword="true"/> if existing file is overwritten;
- otherwise, it is <see langword="false"/>. The default is <see langword="true"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.Utils.DirectoryUtils.IncludeSecurity">
- <summary>
- Gets or sets a value indicating whether the security settings of the
- copied file is retained.
- </summary>
- <value>
- This property is <see langword="true"/> if the security settings of the
- file is also copied; otherwise, it is <see langword="false"/>. The
- default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.Utils.DirectoryUtils.IncludeHidden">
- <summary>
- Gets or sets a value indicating whether the copy operation includes
- hidden directories and files.
- </summary>
- <value>
- This property is <see langword="true"/> if hidden directories and files
- are included in the copy operation; otherwise, it is
- <see langword="false"/>. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="M:SharpVectors.Converters.Utils.DirectoryUtils.Copy(System.String,System.String)">
- <summary>
-
- </summary>
- <param name="sourceDir">
- The path of the file or directory to copy.
- </param>
- <param name="targetDir">
- The path to the new location.
- </param>
- </member>
- <member name="T:SharpVectors.Converters.XmlXamlWriter">
- <summary>
- This is a customized XAML writer, which provides Extensible Application
- Markup Language (XAML) serialization of provided runtime objects into XAML.
- </summary>
- <remarks>
- <para>
- This is designed to be used by the SVG to XAML converters, and may not be useful in general applications.
- </para>
- <para>The writer is created with help from the following posts (Archived Forums):</para>
- <para>
- <see href="https://social.msdn.microsoft.com/Forums/vstudio/en-US/c9225e3d-298d-4012-b6c4-663973c426ed/xaml-serialization-replacement?forum=wpf">
- XAML Serialization Replacement
- </see>
- </para>
- <para>
- <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">
- Saving and Loading of Interface in XAML Format
- </see>
- </para>
- <para>
- <see href="https://social.msdn.microsoft.com/Forums/vstudio/en-US/08aebbf1-0a61-4305-83b2-a0a37bb24002/xamlwriter-markupobject-how-to-?forum=wpf">
- XamlWriter, MarkupObject How to?
- </see>
- </para>
- </remarks>
- </member>
- <member name="M:SharpVectors.Converters.XmlXamlWriter.#ctor">
- <overloads>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.XmlXamlWriter"/> class.
- </overloads>
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.XmlXamlWriter"/> class with the default settings.
- </summary>
- </member>
- <member name="M:SharpVectors.Converters.XmlXamlWriter.#ctor(SharpVectors.Renderers.Wpf.WpfDrawingSettings)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpVectors.Converters.XmlXamlWriter"/> class with the specified settings.
- </summary>
- <param name="settings">
- An instance of <see cref="T:SharpVectors.Renderers.Wpf.WpfDrawingSettings"/> specifying the rendering options.
- </param>
- </member>
- <member name="P:SharpVectors.Converters.XmlXamlWriter.IncludeNullExtension">
- <summary>
- Gets or sets a value indicating whether to include a null markup extension in the output XAML.
- </summary>
- <value>
- This is <see langword="true"/> if the null markup extension is included in the output XAML; otherwise,
- it is <see langword="false"/>. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:SharpVectors.Converters.XmlXamlWriter.IndentSpaces">
- <summary>
- Gets or sets the number of character string to use when indenting.
- </summary>
- <value>
- A non-negative value (from 0 to 8) specifying the number of character string.
- The default is 2 or two spaces.
- </value>
- </member>
- <member name="M:SharpVectors.Converters.XmlXamlWriter.Convert(System.Object)">
- <summary>
- Returns a Extensible Application Markup Language (XAML) string that serializes the provided object.
- </summary>
- <param name="obj">The element to be serialized. Typically, this is the root element of a page or application.</param>
- <returns>
- Extensible Application Markup Language (XAML) string that can be written to a stream or file.
- The logical tree of all elements that fall under the provided obj element will be serialized.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.XmlXamlWriter.Save(System.Object)">
- <summary>
- Returns a Extensible Application Markup Language (XAML) string that serializes the provided object.
- </summary>
- <param name="obj">The element to be serialized. Typically, this is the root element of a page or application.</param>
- <returns>
- Extensible Application Markup Language (XAML) string that can be written to a stream or file.
- The logical tree of all elements that fall under the provided obj element will be serialized.
- </returns>
- </member>
- <member name="M:SharpVectors.Converters.XmlXamlWriter.Save(System.Object,System.IO.Stream)">
- <summary>
- Saves Extensible Application Markup Language (XAML) information into a provided
- stream to serialize the provided object.
- </summary>
- <param name="obj">The element to be serialized. Typically, this is the root element of a page or application.</param>
- <param name="stream">Destination stream for the serialized XAML information.</param>
- </member>
- <member name="M:SharpVectors.Converters.XmlXamlWriter.Save(System.Object,System.IO.TextWriter)">
- <summary>
- Saves Extensible Application Markup Language (XAML) information as the source for a provided text writer object.
- The output of the text writer can then be used to serialize the provided object.
- </summary>
- <param name="obj">The element to be serialized. Typically, this is the root element of a page or application.</param>
- <param name="writer">TextWriter instance to use to write the serialized XAML information.</param>
- </member>
- <member name="M:SharpVectors.Converters.XmlXamlWriter.Save(System.Object,System.Xml.XmlWriter)">
- <summary>
- Saves Extensible Application Markup Language (XAML) information as the source for a provided XML writer object.
- The output of the XML writer can then be used to serialize the provided object.
- </summary>
- <param name="obj">The element to be serialized. Typically, this is the root element of a page or application.</param>
- <param name="xmlWriter">Writer to use to write the serialized XAML information.</param>
- </member>
- <member name="T:SharpVectors.Converters.XmlXamlWriter.NamespaceCache">
- <summary>
- Xml namespace caching class.
- </summary>
- </member>
- <member name="T:SharpVectors.Converters.XmlXamlWriter.NamespaceMap">
- <summary>
- A class encapsulating XML name prefix to namespace map.
- </summary>
- </member>
- </members>
- </doc>
|