Select.HtmlToPdf.xml 273 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>SelectHtmlToPdf</name>
  5. </assembly>
  6. <members>
  7. <member name="T:SelectPdf.HtmlToPdfAuthenticationOptions">
  8. <summary>
  9. Authentication options needed when the web page to be converted requires authentication.
  10. </summary>
  11. </member>
  12. <member name="P:SelectPdf.HtmlToPdfAuthenticationOptions.Username">
  13. <summary>
  14. Specifies the user name if the web page to be converted requires authentication.
  15. </summary>
  16. </member>
  17. <member name="P:SelectPdf.HtmlToPdfAuthenticationOptions.Password">
  18. <summary>
  19. Specifies the password if the web page to be converted requires authentication.
  20. </summary>
  21. </member>
  22. <member name="T:SelectPdf.BeforeCreateNextPageHandler">
  23. <summary>
  24. BeforeCreateNextPage event handler
  25. </summary>
  26. <param name="bcnpEventArgs">The BeforeCreateNextPage event handler</param>
  27. </member>
  28. <member name="T:SelectPdf.BeforeCreateNextPageEventArgs">
  29. <summary>
  30. BeforeCreateNextPage event arguments
  31. </summary>
  32. </member>
  33. <member name="P:SelectPdf.BeforeCreateNextPageEventArgs.Cancel">
  34. <summary>
  35. Set this property true to cancel automatic creation of next page.
  36. This will also end the rendering of the next page.
  37. </summary>
  38. </member>
  39. <member name="T:SelectPdf.BeforeRenderNextPageHandler">
  40. <summary>
  41. BeforeRenderNextPage event handler
  42. </summary>
  43. <param name="brnpEventArgs">The BeforeRenderNextPage event handler</param>
  44. </member>
  45. <member name="T:SelectPdf.BeforeRenderNextPageEventArgs">
  46. <summary>
  47. BeforeRenderNextPage event arguments
  48. </summary>
  49. </member>
  50. <member name="M:SelectPdf.BeforeRenderNextPageEventArgs.#ctor(System.Int32,System.Drawing.RectangleF)">
  51. <summary>
  52. Constructor
  53. </summary>
  54. <param name="pageIndex">The next page index</param>
  55. <param name="rectangle">The rectangle rendered on the next page</param>
  56. </member>
  57. <member name="P:SelectPdf.BeforeRenderNextPageEventArgs.Cancel">
  58. <summary>
  59. Set this property true to cancel rendering on next page
  60. </summary>
  61. </member>
  62. <member name="P:SelectPdf.BeforeRenderNextPageEventArgs.Rectangle">
  63. <summary>
  64. The rectangle that will be rendered on the next page
  65. </summary>
  66. </member>
  67. <member name="P:SelectPdf.BeforeRenderNextPageEventArgs.PageIndex">
  68. <summary>
  69. The index of the next page
  70. </summary>
  71. </member>
  72. <member name="T:SelectPdf.GlobalProperties">
  73. <summary>
  74. Global properties for SelectPdf SDK.
  75. </summary>
  76. </member>
  77. <member name="P:SelectPdf.GlobalProperties.HtmlEngineFullPath">
  78. <summary>
  79. Gets or sets the full path (including the file name) of the html rendering engine helper file.
  80. </summary>
  81. </member>
  82. <member name="P:SelectPdf.GlobalProperties.PdfToolsFullPath">
  83. <summary>
  84. Gets or sets the full path (including the file name) of the pdf tools engine helper file.
  85. </summary>
  86. </member>
  87. <member name="P:SelectPdf.GlobalProperties.CacheFonts">
  88. <summary>
  89. Enable or disable web fonts caching on disk.
  90. </summary>
  91. <remarks>
  92. The default value for this property is False and web fonts are cached into memory.
  93. </remarks>
  94. </member>
  95. <member name="P:SelectPdf.GlobalProperties.FontsFolder">
  96. <summary>
  97. Folder used to cache web fonts. If not specified, the system temporary folder is used.
  98. </summary>
  99. <remarks>
  100. This property is taken into account only if <see cref="P:SelectPdf.GlobalProperties.CacheFonts"/> is set to True.
  101. </remarks>
  102. </member>
  103. <member name="P:SelectPdf.GlobalProperties.LFN">
  104. <summary>
  105. Internal use only.
  106. </summary>
  107. </member>
  108. <member name="T:SelectPdf.HtmlToPdfCssMediaType">
  109. <summary>
  110. Specifies what css styles are loaded when the html is rendered
  111. </summary>
  112. </member>
  113. <member name="F:SelectPdf.HtmlToPdfCssMediaType.Screen">
  114. <summary>
  115. Default (screen) css styles are loaded
  116. </summary>
  117. </member>
  118. <member name="F:SelectPdf.HtmlToPdfCssMediaType.Print">
  119. <summary>
  120. Print css styles are loaded
  121. </summary>
  122. </member>
  123. <member name="T:SelectPdf.HtmlToPdfPageFitMode">
  124. <summary>
  125. Specifies how the html content is rendered in a pdf page.
  126. </summary>
  127. </member>
  128. <member name="F:SelectPdf.HtmlToPdfPageFitMode.NoAdjustment">
  129. <summary>
  130. The html content is rendered as it is. No size adjustments are performed, even though the destination space might be smaller than needed.
  131. </summary>
  132. </member>
  133. <member name="F:SelectPdf.HtmlToPdfPageFitMode.ShrinkOnly">
  134. <summary>
  135. The html content is shrunk if necessary to fit the available destination space. This option does not expand the content if it's smaller than the available space.
  136. </summary>
  137. </member>
  138. <member name="F:SelectPdf.HtmlToPdfPageFitMode.AutoFit">
  139. <summary>
  140. The html content is automatically adjusted to fit the entire available space. Unlike <see cref="F:SelectPdf.HtmlToPdfPageFitMode.ShrinkOnly"/>, the content can be either shrunk or stretched.
  141. </summary>
  142. </member>
  143. <member name="T:SelectPdf.HtmlToPdfProxyOptions">
  144. <summary>
  145. The proxy settings used to resolve the HTTP requests.
  146. </summary>
  147. </member>
  148. <member name="P:SelectPdf.HtmlToPdfProxyOptions.HostName">
  149. <summary>
  150. Gets or sets the host name of the proxy host.
  151. </summary>
  152. </member>
  153. <member name="P:SelectPdf.HtmlToPdfProxyOptions.Password">
  154. <summary>
  155. Gets or sets the password used for authentication.
  156. </summary>
  157. </member>
  158. <member name="P:SelectPdf.HtmlToPdfProxyOptions.PortNumber">
  159. <summary>
  160. Gets or sets the port number of the proxy host.
  161. </summary>
  162. </member>
  163. <member name="P:SelectPdf.HtmlToPdfProxyOptions.Type">
  164. <summary>
  165. Gets or sets the proxy type.
  166. </summary>
  167. </member>
  168. <member name="P:SelectPdf.HtmlToPdfProxyOptions.Username">
  169. <summary>
  170. Gets or sets the user name used for authentication.
  171. </summary>
  172. </member>
  173. <member name="T:SelectPdf.NetworkProxyType">
  174. <summary>
  175. The list of available proxy types used by the converter to resolve HTTP requests.
  176. </summary>
  177. </member>
  178. <member name="F:SelectPdf.NetworkProxyType.Socks5">
  179. <summary>
  180. Socks5
  181. </summary>
  182. </member>
  183. <member name="F:SelectPdf.NetworkProxyType.None">
  184. <summary>
  185. None
  186. </summary>
  187. </member>
  188. <member name="F:SelectPdf.NetworkProxyType.Http">
  189. <summary>
  190. Http
  191. </summary>
  192. </member>
  193. <member name="F:SelectPdf.NetworkProxyType.HttpCaching">
  194. <summary>
  195. HttpCaching
  196. </summary>
  197. </member>
  198. <member name="T:SelectPdf.HtmlToPdfResult">
  199. <summary>
  200. Offers information about the html to pdf conversion process.
  201. </summary>
  202. <remarks>
  203. After a successful conversion the <see cref="P:SelectPdf.HtmlToPdf.ConversionResult"/> property is initialized with an instance of this class.
  204. </remarks>
  205. </member>
  206. <member name="M:SelectPdf.HtmlToPdfResult.#ctor(System.Int32,System.Drawing.SizeF,System.Drawing.SizeF,System.Drawing.SizeF,System.Single,System.Int32,System.Drawing.RectangleF,System.Drawing.RectangleF[],SelectPdf.WebPageInformation)">
  207. <summary>
  208. Creates a HtmlToPdfResult object.
  209. </summary>
  210. <param name="pdfPageCount"></param>
  211. <param name="htmlContentSizePixels"></param>
  212. <param name="htmlContentSizePoints"></param>
  213. <param name="pdfPageSizePoints"></param>
  214. <param name="htmlContentWidthResizeFactor"></param>
  215. <param name="lastPageIndex"></param>
  216. <param name="lastPageRectangle"></param>
  217. <param name="renderedPagesRectangles"></param>
  218. </member>
  219. <member name="P:SelectPdf.HtmlToPdfResult.PdfPageCount">
  220. <summary>
  221. The number of pages in the generated pdf document.
  222. </summary>
  223. </member>
  224. <member name="P:SelectPdf.HtmlToPdfResult.WebPageSize">
  225. <summary>
  226. The size of the web page in pixels.
  227. </summary>
  228. <remarks>
  229. 1px is 1/96 inch at 96 DPI.
  230. </remarks>
  231. </member>
  232. <member name="P:SelectPdf.HtmlToPdfResult.PdfPageSize">
  233. <summary>
  234. The size of the page in the generated pdf document.
  235. </summary>
  236. <remarks>This size is in points. 1 point is 1/72 inch.</remarks>
  237. </member>
  238. <member name="P:SelectPdf.HtmlToPdfResult.PdfPageScaleFactor">
  239. <summary>
  240. The factor used to scale the html content to fit the pdf page.
  241. </summary>
  242. <remarks>
  243. This property offers the factor used to scale the html content when rendered into the pdf document.
  244. When <see cref="P:SelectPdf.HtmlToPdfOptions.AutoFitWidth"/> is <see cref="F:SelectPdf.HtmlToPdfPageFitMode.ShrinkOnly"/> or <see cref="F:SelectPdf.HtmlToPdfPageFitMode.AutoFit"/>,
  245. the html content might be resized to fit the pdf page width if necessary.
  246. </remarks>
  247. </member>
  248. <member name="P:SelectPdf.HtmlToPdfResult.PdfPageLastIndex">
  249. <summary>
  250. The index of the pdf page where the rendering of the html content ended in the generated pdf document.
  251. </summary>
  252. <remarks>
  253. This information is useful when other pdf elements are added after conversion using the <see cref="T:SelectPdf.PdfDocument"/> object.
  254. </remarks>
  255. </member>
  256. <member name="P:SelectPdf.HtmlToPdfResult.PdfPageLastRectangle">
  257. <summary>
  258. The size and position of the html content rendered on the last page in the generated pdf document.
  259. </summary>
  260. <remarks>
  261. This information is useful when other pdf elements are added after conversion using the <see cref="T:SelectPdf.PdfDocument"/> object.
  262. <para>
  263. Note: The last page is specified by the <see cref="P:SelectPdf.HtmlToPdfResult.PdfPageLastIndex"/> property.
  264. </para>
  265. </remarks>
  266. </member>
  267. <member name="P:SelectPdf.HtmlToPdfResult.PdfPagesRectangles">
  268. <summary>
  269. The size and position of the html content rendered in all pages of the pdf document.
  270. </summary>
  271. <remarks>
  272. This information is useful when other pdf elements are added after conversion using the <see cref="T:SelectPdf.PdfDocument"/> object.
  273. </remarks>
  274. </member>
  275. <member name="P:SelectPdf.HtmlToPdfResult.WebPageInformation">
  276. <summary>
  277. Gets an object populated after conversion with the title, keywords and description of the converted web page.
  278. </summary>
  279. <remarks>
  280. This information can be used to set the properties of the pdf document after the conversion.
  281. </remarks>
  282. </member>
  283. <member name="T:SelectPdf.ConverterUtils">
  284. <summary>
  285. HTML converter utilities
  286. </summary>
  287. </member>
  288. <member name="M:SelectPdf.ConverterUtils.GetHtmlFromURL(System.String)">
  289. <summary>
  290. Get the HTML code from the specified URL. Use the autodetermined page encoding
  291. to create the resulted string object. The default code page is UTF8 if the page
  292. has no encoding specified
  293. </summary>
  294. <param name="url">The URL from where to get the HTML</param>
  295. <returns>The page HTML string</returns>
  296. </member>
  297. <member name="M:SelectPdf.ConverterUtils.GetHtmlFromURL(System.String,System.Text.Encoding)">
  298. <summary>
  299. Get the HTML code from the specified URL. Use the specified page encoding
  300. to create the resulted string object.
  301. </summary>
  302. <param name="url">The URL from where to get the HTML</param>
  303. <param name="pageEncoding">The encoding used to build the resulted string object</param>
  304. <returns>The page HTML string</returns>
  305. </member>
  306. <member name="M:SelectPdf.ConverterUtils.GetHtmlFromURL(System.Net.HttpWebRequest,System.Text.Encoding)">
  307. <summary>
  308. </summary>
  309. <param name="request">The HttpWebRequest object to to make the HTTP request</param>
  310. <param name="pageEncoding">The encoding used to build the resulted string object</param>
  311. <returns>The page HTML string</returns>
  312. </member>
  313. <member name="T:SelectPdf.HtmlToPdfStartupMode">
  314. <summary>
  315. Specifies the converter startup mode.
  316. </summary>
  317. </member>
  318. <member name="F:SelectPdf.HtmlToPdfStartupMode.Automatic">
  319. <summary>
  320. The conversion starts right after the page loads.
  321. </summary>
  322. </member>
  323. <member name="F:SelectPdf.HtmlToPdfStartupMode.Manual">
  324. <summary>
  325. The conversion starts only when called from JavaScript.
  326. </summary>
  327. </member>
  328. <member name="T:SelectPdf.PdfCustomPageSize">
  329. <summary>
  330. The pdf page size expressed in points.
  331. </summary>
  332. <remarks>
  333. 1 point is 1/72 inch.
  334. </remarks>
  335. </member>
  336. <member name="M:SelectPdf.PdfCustomPageSize.#ctor">
  337. <summary>
  338. Default constructor constructs a A4 page size
  339. </summary>
  340. </member>
  341. <member name="M:SelectPdf.PdfCustomPageSize.#ctor(System.Single,System.Single)">
  342. <summary>
  343. Constructs a custom page size
  344. </summary>
  345. <param name="width">The page width in points</param>
  346. <param name="height">The page height in points</param>
  347. </member>
  348. <member name="F:SelectPdf.PdfCustomPageSize.Letter">
  349. <summary>
  350. Letter
  351. </summary>
  352. </member>
  353. <member name="F:SelectPdf.PdfCustomPageSize.Note">
  354. <summary>
  355. Note
  356. </summary>
  357. </member>
  358. <member name="F:SelectPdf.PdfCustomPageSize.Legal">
  359. <summary>
  360. Legal
  361. </summary>
  362. </member>
  363. <member name="F:SelectPdf.PdfCustomPageSize.A0">
  364. <summary>
  365. A0
  366. </summary>
  367. </member>
  368. <member name="F:SelectPdf.PdfCustomPageSize.A1">
  369. <summary>
  370. A1
  371. </summary>
  372. </member>
  373. <member name="F:SelectPdf.PdfCustomPageSize.A2">
  374. <summary>
  375. A2
  376. </summary>
  377. </member>
  378. <member name="F:SelectPdf.PdfCustomPageSize.A3">
  379. <summary>
  380. A3
  381. </summary>
  382. </member>
  383. <member name="F:SelectPdf.PdfCustomPageSize.A4">
  384. <summary>
  385. A4
  386. </summary>
  387. </member>
  388. <member name="F:SelectPdf.PdfCustomPageSize.A5">
  389. <summary>
  390. A5
  391. </summary>
  392. </member>
  393. <member name="F:SelectPdf.PdfCustomPageSize.A6">
  394. <summary>
  395. A6
  396. </summary>
  397. </member>
  398. <member name="F:SelectPdf.PdfCustomPageSize.A7">
  399. <summary>
  400. A7
  401. </summary>
  402. </member>
  403. <member name="F:SelectPdf.PdfCustomPageSize.A8">
  404. <summary>
  405. A8
  406. </summary>
  407. </member>
  408. <member name="F:SelectPdf.PdfCustomPageSize.A9">
  409. <summary>
  410. A9
  411. </summary>
  412. </member>
  413. <member name="F:SelectPdf.PdfCustomPageSize.A10">
  414. <summary>
  415. A10
  416. </summary>
  417. </member>
  418. <member name="F:SelectPdf.PdfCustomPageSize.B0">
  419. <summary>
  420. B0
  421. </summary>
  422. </member>
  423. <member name="F:SelectPdf.PdfCustomPageSize.B1">
  424. <summary>
  425. B1
  426. </summary>
  427. </member>
  428. <member name="F:SelectPdf.PdfCustomPageSize.B2">
  429. <summary>
  430. B2
  431. </summary>
  432. </member>
  433. <member name="F:SelectPdf.PdfCustomPageSize.B3">
  434. <summary>
  435. B3
  436. </summary>
  437. </member>
  438. <member name="F:SelectPdf.PdfCustomPageSize.B4">
  439. <summary>
  440. B4
  441. </summary>
  442. </member>
  443. <member name="F:SelectPdf.PdfCustomPageSize.B5">
  444. <summary>
  445. B5
  446. </summary>
  447. </member>
  448. <member name="F:SelectPdf.PdfCustomPageSize.ArchE">
  449. <summary>
  450. ArchE
  451. </summary>
  452. </member>
  453. <member name="F:SelectPdf.PdfCustomPageSize.ArchD">
  454. <summary>
  455. ArchD
  456. </summary>
  457. </member>
  458. <member name="F:SelectPdf.PdfCustomPageSize.ArchC">
  459. <summary>
  460. ArchC
  461. </summary>
  462. </member>
  463. <member name="F:SelectPdf.PdfCustomPageSize.ArchB">
  464. <summary>
  465. ArchB
  466. </summary>
  467. </member>
  468. <member name="F:SelectPdf.PdfCustomPageSize.ArchA">
  469. <summary>
  470. ArchA
  471. </summary>
  472. </member>
  473. <member name="F:SelectPdf.PdfCustomPageSize.Flsa">
  474. <summary>
  475. Flsa
  476. </summary>
  477. </member>
  478. <member name="F:SelectPdf.PdfCustomPageSize.HalfLetter">
  479. <summary>
  480. HalfLetter
  481. </summary>
  482. </member>
  483. <member name="F:SelectPdf.PdfCustomPageSize.Letter11x17">
  484. <summary>
  485. 11x17
  486. </summary>
  487. </member>
  488. <member name="F:SelectPdf.PdfCustomPageSize.Ledger">
  489. <summary>
  490. Ledger
  491. </summary>
  492. </member>
  493. <member name="P:SelectPdf.PdfCustomPageSize.Width">
  494. <summary>
  495. Gets or sets the page width
  496. </summary>
  497. </member>
  498. <member name="P:SelectPdf.PdfCustomPageSize.Height">
  499. <summary>
  500. Gets or sets the page height
  501. </summary>
  502. </member>
  503. <member name="T:SelectPdf.PdfDocumentSecurity">
  504. <summary>
  505. This class provides the options to control the pdf document security.
  506. </summary>
  507. </member>
  508. <member name="P:SelectPdf.PdfDocumentSecurity.CanAssembleDocument">
  509. <summary>
  510. Allows inserting, rotating or deleting pages or bookmarks.
  511. </summary>
  512. </member>
  513. <member name="P:SelectPdf.PdfDocumentSecurity.CanCopyContent">
  514. <summary>
  515. Allows copying page contents such as text and images.
  516. </summary>
  517. </member>
  518. <member name="P:SelectPdf.PdfDocumentSecurity.CanEditAnnotations">
  519. <summary>
  520. Allows document annotations editing.
  521. </summary>
  522. </member>
  523. <member name="P:SelectPdf.PdfDocumentSecurity.CanEditContent">
  524. <summary>
  525. Allows modifying document content.
  526. </summary>
  527. </member>
  528. <member name="P:SelectPdf.PdfDocumentSecurity.CanFillFormFields">
  529. <summary>
  530. Allows filling in form fields.
  531. </summary>
  532. </member>
  533. <member name="P:SelectPdf.PdfDocumentSecurity.CanPrint">
  534. <summary>
  535. Allows printing.
  536. </summary>
  537. </member>
  538. <member name="P:SelectPdf.PdfDocumentSecurity.OwnerPassword">
  539. <summary>Sets or gets the owner password.</summary>
  540. <remarks>
  541. This password is required to change permissions of the pdf document (like printing or editing).
  542. </remarks>
  543. </member>
  544. <member name="P:SelectPdf.PdfDocumentSecurity.UserPassword">
  545. <summary>Gets or sets the user password. </summary>
  546. <remarks>
  547. This password is required to open the pdf document.
  548. </remarks>
  549. </member>
  550. <member name="T:SelectPdf.PdfEncryptionKeySize">
  551. <summary>
  552. The length of the pdf encryption key.
  553. </summary>
  554. </member>
  555. <member name="F:SelectPdf.PdfEncryptionKeySize.EncryptKey256Bit">
  556. <summary>
  557. 246 bit length.
  558. </summary>
  559. </member>
  560. <member name="F:SelectPdf.PdfEncryptionKeySize.EncryptKey128Bit">
  561. <summary>
  562. 128 bit length.
  563. </summary>
  564. </member>
  565. <member name="F:SelectPdf.PdfEncryptionKeySize.EncryptKey40Bit">
  566. <summary>
  567. 40 bit length.
  568. </summary>
  569. </member>
  570. <member name="T:SelectPdf.PdfEncryptionAlgorithm">
  571. <summary>
  572. The encryption algorithm.
  573. </summary>
  574. </member>
  575. <member name="F:SelectPdf.PdfEncryptionAlgorithm.RC4">
  576. <summary>
  577. RC4
  578. </summary>
  579. </member>
  580. <member name="F:SelectPdf.PdfEncryptionAlgorithm.AES">
  581. <summary>
  582. AES
  583. </summary>
  584. </member>
  585. <member name="T:SelectPdf.PdfPageCollection">
  586. <summary>
  587. Represents the collection of pages in a pdf document.
  588. </summary>
  589. <remarks>
  590. <see cref="T:SelectPdf.PdfPageCollection"/> is a collection of <see cref="T:SelectPdf.PdfPage"/> objects.
  591. </remarks>
  592. </member>
  593. <member name="F:SelectPdf.PdfPageCollection.document">
  594. <summary>
  595. The parent PDF Document.
  596. </summary>
  597. </member>
  598. <member name="M:SelectPdf.PdfPageCollection.#ctor(SelectPdf.PdfDocument)">
  599. <summary>
  600. Creates a collection of pages for this document.
  601. </summary>
  602. <param name="document">The PDF document for which this collection is created.</param>
  603. </member>
  604. <member name="M:SelectPdf.PdfPageCollection.GetEnumerator">
  605. <summary>
  606. Gets the collection enumerator.
  607. </summary>
  608. <returns>The collection enumerator.</returns>
  609. </member>
  610. <member name="M:SelectPdf.PdfPageCollection.Add">
  611. <summary>
  612. Creates a new pdf page and adds it to the pdf document pages collection.
  613. </summary>
  614. <remarks>
  615. If there is a previous page in the pages collection, the orientation and size are inherited from that page, otherwise a first page with
  616. the default <see cref="F:SelectPdf.PdfPageSize.A4"/> size and <see cref="F:SelectPdf.PdfPageOrientation.Portrait"/> orientation is created.
  617. <para></para>
  618. The page margins are inherited from the default pdf document margins specified in <see cref="P:SelectPdf.PdfDocument.Margins"/> property.</remarks>
  619. <returns>The newly created pdf page.</returns>
  620. </member>
  621. <member name="M:SelectPdf.PdfPageCollection.Add(SelectPdf.PdfMargins)">
  622. <summary>
  623. Creates a new pdf page with the specified margins and adds it to the pdf document pages collection.
  624. </summary>
  625. <remarks>
  626. If there is a previous page in the pages collection, the orientation and size are inherited from that page, otherwise a first page with
  627. the default <see cref="F:SelectPdf.PdfPageSize.A4"/> size and <see cref="F:SelectPdf.PdfPageOrientation.Portrait"/> orientation is created.</remarks>
  628. <param name="pageMargins">The pdf page margins.</param>
  629. <returns>The newly created pdf page.</returns>
  630. </member>
  631. <member name="M:SelectPdf.PdfPageCollection.Add(SelectPdf.PdfCustomPageSize,SelectPdf.PdfMargins)">
  632. <summary>
  633. Creates a new pdf page with the specified size and margins and adds it to the pdf document pages collection.
  634. </summary>
  635. <remarks>
  636. If there is a previous page in the pages collection, the orientation is inherited from that page, otherwise a first page with
  637. the default <see cref="F:SelectPdf.PdfPageOrientation.Portrait"/> orientation is created.</remarks>
  638. <param name="pageSize">The pdf page size.</param>
  639. <param name="pageMargins">The pdf page margins.</param>
  640. <returns>The newly created pdf page.</returns>
  641. </member>
  642. <member name="M:SelectPdf.PdfPageCollection.Add(SelectPdf.PdfCustomPageSize,SelectPdf.PdfMargins,SelectPdf.PdfPageOrientation)">
  643. <summary>
  644. Creates a new pdf page with the specified size, margins and orientation and adds it to the pdf document pages collection.
  645. </summary>
  646. <param name="pageSize">The pdf page size.</param>
  647. <param name="pageMargins">The pdf page margins.</param>
  648. <param name="pageOrientation">The pdf page orientation.</param>
  649. <returns>The newly created pdf page.</returns>
  650. </member>
  651. <member name="M:SelectPdf.PdfPageCollection.Insert(System.Int32,SelectPdf.PdfCustomPageSize,SelectPdf.PdfMargins,SelectPdf.PdfPageOrientation)">
  652. <summary>
  653. Creates a new pdf page with the specified size, margins and orientation and inserts it into the pdf document pages collection
  654. at the specified index.
  655. </summary>
  656. <param name="index">The index where the new pdf page will be inserted.</param>
  657. <param name="pageSize">The pdf page size.</param>
  658. <param name="pageMargins">The pdf page margins.</param>
  659. <param name="pageOrientation">The pdf page orientation.</param>
  660. <returns>The newly created pdf page.</returns>
  661. </member>
  662. <member name="M:SelectPdf.PdfPageCollection.Add(SelectPdf.PdfPage)">
  663. <summary>
  664. Adds the specified page to the pdf document pages collection.
  665. </summary>
  666. <remarks>
  667. The specified page can belong to another pdf document.
  668. <para></para>
  669. <note type="important">The source pdf document must remain opened until the current document is saved.</note>
  670. </remarks>
  671. <param name="pdfPage">The page to be added to the collection.</param>
  672. <returns>The index of the page in collection. If the page already exists, this method returns the index of the existing page.</returns>
  673. </member>
  674. <member name="M:SelectPdf.PdfPageCollection.Add(SelectPdf.PdfPage[])">
  675. <summary>
  676. Adds the specified array of pages to the pdf document pages collection.
  677. </summary>
  678. <remarks>
  679. The specified pages can belong to another pdf document.
  680. <para></para>
  681. <note type="important">The source pdf document must remain opened until the current document is saved.</note>
  682. </remarks>
  683. <param name="pages">The pdf pages to be added to the collection.</param>
  684. </member>
  685. <member name="M:SelectPdf.PdfPageCollection.Insert(System.Int32,SelectPdf.PdfPage)">
  686. <summary>
  687. Inserts the specified page into the pdf document pages collection at the specified index.
  688. </summary>
  689. <remarks>
  690. The specified page can belong to another pdf document.
  691. <para></para>
  692. <note>The source pdf document must remain opened until the current document is saved.</note>
  693. </remarks>
  694. <param name="pageIndex">The index where the pdf page will be inserted.</param>
  695. <param name="pdfPage">The pdf page to be inserted into the collection.</param>
  696. </member>
  697. <member name="M:SelectPdf.PdfPageCollection.Contains(SelectPdf.PdfPage)">
  698. <summary>
  699. Indicates if the collection contains the specified page.
  700. </summary>
  701. <param name="pdfPage">The specified pdf page.</param>
  702. <returns>True if the collection contains the specified page.</returns>
  703. </member>
  704. <member name="M:SelectPdf.PdfPageCollection.IndexOf(SelectPdf.PdfPage)">
  705. <summary>
  706. Returns the index of specified page in collection.
  707. </summary>
  708. <param name="pdfPage">The specified pdf page.</param>
  709. <returns>The index of the specified page in collection.</returns>
  710. </member>
  711. <member name="M:SelectPdf.PdfPageCollection.Remove(SelectPdf.PdfPage)">
  712. <summary>
  713. Removes the specified page from the pdf document pages collection.
  714. </summary>
  715. <param name="pdfPage">The pdf page to be removed.</param>
  716. </member>
  717. <member name="M:SelectPdf.PdfPageCollection.RemoveAt(System.Int32)">
  718. <summary>
  719. Removes the pdf page at the specified index in pdf document pages collection.
  720. </summary>
  721. <param name="index">The zero based index of the pdf page to be removed.</param>
  722. </member>
  723. <member name="P:SelectPdf.PdfPageCollection.Document">
  724. <summary>
  725. The parent pdf document of the pages collection.
  726. </summary>
  727. </member>
  728. <member name="P:SelectPdf.PdfPageCollection.Item(System.Int32)">
  729. <summary>
  730. Gets or sets the page at the specified zero based index in the pages collection.
  731. </summary>
  732. <param name="index">The zero based page index in the pdf pages collection.</param>
  733. <returns>The pdf page at the specified index.</returns>
  734. </member>
  735. <member name="P:SelectPdf.PdfPageCollection.Count">
  736. <summary>
  737. The number of pages in the pdf pages collection.
  738. </summary>
  739. </member>
  740. <member name="T:SelectPdf.PdfPageRotation">
  741. <summary>
  742. Standard rotation angles for pdf pages.
  743. </summary>
  744. </member>
  745. <member name="F:SelectPdf.PdfPageRotation.Rotate_0">
  746. <summary>
  747. 0 degrees rotation.
  748. </summary>
  749. </member>
  750. <member name="F:SelectPdf.PdfPageRotation.Rotate_90">
  751. <summary>
  752. 90 degrees rotation.
  753. </summary>
  754. </member>
  755. <member name="F:SelectPdf.PdfPageRotation.Rotate_180">
  756. <summary>
  757. 180 degrees rotation.
  758. </summary>
  759. </member>
  760. <member name="F:SelectPdf.PdfPageRotation.Rotate_270">
  761. <summary>
  762. 270 degrees rotation.
  763. </summary>
  764. </member>
  765. <member name="T:SelectPdf.PdfStandardCJKFont">
  766. <summary>
  767. The Korean-Japanesse-Chinese (CJK) predefined fonts.
  768. </summary>
  769. </member>
  770. <member name="F:SelectPdf.PdfStandardCJKFont.HeiseiKakuGothicW5">
  771. <summary>
  772. Heisei Kaku Gothic W5 Japanese font.
  773. </summary>
  774. </member>
  775. <member name="F:SelectPdf.PdfStandardCJKFont.HeiseiMinchoW3">
  776. <summary>
  777. Heisei Mincho W3 Japanese font.
  778. </summary>
  779. </member>
  780. <member name="F:SelectPdf.PdfStandardCJKFont.HanyangSystemsGothicMedium">
  781. <summary>
  782. Hanyang Systems Gothic Medium Korean font.
  783. </summary>
  784. </member>
  785. <member name="F:SelectPdf.PdfStandardCJKFont.HanyangSystemsShinMyeongJoMedium">
  786. <summary>
  787. Hanyang Systems Shin MyeongJo Medium Korean font.
  788. </summary>
  789. </member>
  790. <member name="F:SelectPdf.PdfStandardCJKFont.MonotypeHeiMedium">
  791. <summary>
  792. Monotype Hei Medium Chinese traditional font.
  793. </summary>
  794. </member>
  795. <member name="F:SelectPdf.PdfStandardCJKFont.MonotypeSungLight">
  796. <summary>
  797. Monotype Sung Light Chinese traditional font.
  798. </summary>
  799. </member>
  800. <member name="F:SelectPdf.PdfStandardCJKFont.SinoTypeSongLight">
  801. <summary>
  802. SinoType Song Light Chinese simplified font.
  803. </summary>
  804. </member>
  805. <member name="T:SelectPdf.PdfStandardFont">
  806. <summary>
  807. Standard PDF font families.
  808. </summary>
  809. </member>
  810. <member name="F:SelectPdf.PdfStandardFont.Custom">
  811. <summary>
  812. Custom font.
  813. </summary>
  814. </member>
  815. <member name="F:SelectPdf.PdfStandardFont.Helvetica">
  816. <summary>
  817. Helvetica
  818. </summary>
  819. </member>
  820. <member name="F:SelectPdf.PdfStandardFont.HelveticaBold">
  821. <summary>
  822. Helvetica Bold
  823. </summary>
  824. </member>
  825. <member name="F:SelectPdf.PdfStandardFont.HelveticaOblique">
  826. <summary>
  827. Helvetica Oblique
  828. </summary>
  829. </member>
  830. <member name="F:SelectPdf.PdfStandardFont.HelveticaBoldOblique">
  831. <summary>
  832. Helvetica Bold Oblique
  833. </summary>
  834. </member>
  835. <member name="F:SelectPdf.PdfStandardFont.Courier">
  836. <summary>
  837. Courier
  838. </summary>
  839. </member>
  840. <member name="F:SelectPdf.PdfStandardFont.CourierBold">
  841. <summary>
  842. Courier Bold
  843. </summary>
  844. </member>
  845. <member name="F:SelectPdf.PdfStandardFont.CourierOblique">
  846. <summary>
  847. Courier Oblique
  848. </summary>
  849. </member>
  850. <member name="F:SelectPdf.PdfStandardFont.CourierBoldOblique">
  851. <summary>
  852. Courier Bold Oblique
  853. </summary>
  854. </member>
  855. <member name="F:SelectPdf.PdfStandardFont.TimesRoman">
  856. <summary>
  857. Times Roman
  858. </summary>
  859. </member>
  860. <member name="F:SelectPdf.PdfStandardFont.TimesBold">
  861. <summary>
  862. Times Bold
  863. </summary>
  864. </member>
  865. <member name="F:SelectPdf.PdfStandardFont.TimesBoldItalic">
  866. <summary>
  867. Times Bold Italic
  868. </summary>
  869. </member>
  870. <member name="F:SelectPdf.PdfStandardFont.TimesItalic">
  871. <summary>
  872. Times Italic
  873. </summary>
  874. </member>
  875. <member name="F:SelectPdf.PdfStandardFont.Symbol">
  876. <summary>
  877. Symbol
  878. </summary>
  879. </member>
  880. <member name="F:SelectPdf.PdfStandardFont.ZapfDingbats">
  881. <summary>
  882. ZapfDingbats
  883. </summary>
  884. </member>
  885. <member name="T:SelectPdf.PdfTemplate">
  886. <summary>
  887. Represents a template in a pdf document. A template contains elements that are repeated on each page of the pdf document.
  888. </summary>
  889. </member>
  890. <member name="T:SelectPdf.PdfCanvas">
  891. <summary>
  892. Base class for classes that can render pdf page elements.
  893. </summary>
  894. <remarks>
  895. <see cref="T:SelectPdf.PdfCanvas"/> is the base class for <see cref="T:SelectPdf.PdfPage"/> and <see cref="T:SelectPdf.PdfTemplate"/>.
  896. <see cref="T:SelectPdf.PdfPage"/> should be used to add elements to the pdf document only in a certain page at a certain position.
  897. <see cref="T:SelectPdf.PdfTemplate"/> should be used to add elements to the pdf document that will appear in more than one page.
  898. </remarks>
  899. </member>
  900. <member name="M:SelectPdf.PdfCanvas.Add(SelectPdf.PdfPageElement)">
  901. <summary>
  902. Adds a pdf page element to the canvas.
  903. </summary>
  904. <param name="element">The page element to be rendered</param>
  905. <returns>The result of adding the element</returns>
  906. </member>
  907. <member name="M:SelectPdf.PdfCanvas.MeasureString(System.String,SelectPdf.PdfFont)">
  908. <summary>
  909. Measures the size of the specified string when rendered with the specified font.
  910. </summary>
  911. <param name="text">String to measure.</param>
  912. <param name="font">The font used to render the string.</param>
  913. <returns>The size of the string.</returns>
  914. </member>
  915. <member name="P:SelectPdf.PdfCanvas.ClientRectangle">
  916. <summary>
  917. Gets the drawable area of the canvas. The margins, pdf document header and footer are excluded.
  918. </summary>
  919. </member>
  920. <member name="M:SelectPdf.PdfTemplate.Add(SelectPdf.PdfPageElement)">
  921. <summary>
  922. Adds a pdf element to the template.
  923. </summary>
  924. <param name="element">The page element to be added.</param>
  925. <returns>The result of element rendering.</returns>
  926. </member>
  927. <member name="P:SelectPdf.PdfTemplate.Width">
  928. <summary>
  929. Gets or sets the width for a custom template.
  930. </summary>
  931. <remarks>
  932. This property has no effect for a default document template.
  933. </remarks>
  934. </member>
  935. <member name="P:SelectPdf.PdfTemplate.Height">
  936. <summary>
  937. Gets or sets the height for a custom template.
  938. </summary>
  939. <remarks>
  940. This property has no effect for a default document template.
  941. </remarks>
  942. </member>
  943. <member name="P:SelectPdf.PdfTemplate.Bounds">
  944. <summary>
  945. Gets or sets the template bounds rectangle.
  946. </summary>
  947. <remarks>
  948. This property has no effect for a default document template.
  949. </remarks>
  950. </member>
  951. <member name="P:SelectPdf.PdfTemplate.Docking">
  952. <summary>
  953. Gets or sets the template docking style inside the pdf page.
  954. </summary>
  955. </member>
  956. <member name="P:SelectPdf.PdfTemplate.Anchoring">
  957. <summary>
  958. Gets or sets the template anchoring settings inside the pdf page.
  959. </summary>
  960. </member>
  961. <member name="P:SelectPdf.PdfTemplate.DisplayOnOddPages">
  962. <summary>
  963. Controls the visibility of the template on the odd numbered pages of the pdf document.
  964. </summary>
  965. <remarks>
  966. By default the template is displayed on both odd and even numbered pages.
  967. The <see cref="P:SelectPdf.PdfTemplate.DisplayOnFirstPage"/> property has priority over <see cref="P:SelectPdf.PdfTemplate.DisplayOnOddPages"/>.
  968. </remarks>
  969. </member>
  970. <member name="P:SelectPdf.PdfTemplate.DisplayOnEvenPages">
  971. <summary>
  972. Controls the visibility of the template on the even numbered pages of the pdf document.
  973. </summary>
  974. <remarks>
  975. By default the template is displayed on both odd and even numbered pages.
  976. </remarks>
  977. </member>
  978. <member name="P:SelectPdf.PdfTemplate.DisplayOnFirstPage">
  979. <summary>
  980. Controls the visibility of the template on the first page of the generated pdf document.
  981. </summary>
  982. <remarks>
  983. When this property is true the template will be displayed on the first page of the pdf document, otherwise it will not be visible.
  984. This property has priority over <see cref="P:SelectPdf.PdfTemplate.DisplayOnOddPages"/>. The default value is true.
  985. </remarks>
  986. </member>
  987. <member name="P:SelectPdf.PdfTemplate.FirstPageNumber">
  988. <summary>
  989. Controls the page number for the first page being rendered.
  990. </summary>
  991. </member>
  992. <member name="P:SelectPdf.PdfTemplate.TotalPagesOffset">
  993. <summary>
  994. Controls the total number of pages offset in the pdf document.
  995. </summary>
  996. </member>
  997. <member name="P:SelectPdf.PdfTemplate.Foreground">
  998. <summary>
  999. Controls whether the template is rendered in front of the page main content or not.
  1000. </summary>
  1001. <remarks>
  1002. The default value is true. Elements from the template will be displayed in front of the other elements from the page.
  1003. </remarks>
  1004. </member>
  1005. <member name="P:SelectPdf.PdfTemplate.Background">
  1006. <summary>
  1007. Controls whether the template is rendered behind the page main content or not.
  1008. </summary>
  1009. <remarks>
  1010. The default value is false. Elements from the template will not be displayed behind the other elements from the page.
  1011. </remarks>
  1012. </member>
  1013. <member name="T:SelectPdf.PdfTextHorizontalAlign">
  1014. <summary>
  1015. Specifies horizontal alignment of text.
  1016. </summary>
  1017. </member>
  1018. <member name="F:SelectPdf.PdfTextHorizontalAlign.Default">
  1019. <summary>
  1020. Default alignment.
  1021. </summary>
  1022. </member>
  1023. <member name="F:SelectPdf.PdfTextHorizontalAlign.Left">
  1024. <summary>
  1025. Align left.
  1026. </summary>
  1027. </member>
  1028. <member name="F:SelectPdf.PdfTextHorizontalAlign.Center">
  1029. <summary>
  1030. Center text.
  1031. </summary>
  1032. </member>
  1033. <member name="F:SelectPdf.PdfTextHorizontalAlign.Right">
  1034. <summary>
  1035. Align right.
  1036. </summary>
  1037. </member>
  1038. <member name="F:SelectPdf.PdfTextHorizontalAlign.Justify">
  1039. <summary>
  1040. Justify text.
  1041. </summary>
  1042. </member>
  1043. <member name="T:SelectPdf.WebPageInformation">
  1044. <summary>
  1045. This class provides information about the converted web page (title, description, keywords).
  1046. </summary>
  1047. </member>
  1048. <member name="P:SelectPdf.WebPageInformation.Title">
  1049. <summary>
  1050. The web page title.
  1051. </summary>
  1052. </member>
  1053. <member name="P:SelectPdf.WebPageInformation.Keywords">
  1054. <summary>
  1055. The web page keywords.
  1056. </summary>
  1057. </member>
  1058. <member name="P:SelectPdf.WebPageInformation.Description">
  1059. <summary>
  1060. The web page description.
  1061. </summary>
  1062. </member>
  1063. <member name="T:SelectPdf.WebElement">
  1064. <summary>
  1065. Represents the mapping of a HTML element in the PDF document as collection of PDF
  1066. rectangles. A HTML element can span on many pages in the generated PDF document
  1067. and therefore, in general, many PDF rectangles are necessary to completely describe
  1068. the mapping of a HTML element in PDF.
  1069. </summary>
  1070. </member>
  1071. <member name="P:SelectPdf.WebElement.HtmlElementId">
  1072. <summary>
  1073. The ID in HTML of the HTML element.
  1074. </summary>
  1075. </member>
  1076. <member name="P:SelectPdf.WebElement.PdfRectangles">
  1077. <summary>
  1078. The rectangles occupied by the HTML element in the generated PDF document.
  1079. A HTML element can span on many pages in the generated PDF document
  1080. and therefore, in general, many PDF rectangles are necessary to completely describe
  1081. the mapping of a HTML element in PDF.
  1082. </summary>
  1083. </member>
  1084. <member name="P:SelectPdf.WebElement.HtmlElementText">
  1085. <summary>
  1086. The text of the HTML element. If the element does not have an
  1087. associated text, this property returns null.
  1088. </summary>
  1089. </member>
  1090. <member name="P:SelectPdf.WebElement.HtmlElementOuterHtml">
  1091. <summary>
  1092. The HTML code of the HTML element.
  1093. </summary>
  1094. </member>
  1095. <member name="P:SelectPdf.WebElement.HtmlElementTagName">
  1096. <summary>
  1097. The HTML tag name of the HTML element.
  1098. </summary>
  1099. </member>
  1100. <member name="P:SelectPdf.WebElement.HtmlElementCssClassName">
  1101. <summary>
  1102. The CSS class name of the HTML element.
  1103. </summary>
  1104. </member>
  1105. <member name="T:SelectPdf.WebElementsCollection">
  1106. <summary>
  1107. Represents a collection of mappings of HTML elements in PDF.
  1108. </summary>
  1109. </member>
  1110. <member name="M:SelectPdf.WebElementsCollection.GetEnumerator">
  1111. <summary>
  1112. Gets the collection enumerator
  1113. </summary>
  1114. <returns>The collection enumerator</returns>
  1115. </member>
  1116. <member name="M:SelectPdf.WebElementsCollection.GetElementByHtmlId(System.String)">
  1117. <summary>
  1118. Gets the mapping in PDF of the HTML element with the specified HTML ID.
  1119. The search is case insensitive.
  1120. </summary>
  1121. <param name="htmlElementId">The HTML ID of the element.</param>
  1122. <returns>The mapping in PDF of the specified HTML element or null if no element
  1123. with the specified ID was found.</returns>
  1124. </member>
  1125. <member name="M:SelectPdf.WebElementsCollection.GetElementsByTagName(System.String)">
  1126. <summary>
  1127. Gets the mapping in PDF of the HTML elements with the specified HTML tag name.
  1128. The search is case insensitive.
  1129. </summary>
  1130. <param name="htmlElementTagName">The HTML tag name of the element.</param>
  1131. <returns>The mappings in PDF of the specified HTML elements or null if no element
  1132. with the specified tag name was found.</returns>
  1133. </member>
  1134. <member name="P:SelectPdf.WebElementsCollection.Item(System.Int32)">
  1135. <summary>
  1136. Gets the mapping at the specified zero based index from collection.
  1137. </summary>
  1138. <param name="index">The zero based index of the mapping.</param>
  1139. <returns>The mapping at the specified index in collection. Returns null
  1140. if the index is out of collection bounds.</returns>
  1141. </member>
  1142. <member name="P:SelectPdf.WebElementsCollection.Count">
  1143. <summary>
  1144. Gets the number of mappings in collection.
  1145. </summary>
  1146. </member>
  1147. <member name="T:SelectPdf.WebElementPdfRectangle">
  1148. <summary>
  1149. Represents the rectangle occupied by a HTML element in a page of the generated PDF document.
  1150. </summary>
  1151. </member>
  1152. <member name="P:SelectPdf.WebElementPdfRectangle.PageIndex">
  1153. <summary>
  1154. The zero based index of the PDF page containing this rectangle.
  1155. </summary>
  1156. </member>
  1157. <member name="P:SelectPdf.WebElementPdfRectangle.Rectangle">
  1158. <summary>
  1159. The rectangle position inside the PDF page drawing area. The drawing area of the PDF page
  1160. does not include the page margins, header or footer. The rectangle dimensions are expressed
  1161. in points (1 point is 1/72 inch).
  1162. </summary>
  1163. </member>
  1164. <member name="T:SelectPdf.WebElementsMappingOptions">
  1165. <summary>
  1166. Helps retrieving the positions of a list of html elements in the generated pdf document.
  1167. </summary>
  1168. </member>
  1169. <member name="P:SelectPdf.WebElementsMappingOptions.CssSelectors">
  1170. <summary>
  1171. This property is used to set an array containing the selectors of the HTML elements for which
  1172. to retrieve the position in PDF.
  1173. For example, the selector for all the image elements is "img", the selector for all the elements with the CSS class name 'myclass'
  1174. is "*.myclass" and the selector for the elements with the id 'myid' is "*#myid".
  1175. The elements mapping will be retrieved in the Result property after conversion.
  1176. </summary>
  1177. </member>
  1178. <member name="P:SelectPdf.WebElementsMappingOptions.Result">
  1179. <summary>
  1180. This property is set automatically after conversion and returns the mapping into the generated pdf document of the html elements
  1181. specified by the CssSelectors.
  1182. </summary>
  1183. </member>
  1184. <member name="T:SelectPdf.HiddenWebElements">
  1185. <summary>
  1186. Helps defining a set of html elements that will not be displayed in the generated pdf document.
  1187. </summary>
  1188. </member>
  1189. <member name="P:SelectPdf.HiddenWebElements.CssSelectors">
  1190. <summary>
  1191. This property is used to define an array containing the selectors of the html elements that will not be displayed in the final pdf document.
  1192. For example, the selector for all the image elements is "img", the selector for all the elements with the CSS class name 'myclass'
  1193. is "*.myclass" and the selector for the elements with the id 'myid' is "*#myid".
  1194. </summary>
  1195. </member>
  1196. <member name="T:SelectPdf.PdfHtmlSection">
  1197. <summary>
  1198. Represents a html element that can be added to the header or footer templates of a pdf document.
  1199. </summary>
  1200. <remarks>
  1201. The html can be specified by either an url or a html string.
  1202. </remarks>
  1203. </member>
  1204. <member name="T:SelectPdf.PdfSectionElement">
  1205. <summary>
  1206. The base class for pdf elements that can be added to header and footer of a pdf document.
  1207. </summary>
  1208. </member>
  1209. <member name="M:SelectPdf.PdfSectionElement.Render(System.Object,System.Object)">
  1210. <summary>
  1211. Render this page element using the specified canvas.
  1212. </summary>
  1213. <param name="canvas">The canvas where the current pdf element is rendered.
  1214. A canvas can be a pdf page or a template (like header, footer, etc).
  1215. </param>
  1216. <param name="param">An optional parameter.</param>
  1217. </member>
  1218. <member name="F:SelectPdf.PdfHtmlSection.DEFAULT_HTML_VIEWER_WIDTH_PX">
  1219. <summary>
  1220. The default virtual browser width in pixels
  1221. </summary>
  1222. </member>
  1223. <member name="M:SelectPdf.PdfHtmlSection.#ctor(System.String,System.String)">
  1224. <summary>
  1225. Creates a html object that can be added to the header or footer templates of a pdf document.
  1226. </summary>
  1227. <remarks>
  1228. The html element is specified in this case by a html string. The html will be converted and rendered at the (0,0) location in the pdf header or footer.
  1229. The width of the element in pdf is the available width in pdf page and the height is auto determined.
  1230. <para>
  1231. The web page is rendered in an internal browser with the default width of 1024px and height auto determined.
  1232. This can be changed using the <see cref="P:SelectPdf.PdfHtmlSection.WebPageWidth"/> and <see cref="P:SelectPdf.PdfHtmlSection.WebPageHeight"/> properties.
  1233. </para>
  1234. </remarks>
  1235. <param name="htmlString">The html string to be converted to pdf.</param>
  1236. <param name="baseUrl">This parameter allows the converter to resolve relative urls. Basically, <c>baseUrl + relative image/css url = full absolute url</c>.</param>
  1237. </member>
  1238. <member name="M:SelectPdf.PdfHtmlSection.#ctor(System.String)">
  1239. <summary>
  1240. Creates a html object that can be added to the header or footer templates of a pdf document.
  1241. </summary>
  1242. <remarks>
  1243. The html element is specified in this case by an url. The html will be converted and rendered at the (0,0) location in the pdf header or footer.
  1244. The width of the element in pdf is the available width in pdf page and the height is auto determined.
  1245. <para>
  1246. The web page is rendered in an internal browser with the default width of 1024px and height auto determined.
  1247. This can be changed using the <see cref="P:SelectPdf.PdfHtmlSection.WebPageWidth"/> and <see cref="P:SelectPdf.PdfHtmlSection.WebPageHeight"/> properties.
  1248. </para>
  1249. </remarks>
  1250. <param name="url">The full url of the web page to be converted to pdf. The url can be also the full path of a html file from the local file system.</param>
  1251. </member>
  1252. <member name="M:SelectPdf.PdfHtmlSection.#ctor(System.Single,System.Single,System.String,System.String)">
  1253. <summary>
  1254. Creates a html object that can be added to the header or footer templates of a pdf document.
  1255. </summary>
  1256. <remarks>
  1257. The html element is specified in this case by a html string. The html will be converted and rendered at the (x,y) location in the pdf header or footer.
  1258. The width of the element in pdf is the available width in pdf page and the height is auto determined.
  1259. <para>
  1260. The web page is rendered in an internal browser with the default width of 1024px and height auto determined.
  1261. This can be changed using the <see cref="P:SelectPdf.PdfHtmlSection.WebPageWidth"/> and <see cref="P:SelectPdf.PdfHtmlSection.WebPageHeight"/> properties.
  1262. </para>
  1263. </remarks>
  1264. <param name="x">The position in points on the X axis where the element will be rendered.</param>
  1265. <param name="y">The position in points on the Y axis where the element will be rendered.</param>
  1266. <param name="htmlString">The html string to be converted to pdf.</param>
  1267. <param name="baseUrl">This parameter allows the converter to resolve relative urls. Basically, <c>baseUrl + relative image/css url = full absolute url</c>.</param>
  1268. </member>
  1269. <member name="M:SelectPdf.PdfHtmlSection.#ctor(System.Single,System.Single,System.String)">
  1270. <summary>
  1271. Creates a html object that can be added to the header or footer templates of a pdf document.
  1272. </summary>
  1273. <remarks>
  1274. The html element is specified in this case by an url. The html will be converted and rendered at the (x,y) location in the pdf header or footer.
  1275. The width of the element in pdf is the available width in pdf page and the height is auto determined.
  1276. <para>
  1277. The web page is rendered in an internal browser with the default width of 1024px and height auto determined.
  1278. This can be changed using the <see cref="P:SelectPdf.PdfHtmlSection.WebPageWidth"/> and <see cref="P:SelectPdf.PdfHtmlSection.WebPageHeight"/> properties.
  1279. </para>
  1280. </remarks>
  1281. <param name="x">The position in points on the X axis where the element will be rendered.</param>
  1282. <param name="y">The position in points on the Y axis where the element will be rendered.</param>
  1283. <param name="url">The full url of the web page to be converted to pdf. The url can be also the full path of a html file from the local file system.</param>
  1284. </member>
  1285. <member name="M:SelectPdf.PdfHtmlSection.#ctor(System.Single,System.Single,System.Single,System.String,System.String)">
  1286. <summary>
  1287. Creates a html object that can be added to the header or footer templates of a pdf document.
  1288. </summary>
  1289. <remarks>
  1290. The html element is specified in this case by a html string. The html will be converted and rendered at the (x,y) location in the pdf header or footer.
  1291. The width of the element in pdf is specified as parameter and the height is auto determined.
  1292. <para>
  1293. The web page is rendered in an internal browser with the default width of 1024px and height auto determined.
  1294. This can be changed using the <see cref="P:SelectPdf.PdfHtmlSection.WebPageWidth"/> and <see cref="P:SelectPdf.PdfHtmlSection.WebPageHeight"/> properties.
  1295. </para>
  1296. </remarks>
  1297. <param name="x">The position in points on the X axis where the element will be rendered.</param>
  1298. <param name="y">The position in points on the Y axis where the element will be rendered.</param>
  1299. <param name="width">The destination width in points for the rendered content.</param>
  1300. <param name="htmlString">The html string to be converted to pdf.</param>
  1301. <param name="baseUrl">This parameter allows the converter to resolve relative urls. Basically, <c>baseUrl + relative image/css url = full absolute url</c>.</param>
  1302. </member>
  1303. <member name="M:SelectPdf.PdfHtmlSection.#ctor(System.Single,System.Single,System.Single,System.String)">
  1304. <summary>
  1305. Creates a html object that can be added to the header or footer templates of a pdf document.
  1306. </summary>
  1307. <remarks>
  1308. The html element is specified in this case by an url. The html will be converted and rendered at the (x,y) location in the pdf header or footer.
  1309. The width of the element in pdf is specified as parameter and the height is auto determined.
  1310. <para>
  1311. The web page is rendered in an internal browser with the default width of 1024px and height auto determined.
  1312. This can be changed using the <see cref="P:SelectPdf.PdfHtmlSection.WebPageWidth"/> and <see cref="P:SelectPdf.PdfHtmlSection.WebPageHeight"/> properties.
  1313. </para>
  1314. </remarks>
  1315. <param name="x">The position in points on the X axis where the element will be rendered.</param>
  1316. <param name="y">The position in points on the Y axis where the element will be rendered.</param>
  1317. <param name="width">The destination width in points for the rendered content.</param>
  1318. <param name="url">The full url of the web page to be converted to pdf. The url can be also the full path of a html file from the local file system.</param>
  1319. </member>
  1320. <member name="M:SelectPdf.PdfHtmlSection.#ctor(System.Single,System.Single,System.Single,System.String,System.String,System.Int32)">
  1321. <summary>
  1322. Creates a html object that can be added to the header or footer templates of a pdf document.
  1323. </summary>
  1324. <remarks>
  1325. The html element is specified in this case by a html string. The html will be converted and rendered at the (x,y) location in the pdf header or footer.
  1326. The width of the element in pdf is specified as parameter and the height is auto determined.
  1327. <para>
  1328. The web page is rendered in an internal browser with the specified width and with height auto determined.
  1329. This can be changed using the <see cref="P:SelectPdf.PdfHtmlSection.WebPageWidth"/> and <see cref="P:SelectPdf.PdfHtmlSection.WebPageHeight"/> properties.
  1330. </para>
  1331. </remarks>
  1332. <param name="x">The position in points on the X axis where the element will be rendered.</param>
  1333. <param name="y">The position in points on the Y axis where the element will be rendered.</param>
  1334. <param name="width">The destination width in points for the rendered content.</param>
  1335. <param name="htmlString">The html string to be converted to pdf.</param>
  1336. <param name="baseUrl">This parameter allows the converter to resolve relative urls. Basically, <c>baseUrl + relative image/css url = full absolute url</c>.</param>
  1337. <param name="webPageWidth">The virtual browser width in pixels. The default value is 1024 pixels. The effect of this parameter
  1338. is similar with viewing the web page in a browser window with the specified width. When this parameter is less than or equal to 0, the
  1339. converter will try to auto-determine the web page width from the html body element width.</param>
  1340. </member>
  1341. <member name="M:SelectPdf.PdfHtmlSection.#ctor(System.Single,System.Single,System.Single,System.String,System.Int32)">
  1342. <summary>
  1343. Creates a html object that can be added to the header or footer templates of a pdf document.
  1344. </summary>
  1345. <remarks>
  1346. The html element is specified in this case by an url. The html will be converted and rendered at the (x,y) location in the pdf header or footer.
  1347. The width of the element in pdf is specified as parameter and the height is auto determined.
  1348. <para>
  1349. The web page is rendered in an internal browser with the specified width and with height auto determined.
  1350. This can be changed using the <see cref="P:SelectPdf.PdfHtmlSection.WebPageWidth"/> and <see cref="P:SelectPdf.PdfHtmlSection.WebPageHeight"/> properties.
  1351. </para>
  1352. </remarks>
  1353. <param name="x">The position in points on the X axis where the element will be rendered.</param>
  1354. <param name="y">The position in points on the Y axis where the element will be rendered.</param>
  1355. <param name="width">The destination width in points for the rendered content.</param>
  1356. <param name="url">The full url of the web page to be converted to pdf. The url can be also the full path of a html file from the local file system.</param>
  1357. <param name="webPageWidth">The virtual browser width in pixels. The default value is 1024 pixels. The effect of this parameter
  1358. is similar with viewing the web page in a browser window with the specified width. When this parameter is less than or equal to 0, the
  1359. converter will try to auto-determine the web page width from the html body element width.</param>
  1360. </member>
  1361. <member name="M:SelectPdf.PdfHtmlSection.#ctor(System.Single,System.Single,System.Single,System.String,System.String,System.Int32,System.Int32)">
  1362. <summary>
  1363. Creates a html object that can be added to the header or footer templates of a pdf document.
  1364. </summary>
  1365. <remarks>
  1366. The html element is specified in this case by a html string. The html will be converted and rendered at the (x,y) location in the pdf header or footer.
  1367. The width of the element in pdf is specified as parameter and the height is auto determined.
  1368. <para>
  1369. The web page is rendered in an internal browser with the specified width and height.
  1370. </para>
  1371. </remarks>
  1372. <param name="x">The position in points on the X axis where the element will be rendered.</param>
  1373. <param name="y">The position in points on the Y axis where the element will be rendered.</param>
  1374. <param name="width">The destination width in points for the rendered content.</param>
  1375. <param name="htmlString">The html string to be converted to pdf.</param>
  1376. <param name="baseUrl">This parameter allows the converter to resolve relative urls. Basically, <c>baseUrl + relative image/css url = full absolute url</c>.</param>
  1377. <param name="webPageWidth">The virtual browser width in pixels. The default value is 1024 pixels. The effect of this parameter
  1378. is similar with viewing the web page in a browser window with the specified width. When this parameter is less than or equal to 0, the
  1379. converter will try to auto-determine the web page width from the html body element width.</param>
  1380. <param name="webPageHeight">The virtual browser height in pixels. The default value is 0 which means the height will
  1381. be auto-determined. The effect of this parameter is similar with viewing the web page in a browser window
  1382. with the specified height.</param>
  1383. </member>
  1384. <member name="M:SelectPdf.PdfHtmlSection.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.String,System.Int32,System.Int32)">
  1385. <summary>
  1386. Creates a html object that can be added to the header or footer templates of a pdf document.
  1387. </summary>
  1388. <remarks>
  1389. The html element is specified in this case by a html string. The html will be converted and rendered at the (x,y) location in the pdf header or footer.
  1390. The width and height of the element in pdf are also specified as parameters.
  1391. <para>
  1392. The web page is rendered in an internal browser with the specified width and height.
  1393. </para>
  1394. </remarks>
  1395. <param name="x">The position in points on the X axis where the element will be rendered.</param>
  1396. <param name="y">The position in points on the Y axis where the element will be rendered.</param>
  1397. <param name="width">The destination width in points for the rendered content.</param>
  1398. <param name="height">The destination height in points for the rendered content.</param>
  1399. <param name="htmlString">The html string to be converted to pdf.</param>
  1400. <param name="baseUrl">This parameter allows the converter to resolve relative urls. Basically, <c>baseUrl + relative image/css url = full absolute url</c>.</param>
  1401. <param name="webPageWidth">The virtual browser width in pixels. The default value is 1024 pixels. The effect of this parameter
  1402. is similar with viewing the web page in a browser window with the specified width. When this parameter is less than or equal to 0, the
  1403. converter will try to auto-determine the web page width from the html body element width.</param>
  1404. <param name="webPageHeight">The virtual browser height in pixels. The default value is 0 which means the height will
  1405. be auto-determined. The effect of this parameter is similar with viewing the web page in a browser window
  1406. with the specified height.</param>
  1407. </member>
  1408. <member name="M:SelectPdf.PdfHtmlSection.#ctor(System.Single,System.Single,System.Single,System.String,System.Int32,System.Int32)">
  1409. <summary>
  1410. Creates a html object that can be added to the header or footer templates of a pdf document.
  1411. </summary>
  1412. <remarks>
  1413. The html element is specified in this case by an url. The html will be converted and rendered at the (x,y) location in the pdf header or footer.
  1414. The width of the element in pdf is specified as parameter and the height is auto determined.
  1415. <para>
  1416. The web page is rendered in an internal browser with the specified width and height.
  1417. </para>
  1418. </remarks>
  1419. <param name="x">The position in points on the X axis where the element will be rendered.</param>
  1420. <param name="y">The position in points on the Y axis where the element will be rendered.</param>
  1421. <param name="width">The destination width in points for the rendered content.</param>
  1422. <param name="url">The full url of the web page to be converted to pdf. The url can be also the full path of a html file from the local file system.</param>
  1423. <param name="webPageWidth">The virtual browser width in pixels. The default value is 1024 pixels. The effect of this parameter
  1424. is similar with viewing the web page in a browser window with the specified width. When this parameter is less than or equal to 0, the
  1425. converter will try to auto-determine the web page width from the html body element width.</param>
  1426. <param name="webPageHeight">The virtual browser height in pixels. The default value is 0 which means the height will
  1427. be auto-determined. The effect of this parameter is similar with viewing the web page in a browser window
  1428. with the specified height.</param>
  1429. </member>
  1430. <member name="M:SelectPdf.PdfHtmlSection.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Int32,System.Int32)">
  1431. <summary>
  1432. Creates a html object that can be added to the header or footer templates of a pdf document.
  1433. </summary>
  1434. <remarks>
  1435. The html element is specified in this case by an url. The html will be converted and rendered at the (x,y) location in the pdf header or footer.
  1436. The width and height of the element in pdf are also specified as parameters.
  1437. <para>
  1438. The web page is rendered in an internal browser with the specified width and height.
  1439. </para>
  1440. </remarks>
  1441. <param name="x">The position in points on the X axis where the element will be rendered.</param>
  1442. <param name="y">The position in points on the Y axis where the element will be rendered.</param>
  1443. <param name="width">The destination width in points for the rendered content.</param>
  1444. <param name="height">The destination height in points for the rendered content.</param>
  1445. <param name="url">The full url of the web page to be converted to pdf. The url can be also the full path of a html file from the local file system.</param>
  1446. <param name="webPageWidth">The virtual browser width in pixels. The default value is 1024 pixels. The effect of this parameter
  1447. is similar with viewing the web page in a browser window with the specified width. When this parameter is less than or equal to 0, the
  1448. converter will try to auto-determine the web page width from the html body element width.</param>
  1449. <param name="webPageHeight">The virtual browser height in pixels. The default value is 0 which means the height will
  1450. be auto-determined. The effect of this parameter is similar with viewing the web page in a browser window
  1451. with the specified height.</param>
  1452. </member>
  1453. <member name="P:SelectPdf.PdfHtmlSection.WebPageWidth">
  1454. <summary>Gets or sets the width of the converted web page as it would appear in the internal browser used to render the html.</summary>
  1455. <remarks>The web page width is specified in pixels and the default value is 1024px.
  1456. The page width is only an indication of the minimum page width recommended for conversion. If the content does not fit this width,
  1457. the converter will automatically resize the internal browser to fit the whole html content. To avoid this, the <see cref="P:SelectPdf.PdfHtmlSection.WebPageFixedSize"/> property needs to be set to true.
  1458. When <see cref="P:SelectPdf.PdfHtmlSection.WebPageFixedSize"/> is true, the web page will be rendered with the specified <see cref="P:SelectPdf.PdfHtmlSection.WebPageWidth"/> and <see cref="P:SelectPdf.PdfHtmlSection.WebPageHeight"/> even though the content might be truncated.
  1459. <para></para>
  1460. <para></para>
  1461. If <see cref="P:SelectPdf.PdfHtmlSection.WebPageWidth"/> is set to 0, the converter will automatically determine the page width, finding the width that will fit the html content.
  1462. <para>This property can also be set directly in the constructor of <see cref="T:SelectPdf.PdfHtmlSection"/> class.</para>
  1463. </remarks>
  1464. </member>
  1465. <member name="P:SelectPdf.PdfHtmlSection.WebPageHeight">
  1466. <summary>Gets or sets the height of the converted web page as it would appear in the internal browser used to render the html.</summary>
  1467. <remarks>
  1468. The web page height is specified in pixels and the default value is 0px. This means that the converter will automatically calculate the page height.
  1469. <para>Generally this property does not need to be changed, but there are situations when the converter cannot calculate correctly the web page height (for example for web pages with frames) and
  1470. in that case, <see cref="P:SelectPdf.PdfHtmlSection.WebPageHeight"/> needs to be set, otherwise no content might appear in the generated pdf.
  1471. </para>
  1472. <para>
  1473. Note: If the <see cref="P:SelectPdf.PdfHtmlSection.WebPageHeight"/> is set, the content that exceeds this page height is truncated and will not appear in the generated pdf document.
  1474. Only using the default 0 value will allow the whole page content to be rendered all the time in the generated pdf document.
  1475. </para>
  1476. <para>This property can also be set directly in the constructor of <see cref="T:SelectPdf.PdfHtmlSection"/> class.</para>
  1477. </remarks>
  1478. </member>
  1479. <member name="P:SelectPdf.PdfHtmlSection.WebPageFixedSize">
  1480. <summary>Controls whether the web page is rendered with a fixed size internal browser or the size automatically extends to make the whole content visible.</summary>
  1481. <remarks>
  1482. The default value of this property is false.
  1483. <para></para>
  1484. <para></para>
  1485. If the web page does not fit the dimensions specified by the <see cref="P:SelectPdf.PdfHtmlSection.WebPageWidth"/> and <see cref="P:SelectPdf.PdfHtmlSection.WebPageHeight"/> properties and <see cref="P:SelectPdf.PdfHtmlSection.WebPageFixedSize"/>
  1486. is set to false, the converter will try to automatically calculate a larger width and height to be able to display the whole html content.
  1487. <para>
  1488. If <see cref="P:SelectPdf.PdfHtmlSection.WebPageFixedSize"/> is set to true, this will indicate the converter not to calculate another width and height, but use width and height specified by <see cref="P:SelectPdf.PdfHtmlSection.WebPageWidth"/> and <see cref="P:SelectPdf.PdfHtmlSection.WebPageHeight"/>.
  1489. These dimensions with be used even though the content will not fit the available space and it will be truncated.
  1490. </para>
  1491. <para>
  1492. Note: If <see cref="P:SelectPdf.PdfHtmlSection.WebPageFixedSize"/> is set to true, a page height needs to be set using <see cref="P:SelectPdf.PdfHtmlSection.WebPageHeight"/>, because the default value (0) will make the converter fail (cannot render a web page with no height).
  1493. </para>
  1494. </remarks>
  1495. </member>
  1496. <member name="P:SelectPdf.PdfHtmlSection.VisibleWebElementId">
  1497. <summary>
  1498. Use this property to convert only a certain section of the page, specified by the html element ID.
  1499. </summary>
  1500. </member>
  1501. <member name="P:SelectPdf.PdfHtmlSection.StartupMode">
  1502. <summary>
  1503. Use this property to specify how the conversion starts.
  1504. </summary>
  1505. <remarks>
  1506. By default this is set to <see cref="F:SelectPdf.HtmlToPdfStartupMode.Automatic"/> and the conversion is started as soon as the page loads (and <see cref="P:SelectPdf.PdfHtmlSection.MinPageLoadTime"/> elapses).
  1507. If set to <see cref="F:SelectPdf.HtmlToPdfStartupMode.Manual"/>, the conversion is started only by a javascript call to <c>SelectPdf.startConversion()</c> from within the web page.
  1508. </remarks>
  1509. </member>
  1510. <member name="P:SelectPdf.PdfHtmlSection.StartupScript">
  1511. <summary>
  1512. Use this property to specify some JavaScript code that will be injected into the page that is converted.
  1513. </summary>
  1514. <remarks>The JavaScript code specified here will run before any other script on the page.</remarks>
  1515. </member>
  1516. <member name="P:SelectPdf.PdfHtmlSection.KeepTextsTogether">
  1517. <summary>
  1518. This property instructs the converter whether to try to avoid cutting off the text lines between pdf pages or not.
  1519. </summary>
  1520. <remarks>The default value is true and the converter tries to avoid text cutting between pdf pages.</remarks>
  1521. </member>
  1522. <member name="P:SelectPdf.PdfHtmlSection.KeepImagesTogether">
  1523. <summary>
  1524. This property instructs the converter whether to try to avoid cutting off the images between pdf pages or not.
  1525. </summary>
  1526. <remarks>The default value is false and the converter does not try to avoid images cutting between pdf pages.</remarks>
  1527. </member>
  1528. <member name="P:SelectPdf.PdfHtmlSection.AutoFitWidth">
  1529. <summary>Specifies the horizontal auto fit mode.</summary>
  1530. <remarks>
  1531. The converter considers both <see cref="P:SelectPdf.PdfHtmlSection.AutoFitWidth"/> and <see cref="P:SelectPdf.PdfHtmlSection.AutoFitHeight"/> when the html content is rendered in the pdf page or specified rectangle.
  1532. <para></para>
  1533. <para></para>
  1534. If this property is set to <see cref="F:SelectPdf.HtmlToPdfPageFitMode.NoAdjustment"/>, the html content is not resized horizontally in any way to fit the available space. If the content is larger,
  1535. it will be cut and not all of it will be displayed in the generated pdf file.
  1536. <para></para>
  1537. If this property is set to <see cref="F:SelectPdf.HtmlToPdfPageFitMode.ShrinkOnly"/>, the html content is resized only if the content width is larger than the destination space
  1538. (pdf page or rectangle) width.
  1539. In this case, the content is shrunk to fit the destination space width and the elements that it contains (texts, images) will appear smaller in the generated
  1540. pdf document than in the original web page.
  1541. If the original content width is smaller than the destination width, no adjustments will be done and the content will be rendered exactly as it is,
  1542. even though some additional white space might appear to its right.
  1543. <para></para>
  1544. If this property is set to <see cref="F:SelectPdf.HtmlToPdfPageFitMode.AutoFit"/>, the html content is resized to fit the available width of the destination space.
  1545. If the original content width is smaller than the destination width,
  1546. the elements rendered (texts, images) will appear larger in the generated pdf document. If the original content width is larger than the destination width,
  1547. the elements rendered (texts, images) will appear smaller in the generated pdf document.
  1548. <para>The default value of this property is <see cref="F:SelectPdf.HtmlToPdfPageFitMode.ShrinkOnly"/>.</para>
  1549. </remarks>
  1550. </member>
  1551. <member name="P:SelectPdf.PdfHtmlSection.AutoFitHeight">
  1552. <summary>Specifies the vertical auto fit mode.</summary>
  1553. <remarks>
  1554. The converter considers both <see cref="P:SelectPdf.PdfHtmlSection.AutoFitWidth"/> and <see cref="P:SelectPdf.PdfHtmlSection.AutoFitHeight"/> when the html content is rendered in the pdf page or specified rectangle.
  1555. <para></para>
  1556. <para></para>
  1557. If this property is set to <see cref="F:SelectPdf.HtmlToPdfPageFitMode.NoAdjustment"/>, the html content is not resized vertically in any way to fit the available space. If the content is larger,
  1558. it will be cut and not all of it will be displayed in the generated pdf file.
  1559. <para></para>
  1560. If this property is set to <see cref="F:SelectPdf.HtmlToPdfPageFitMode.ShrinkOnly"/>, the html content is resized only if the content height is larger than the destination space
  1561. (pdf page or rectangle) height.
  1562. In this case, the content is shrunk to fit the destination space height and the elements that it contains (texts, images) will appear smaller in the generated
  1563. pdf document than in the original web page.
  1564. If the original content height is smaller than the destination height, no adjustments will be done and the content will be rendered exactly as it is,
  1565. even though some additional white space might appear at the bottom.
  1566. <para></para>
  1567. If this property is set to <see cref="F:SelectPdf.HtmlToPdfPageFitMode.AutoFit"/>, the converter will treat it like <see cref="F:SelectPdf.HtmlToPdfPageFitMode.ShrinkOnly"/>.
  1568. <para>The default value of this property is <see cref="F:SelectPdf.HtmlToPdfPageFitMode.NoAdjustment"/> and for rendering, the converter will only take <see cref="P:SelectPdf.PdfHtmlSection.AutoFitWidth"/> into consideration.</para>
  1569. </remarks>
  1570. </member>
  1571. <member name="P:SelectPdf.PdfHtmlSection.DrawBackground">
  1572. <summary>
  1573. Gets or sets a flag indicating if the web page background is rendered in pdf.
  1574. </summary>
  1575. <remarks>
  1576. The default value for this property is true and the page background is rendered into the generated pdf.
  1577. Even though it might be white, it will still make invisible any pdf element that was rendered behind it.
  1578. Setting this property to false can make visible the existing pdf elements behind this html element.
  1579. </remarks>
  1580. </member>
  1581. <member name="P:SelectPdf.PdfHtmlSection.JavaScriptEnabled">
  1582. <summary>
  1583. Enable scripts when rendering the url or html string.
  1584. </summary>
  1585. <remarks>The default value of this property is true and the converter will run any javascript available when the page loads.
  1586. <para></para>
  1587. <para>Note: If the javascript requires some time to load, <see cref="P:SelectPdf.PdfHtmlSection.MinPageLoadTime"/> property should be set to delay the conversion
  1588. with the specified number of seconds and allow the javascript to run.</para>
  1589. </remarks>
  1590. </member>
  1591. <member name="P:SelectPdf.PdfHtmlSection.PluginsEnabled">
  1592. <summary>
  1593. A flag indicating if plugins (like Flash players) are enabled in the converter.
  1594. </summary>
  1595. <remarks>
  1596. The default value for this property is true.
  1597. </remarks>
  1598. </member>
  1599. <member name="P:SelectPdf.PdfHtmlSection.CssMediaType">
  1600. <summary>
  1601. Indicates what css styles are used when the web page is rendered.
  1602. </summary>
  1603. <remarks>The default value is <see cref="F:SelectPdf.HtmlToPdfCssMediaType.Screen"/> and the page is rendered like in a regular web browser.
  1604. If the page contains printer specific styles, the property should be set to <see cref="F:SelectPdf.HtmlToPdfCssMediaType.Print"/> to have the page rendered using those css styles.</remarks>
  1605. </member>
  1606. <member name="P:SelectPdf.PdfHtmlSection.EmbedFonts">
  1607. <summary>
  1608. Instructs the converter to embed all the needed fonts into the pdf document or not.
  1609. </summary>
  1610. <remarks>
  1611. The default value for this property is false and the fonts are not automatically embedded.
  1612. <para>
  1613. This property does not control the web fonts (fonts that are downloaded with the web page). The web fonts are always embedded because they are not installed on the machine.
  1614. </para>
  1615. </remarks>
  1616. </member>
  1617. <member name="P:SelectPdf.PdfHtmlSection.MinPageLoadTime">
  1618. <summary>
  1619. An additional time in seconds to wait for asynchronous items to be loaded before the web page is rendered.
  1620. </summary>
  1621. <remarks>
  1622. A delay of this type could be necessary if javascripts are loaded when the page is rendered or if Flash movies are played.
  1623. </remarks>
  1624. </member>
  1625. <member name="P:SelectPdf.PdfHtmlSection.MaxPageLoadTime">
  1626. <summary>
  1627. The web page navigation timeout in seconds.
  1628. </summary>
  1629. <remarks>Default value is 60 seconds. This value should be increased if large web pages are loaded.</remarks>
  1630. </member>
  1631. <member name="P:SelectPdf.PdfHtmlSection.HttpCookies">
  1632. <summary>
  1633. Gets the collection of custom HTTP cookies used for the conversion.
  1634. </summary>
  1635. <remarks>
  1636. This property returns a reference to the collection of custom HTTP cookies to be sent by the converter to the web server when the web page is rendered.
  1637. A cookie is defined by a name/value pair that can be added to the collection using the <see cref="M:System.Collections.Specialized.NameValueCollection.Add(System.String,System.String)"/> method of the <see cref="P:SelectPdf.PdfHtmlSection.HttpCookies"/> property.
  1638. </remarks>
  1639. </member>
  1640. <member name="P:SelectPdf.PdfHtmlSection.HttpHeaders">
  1641. <summary>
  1642. Get the collection of custom HTTP headers used for the conversion.
  1643. </summary>
  1644. <remarks>
  1645. This property returns a reference to the collection of custom HTTP headers to be sent by the converter to the web server when the web page is rendered.
  1646. A custom HTTP header is defined by a name/value pair
  1647. that can be added to the collection using the <see cref="M:System.Collections.Specialized.NameValueCollection.Add(System.String,System.String)"/> method of the <see cref="P:SelectPdf.PdfHtmlSection.HttpHeaders"/> property.
  1648. </remarks>
  1649. </member>
  1650. <member name="P:SelectPdf.PdfHtmlSection.HttpPostParameters">
  1651. <summary>
  1652. Gets the collection of custom HTTP POST parameters used for the conversion.
  1653. </summary>
  1654. <remarks>
  1655. This property returns a reference to the collection of custom HTTP POST parameters that will be sent by the converter to the web server when the web page is rendered.
  1656. A POST parameter is defined by a name/value pair that can be added to the collection using the <see cref="M:System.Collections.Specialized.NameValueCollection.Add(System.String,System.String)"/> method of the <see cref="P:SelectPdf.PdfHtmlSection.HttpPostParameters"/> property.
  1657. When this collection has at least one parameter, the rendered page is a accessed via POST method. Otherwise the method is GET.
  1658. </remarks>
  1659. </member>
  1660. <member name="P:SelectPdf.PdfHtmlSection.ProxyOptions">
  1661. <summary>
  1662. Gets a reference to an object containing the proxy settings used to access the web page that is being converted.
  1663. </summary>
  1664. </member>
  1665. <member name="P:SelectPdf.PdfHtmlSection.ExternalLinksEnabled">
  1666. <summary>
  1667. Controls the rendering of external hyperlinks in pdf.
  1668. </summary>
  1669. <remarks>
  1670. The default value for this property is true and in this case all external hyperlinks from the web page will be rendered in the generated pdf document.
  1671. <para>When this property is set to false, external links are ignore and they do not appear in the generated pdf document.</para>
  1672. </remarks>
  1673. </member>
  1674. <member name="P:SelectPdf.PdfHtmlSection.InternalLinksEnabled">
  1675. <summary>
  1676. Controls the conversion of internal html links to internal pdf links.
  1677. </summary>
  1678. <remarks>
  1679. The default value for this property is true and in this case all internal hyperlinks from the web page (links that point within the web page) will be rendered in the
  1680. generated pdf document as internal pdf links (clicking one of them will jump within the pdf document).
  1681. </remarks>
  1682. </member>
  1683. <member name="P:SelectPdf.PdfHtmlSection.Authentication">
  1684. <summary>
  1685. Handles authentication options if the web page being converted requires authentication.
  1686. </summary>
  1687. </member>
  1688. <member name="P:SelectPdf.PdfHtmlSection.RenderPageOnTimeout">
  1689. <summary>
  1690. A flag indicating if the page is rendered even if a navigation timeout occurs. The default value is False and a navigation timeout exception is raised.
  1691. </summary>
  1692. </member>
  1693. <member name="P:SelectPdf.PdfHtmlSection.ScaleImages">
  1694. <summary>
  1695. A flag indicating if the images from the page are scaled during the conversion process. The default value is False and images are not scaled.
  1696. </summary>
  1697. </member>
  1698. <member name="P:SelectPdf.PdfHtmlSection.DisplayCutText">
  1699. <summary>
  1700. Gets or sets a flag indicating if the text that is out of the calculated rendering rectangle is displayed or not.
  1701. </summary>
  1702. <remarks>The default value for this property is False.</remarks>
  1703. </member>
  1704. <member name="T:SelectPdf.PdfImageSection">
  1705. <summary>
  1706. Represents an image that can be added to the header or footer templates of a pdf document.
  1707. </summary>
  1708. </member>
  1709. <member name="M:SelectPdf.PdfImageSection.#ctor(System.Single,System.Single,System.Single,System.String)">
  1710. <summary>
  1711. Creates an image object that can be added to the header or footer templates of a pdf document.
  1712. </summary>
  1713. <remarks>
  1714. The image object is created from the specified file that will be rendered at the position (x,y) in the pdf header or footer
  1715. with the specified destination width and the height auto determined to keep the initial aspect ratio.
  1716. </remarks>
  1717. <param name="x">The X position where this element will be rendered.</param>
  1718. <param name="y">The Y position where this element will be rendered.</param>
  1719. <param name="width">The destination rectangle width.</param>
  1720. <param name="fileName">The image file path.</param>
  1721. </member>
  1722. <member name="M:SelectPdf.PdfImageSection.#ctor(System.Single,System.Single,System.Single,System.Single,System.String)">
  1723. <summary>
  1724. Creates an image object that can be added to the header or footer templates of a pdf document.
  1725. </summary>
  1726. <remarks>
  1727. The image object is created from the specified file that will be rendered at the position (x,y) in the pdf header or footer
  1728. with the specified destination width and height size.
  1729. </remarks>
  1730. <param name="x">The X position where this element will be rendered.</param>
  1731. <param name="y">The Y position where this element will be rendered.</param>
  1732. <param name="width">The destination rectangle width.</param>
  1733. <param name="height">The destination rectangle height.</param>
  1734. <param name="fileName">The image file path.</param>
  1735. </member>
  1736. <member name="M:SelectPdf.PdfImageSection.#ctor(System.Single,System.Single,System.Single,System.Drawing.Image)">
  1737. <summary>
  1738. Creates an image object that can be added to the header or footer templates of a pdf document.
  1739. </summary>
  1740. <remarks>
  1741. The image object is created from the specified <see cref="T:System.Drawing.Image"/> object that will be rendered at the position (x,y) in the pdf header or footer
  1742. with the specified destination width and the height auto determined to keep the aspect ratio.
  1743. </remarks>
  1744. <param name="x">The X position where this element will be rendered.</param>
  1745. <param name="y">The Y position where this element will be rendered.</param>
  1746. <param name="width">The destination rectangle width.</param>
  1747. <param name="imageObj">The system image object.</param>
  1748. </member>
  1749. <member name="M:SelectPdf.PdfImageSection.#ctor(System.Single,System.Single,System.Single,System.Single,System.Drawing.Image)">
  1750. <summary>
  1751. Creates an image object that can be added to the header or footer templates of a pdf document.
  1752. </summary>
  1753. <remarks>
  1754. The image object is created from the specified <see cref="T:System.Drawing.Image"/> object that will be rendered at the position (x,y) in the pdf header or footer
  1755. with the specified destination width and height size.
  1756. </remarks>
  1757. <param name="x">The X position where this element will be rendered.</param>
  1758. <param name="y">The Y position where this element will be rendered.</param>
  1759. <param name="width">The destination rectangle width.</param>
  1760. <param name="height">The destination rectangle height.</param>
  1761. <param name="imageObj">The system image object.</param>
  1762. </member>
  1763. <member name="P:SelectPdf.PdfImageSection.X">
  1764. <summary>
  1765. Gets or sets the image position on the X axis.
  1766. </summary>
  1767. </member>
  1768. <member name="P:SelectPdf.PdfImageSection.Y">
  1769. <summary>
  1770. Gets or sets the image position on the Y axis.
  1771. </summary>
  1772. </member>
  1773. <member name="P:SelectPdf.PdfImageSection.Width">
  1774. <summary>
  1775. Gets or sets the image width in the destination pdf page.
  1776. </summary>
  1777. </member>
  1778. <member name="P:SelectPdf.PdfImageSection.Height">
  1779. <summary>
  1780. Gets or sets the image height in the destination pdf page.
  1781. </summary>
  1782. </member>
  1783. <member name="P:SelectPdf.PdfImageSection.Image">
  1784. <summary>
  1785. Gets the underlying system image object.
  1786. </summary>
  1787. </member>
  1788. <member name="P:SelectPdf.PdfImageSection.Transparency">
  1789. <summary>
  1790. Gets or sets the pdf element transparency.
  1791. </summary>
  1792. <remarks>The transparency is expressed as a value between 0 and 100.
  1793. <para></para>
  1794. The value 0 means completely transparent and 100 means completely opaque.
  1795. </remarks>
  1796. </member>
  1797. <member name="T:SelectPdf.PdfBookmarkOptions">
  1798. <summary>
  1799. Helps defining a set of html elements that will be associated with bookmarks in the generated pdf document.
  1800. </summary>
  1801. </member>
  1802. <member name="P:SelectPdf.PdfBookmarkOptions.CssSelectors">
  1803. <summary>
  1804. Gets or sets the selectors of the html elements to be bookmarked.
  1805. For example, the selector for all the H1 elements is "H1", the selector for all the elements with the CSS class name 'myclass'
  1806. is "*.myclass" and the selector for the elements with the id 'myid' is "*#myid".
  1807. </summary>
  1808. </member>
  1809. <member name="T:SelectPdf.PdfColorSpace">
  1810. <summary>
  1811. The list of possible color spaces for the pdf document.
  1812. </summary>
  1813. </member>
  1814. <member name="F:SelectPdf.PdfColorSpace.RGB">
  1815. <summary>
  1816. RGB color space.
  1817. </summary>
  1818. </member>
  1819. <member name="F:SelectPdf.PdfColorSpace.CMYK">
  1820. <summary>
  1821. CMYK color space.
  1822. </summary>
  1823. </member>
  1824. <member name="F:SelectPdf.PdfColorSpace.GrayScale">
  1825. <summary>
  1826. Gray scale color space.
  1827. </summary>
  1828. </member>
  1829. <member name="T:SelectPdf.PdfDestination">
  1830. <summary>
  1831. Represents a destination in a pdf document.
  1832. </summary>
  1833. <remarks>The pdf destination is used by links, bookmarks or open actions to jump at a specified position in the pdf document.</remarks>
  1834. </member>
  1835. <member name="M:SelectPdf.PdfDestination.#ctor(SelectPdf.PdfPage)">
  1836. <summary>
  1837. Constructs a pdf destination to the specified pdf page.
  1838. </summary>
  1839. <param name="page">The destination page.</param>
  1840. </member>
  1841. <member name="M:SelectPdf.PdfDestination.#ctor(SelectPdf.PdfPage,System.Drawing.PointF)">
  1842. <summary>
  1843. Constructs a pdf destination to the specified location in the specified page.
  1844. </summary>
  1845. <param name="page">The destination page.</param>
  1846. <param name="location">The location in the destination pdf page.</param>
  1847. </member>
  1848. <member name="M:SelectPdf.PdfDestination.#ctor(SelectPdf.PdfPage,System.Drawing.PointF,SelectPdf.PdfDestinationFitMode)">
  1849. <summary>
  1850. Constructs a destination to the specified location in the specified page and with the specified fit mode
  1851. in the destination page.
  1852. </summary>
  1853. <param name="page">The destination page.</param>
  1854. <param name="location">The location in the destination page.</param>
  1855. <param name="fitMode">The destination fit mode.</param>
  1856. </member>
  1857. <member name="P:SelectPdf.PdfDestination.Location">
  1858. <summary>
  1859. Gets or sets the location point in the destination page.
  1860. </summary>
  1861. </member>
  1862. <member name="P:SelectPdf.PdfDestination.ZoomFactor">
  1863. <summary>
  1864. Gets or sets the zoom factor of the destination page when viewed in a pdf viewer.
  1865. </summary>
  1866. <remarks> This only works when <see cref="P:SelectPdf.PdfDestination.FitMode"/> is <see cref="F:SelectPdf.PdfDestinationFitMode.None"/>.
  1867. <para></para>
  1868. This zoom factor is a percentage. A value of 100 will not zoom the page.</remarks>
  1869. </member>
  1870. <member name="P:SelectPdf.PdfDestination.Page">
  1871. <summary>
  1872. Gets or sets the destination page.
  1873. </summary>
  1874. </member>
  1875. <member name="P:SelectPdf.PdfDestination.FitMode">
  1876. <summary>
  1877. Gets or sets the auto-fit mode in the destination page.
  1878. </summary>
  1879. </member>
  1880. <member name="T:SelectPdf.HtmlToPdfDocumentInformation">
  1881. <summary>
  1882. This class provides the possibility to control the pdf document properties.
  1883. </summary>
  1884. <remarks>
  1885. Using this class, the pdf document properties (author, title, keywords, etc) can be controlled. The <see cref="T:SelectPdf.HtmlToPdfOptions"/> class defines
  1886. a reference to an object of this type.
  1887. </remarks>
  1888. </member>
  1889. <member name="P:SelectPdf.HtmlToPdfDocumentInformation.Author">
  1890. <summary>
  1891. Gets or sets the name of the pdf document author.
  1892. </summary>
  1893. </member>
  1894. <member name="P:SelectPdf.HtmlToPdfDocumentInformation.CreationDate">
  1895. <summary>
  1896. Gets or sets the date and time when the pdf document was created.
  1897. </summary>
  1898. </member>
  1899. <member name="P:SelectPdf.HtmlToPdfDocumentInformation.Keywords">
  1900. <summary>
  1901. Gets or sets the pdf document keywords.
  1902. </summary>
  1903. </member>
  1904. <member name="P:SelectPdf.HtmlToPdfDocumentInformation.Producer">
  1905. <summary>
  1906. Gets the name of the application that generated the pdf document (Select.Pdf SDK).
  1907. </summary>
  1908. </member>
  1909. <member name="P:SelectPdf.HtmlToPdfDocumentInformation.Subject">
  1910. <summary>
  1911. Gets or sets the subject of the pdf document.
  1912. </summary>
  1913. </member>
  1914. <member name="P:SelectPdf.HtmlToPdfDocumentInformation.Title">
  1915. <summary>
  1916. Gets or sets the pdf document title.
  1917. </summary>
  1918. </member>
  1919. <member name="T:SelectPdf.HtmlToPdfException">
  1920. <summary>
  1921. Exception thrown by the html to pdf converter related objects.
  1922. </summary>
  1923. </member>
  1924. <member name="M:SelectPdf.HtmlToPdfException.#ctor(System.String)">
  1925. <summary>
  1926. Initializes a <see cref="T:SelectPdf.HtmlToPdfException"/> object.
  1927. </summary>
  1928. <param name="message">The exception message.</param>
  1929. </member>
  1930. <member name="M:SelectPdf.HtmlToPdfException.#ctor(System.String,System.Exception)">
  1931. <summary>
  1932. Initializes a <see cref="T:SelectPdf.HtmlToPdfException"/> object.
  1933. </summary>
  1934. <param name="message">The exception message.</param>
  1935. <param name="innerException">The inner exception that triggered this exception.</param>
  1936. </member>
  1937. <member name="T:SelectPdf.HtmlToImage">
  1938. <summary>
  1939. Html to Image Converter. This class offers the API needed to create images in various formats from
  1940. a specified web page or html string.
  1941. </summary>
  1942. </member>
  1943. <member name="M:SelectPdf.HtmlToImage.#ctor">
  1944. <summary>
  1945. Creates an html to image converter. Width and height of the web page are automatically detected.
  1946. </summary>
  1947. </member>
  1948. <member name="M:SelectPdf.HtmlToImage.#ctor(System.Int32)">
  1949. <summary>
  1950. Creates an html to image converter. The width of the web page is specified. The height of the web page is automatically detected.
  1951. </summary>
  1952. <param name="webPageWidth">The web page width.</param>
  1953. </member>
  1954. <member name="M:SelectPdf.HtmlToImage.#ctor(System.Int32,System.Int32)">
  1955. <summary>
  1956. Creates an html to image converter for a web page with the specified width and height.
  1957. </summary>
  1958. <param name="webPageWidth">The web page width.</param>
  1959. <param name="webPageHeight">The web page height.</param>
  1960. </member>
  1961. <member name="M:SelectPdf.HtmlToImage.ConvertUrl(System.String)">
  1962. <summary>
  1963. Gets an <see cref="T:System.Drawing.Image"/> object from the specified url.
  1964. </summary>
  1965. <remarks>The Image object can be further manipulated to have the format changed, saved to disk, etc.</remarks>
  1966. <param name="url">The full url of the web page to be converted to image. The url can be also the full path of a html file from the local file system.</param>
  1967. <returns>The rendered Image object.</returns>
  1968. </member>
  1969. <member name="M:SelectPdf.HtmlToImage.ConvertHtmlString(System.String)">
  1970. <summary>
  1971. Gets an <see cref="T:System.Drawing.Image"/> object from the specified html string.
  1972. </summary>
  1973. <remarks> The Image object can be further manipulated to have the format changed, saved to disk, etc.</remarks>
  1974. <param name="htmlString">The html string to be converted to image.</param>
  1975. <returns>The rendered Image object.</returns>
  1976. </member>
  1977. <member name="M:SelectPdf.HtmlToImage.ConvertHtmlString(System.String,System.String)">
  1978. <summary>
  1979. Gets an <see cref="T:System.Drawing.Image"/> object from the specified html string.
  1980. </summary>
  1981. <remarks>
  1982. The <c>baseUrl</c> parameter allows the converter to determine the full absolute urls from relative urls for images and css files appearing in the html string.
  1983. <para></para>
  1984. The Image object can be further manipulated to have the format changed, saved to disk, etc.
  1985. </remarks>
  1986. <param name="htmlString">The html string to be converted to image.</param>
  1987. <param name="baseUrl">This parameter allows the converter to resolve relative urls. Basically, <c>baseUrl + relative image/css url = full absolute url</c>.</param>
  1988. <returns>The rendered Image object.</returns>
  1989. </member>
  1990. <member name="P:SelectPdf.HtmlToImage.VisibleWebElementId">
  1991. <summary>
  1992. Use this property to convert only a certain section of the web page, specified by the html element ID.
  1993. </summary>
  1994. </member>
  1995. <member name="P:SelectPdf.HtmlToImage.StartupMode">
  1996. <summary>
  1997. Use this property to specify how the conversion starts.
  1998. </summary>
  1999. <remarks>
  2000. By default this is set to <see cref="F:SelectPdf.HtmlToPdfStartupMode.Automatic"/> and the conversion is started as soon as the page loads (and <see cref="P:SelectPdf.HtmlToImage.MinPageLoadTime"/> elapses).
  2001. If set to <see cref="F:SelectPdf.HtmlToPdfStartupMode.Manual"/>, the conversion is started only by a javascript call to <c>SelectPdf.startConversion()</c> from within the web page.
  2002. </remarks>
  2003. </member>
  2004. <member name="P:SelectPdf.HtmlToImage.StartupScript">
  2005. <summary>
  2006. Use this property to specify some JavaScript code that will be injected into the page that is converted.
  2007. </summary>
  2008. <remarks>The JavaScript code specified here will run before any other script on the page.</remarks>
  2009. </member>
  2010. <member name="P:SelectPdf.HtmlToImage.WebPageWidth">
  2011. <summary>
  2012. Gets or sets the web page width.
  2013. </summary>
  2014. </member>
  2015. <member name="P:SelectPdf.HtmlToImage.WebPageHeight">
  2016. <summary>
  2017. Gets or sets the web page height. If the width was not set, this property has no effect.
  2018. </summary>
  2019. </member>
  2020. <member name="P:SelectPdf.HtmlToImage.WebPageFixedSize">
  2021. <summary>Controls whether the web page is rendered with a fixed size internal browser or the size automatically extends to make the whole content visible.</summary>
  2022. <remarks>
  2023. If the html content is not entirely visible in the web page viewer (browser) at the specified width, this property will control whether the
  2024. html content is clipped or the web page browser width is automatically extended to make visible the whole html content.
  2025. <para></para>
  2026. The html browser width is given by the <see cref="P:SelectPdf.HtmlToImage.WebPageWidth"/> property.
  2027. <para></para>
  2028. The default value of this property is false.
  2029. </remarks>
  2030. </member>
  2031. <member name="P:SelectPdf.HtmlToImage.JavaScriptEnabled">
  2032. <summary>
  2033. Enable scripts when rendering the url or html string.
  2034. </summary>
  2035. <remarks>The default value of this property is true and the converter will run any javascript available when the page loads.
  2036. <para></para>
  2037. <para>Note: If the javascript requires some time to load, <see cref="P:SelectPdf.HtmlToImage.MinPageLoadTime"/> property should be set to delay the conversion with the specified number of seconds and allow the javascript to run.</para>
  2038. </remarks>
  2039. </member>
  2040. <member name="P:SelectPdf.HtmlToImage.PluginsEnabled">
  2041. <summary>
  2042. A flag indicating if plugins (like Flash players) are enabled in the converter.
  2043. </summary>
  2044. <remarks>
  2045. The default value for this property is true.
  2046. </remarks>
  2047. </member>
  2048. <member name="P:SelectPdf.HtmlToImage.ProxyOptions">
  2049. <summary>
  2050. Gets a reference to an object containing the proxy settings used to access the web page that is being converted.
  2051. </summary>
  2052. </member>
  2053. <member name="P:SelectPdf.HtmlToImage.AuthenticationUsername">
  2054. <summary>
  2055. Specifies the username if the web page being converted requires authentication.
  2056. </summary>
  2057. </member>
  2058. <member name="P:SelectPdf.HtmlToImage.AuthenticationPassword">
  2059. <summary>
  2060. Specifies the password if the web page being converted requires authentication.
  2061. </summary>
  2062. </member>
  2063. <member name="P:SelectPdf.HtmlToImage.MinPageLoadTime">
  2064. <summary>
  2065. An additional time in seconds to wait for asynchronous items to be loaded before the web page is rendered.
  2066. </summary>
  2067. <remarks>
  2068. A delay of this type could be necessary if javascripts are loaded when the page is rendered or if Flash movies are played.
  2069. </remarks>
  2070. </member>
  2071. <member name="P:SelectPdf.HtmlToImage.MaxPageLoadTime">
  2072. <summary>
  2073. The web page navigation timeout in seconds.
  2074. </summary>
  2075. <remarks>Default value is 60 seconds. This value should be increased if large web pages are loaded.</remarks>
  2076. </member>
  2077. <member name="P:SelectPdf.HtmlToImage.HttpCookies">
  2078. <summary>
  2079. Gets the collection of custom HTTP cookies used for the conversion.
  2080. </summary>
  2081. <remarks>
  2082. This property returns a reference to the collection of custom HTTP cookies to be sent by the converter to the web server when the web page is rendered.
  2083. A cookie is defined by a name/value pair that can be added to the collection using the <see cref="M:System.Collections.Specialized.NameValueCollection.Add(System.String,System.String)"/> method of the <see cref="P:SelectPdf.HtmlToImage.HttpCookies"/> property.
  2084. </remarks>
  2085. </member>
  2086. <member name="P:SelectPdf.HtmlToImage.HttpHeaders">
  2087. <summary>
  2088. Get the collection of custom HTTP headers used for the conversion.
  2089. </summary>
  2090. <remarks>
  2091. This property returns a reference to the collection of custom HTTP headers to be sent by the converter to the web server when the web page is rendered.
  2092. A custom HTTP header is defined by a name/value pair
  2093. that can be added to the collection using the <see cref="M:System.Collections.Specialized.NameValueCollection.Add(System.String,System.String)"/> method of the <see cref="P:SelectPdf.HtmlToImage.HttpHeaders"/> property.
  2094. </remarks>
  2095. </member>
  2096. <member name="P:SelectPdf.HtmlToImage.HttpPostParameters">
  2097. <summary>
  2098. Gets the collection of custom HTTP POST parameters used for the conversion.
  2099. </summary>
  2100. <remarks>
  2101. This property returns a reference to the collection of custom HTTP POST parameters that will be sent by the converter to the web server when the web page is rendered.
  2102. A POST parameter is defined by a name/value pair that can be added to the collection using the <see cref="M:System.Collections.Specialized.NameValueCollection.Add(System.String,System.String)"/> method of the <see cref="P:SelectPdf.HtmlToImage.HttpPostParameters"/> property.
  2103. When this collection has at least one parameter, the rendered page is a accessed via POST method. Otherwise the method is GET.
  2104. </remarks>
  2105. </member>
  2106. <member name="T:SelectPdf.PdfCompressionLevel">
  2107. <summary>
  2108. The pdf document compression level.
  2109. </summary>
  2110. </member>
  2111. <member name="F:SelectPdf.PdfCompressionLevel.NoCompression">
  2112. <summary>
  2113. No compression.
  2114. </summary>
  2115. </member>
  2116. <member name="F:SelectPdf.PdfCompressionLevel.Normal">
  2117. <summary>
  2118. Normal compression level.
  2119. </summary>
  2120. </member>
  2121. <member name="F:SelectPdf.PdfCompressionLevel.Best">
  2122. <summary>
  2123. Best compression. Produces the smallest pdf document but it takes longer to compress it.
  2124. </summary>
  2125. </member>
  2126. <member name="T:SelectPdf.HtmlToPdf">
  2127. <summary>
  2128. Html To Pdf Converter. This class offers the API needed to convert any web page url or html string to pdf.
  2129. </summary>
  2130. <remarks>
  2131. The result of conversion is a <see cref="T:SelectPdf.PdfDocument"/> object that can be further modified, saved to memory or into a file on the disk.
  2132. </remarks>
  2133. <example>
  2134. The following sample code shows how an HtmlToPdf Converter can be instantiated and a basic conversion performed.
  2135. <code language="cs">
  2136. using SelectPdf;
  2137. HtmlToPdf converter = new HtmlToPdf();
  2138. PdfDocument doc = converter.ConvertUrl(url);
  2139. doc.Save(file);
  2140. doc.Close();
  2141. </code>
  2142. <code language="vb">
  2143. Imports SelectPdf
  2144. Dim converter as HtmlToPdf = New HtmlToPdf()
  2145. Dim doc as PdfDocument = converter.ConvertUrl(url)
  2146. doc.Save(file)
  2147. doc.Close()
  2148. </code>
  2149. </example>
  2150. </member>
  2151. <member name="M:SelectPdf.HtmlToPdf.#ctor">
  2152. <summary>
  2153. Initializes an instance of the HtmlToPdf Converter.
  2154. </summary>
  2155. <remarks>
  2156. The web page is rendered by an internal browser having the default width of 1024px.
  2157. The height of the page is automatically calculated. The width and height can be set using <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageWidth"/> and <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageHeight"/> properties of <see cref="P:SelectPdf.HtmlToPdf.Options"/> property.
  2158. <para>Usually, the web page width and height do not need to be set and the converter automatically calculates them,
  2159. but there are some situations (web pages with frames for example) when the converter cannot calculate the page size correctly.
  2160. In this case, the web page width and height needs to be set, otherwise no content will appear in the generated pdf document.</para>
  2161. </remarks>
  2162. <example>
  2163. The following sample code shows how an HtmlToPdf Converter can be instantiated and a basic conversion performed.
  2164. <code language="cs">
  2165. HtmlToPdf converter = new HtmlToPdf();
  2166. PdfDocument doc = converter.ConvertUrl(url);
  2167. doc.Save(file);
  2168. doc.Close();
  2169. </code>
  2170. <code language="vb">
  2171. Dim converter as HtmlToPdf = New HtmlToPdf()
  2172. Dim doc as PdfDocument = converter.ConvertUrl(url)
  2173. doc.Save(file)
  2174. doc.Close()
  2175. </code>
  2176. </example>
  2177. <seealso cref="P:SelectPdf.HtmlToPdfOptions.WebPageWidth"/>
  2178. <seealso cref="P:SelectPdf.HtmlToPdfOptions.WebPageHeight"/>
  2179. </member>
  2180. <member name="M:SelectPdf.HtmlToPdf.#ctor(System.Int32)">
  2181. <summary>
  2182. Initializes an instance of the HtmlToPdf Converter.
  2183. </summary>
  2184. <remarks>
  2185. The web page is rendered by an internal browser having the width specified by the <c>webPageWidth</c> parameter and
  2186. the height automatically calculated.
  2187. The width and height can be also set using <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageWidth"/> and <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageHeight"/> properties of <see cref="P:SelectPdf.HtmlToPdf.Options"/> property.
  2188. <para>Usually, the web page height does not need to be set and the converter automatically calculates it,
  2189. but there are some situations (web pages with frames for example) when the converter cannot calculate the page height correctly.
  2190. In this case, the web page needs to be set, otherwise no content will appear in the generated pdf document.</para>
  2191. </remarks>
  2192. <param name="webPageWidth">Width in pixels of the internal browser that renders the web page.</param>
  2193. <example>
  2194. The following sample code shows how an HtmlToPdf Converter can be instantiated and a basic conversion performed.
  2195. <code language="cs">
  2196. HtmlToPdf converter = new HtmlToPdf(width);
  2197. PdfDocument doc = converter.ConvertUrl(url);
  2198. doc.Save(file);
  2199. doc.Close();
  2200. </code>
  2201. <code language="vb">
  2202. Dim converter as HtmlToPdf = New HtmlToPdf(width)
  2203. Dim doc as PdfDocument = converter.ConvertUrl(url)
  2204. doc.Save(file)
  2205. doc.Close()
  2206. </code>
  2207. </example>
  2208. <seealso cref="P:SelectPdf.HtmlToPdfOptions.WebPageWidth"/>
  2209. <seealso cref="P:SelectPdf.HtmlToPdfOptions.WebPageHeight"/>
  2210. </member>
  2211. <member name="M:SelectPdf.HtmlToPdf.#ctor(System.Int32,System.Int32)">
  2212. <summary>
  2213. Initializes an instance of the HtmlToPdf Converter.
  2214. </summary>
  2215. <remarks>
  2216. The web page is rendered by an internal browser having the width specified by the <c>webPageWidth</c> parameter and
  2217. the height of the page specified by the <c>webPageHeight</c> parameter.
  2218. The width and height can be also set using <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageWidth"/> and <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageHeight"/> properties of <see cref="P:SelectPdf.HtmlToPdf.Options"/> property.
  2219. <para>If <c>webPageHeight</c> is set, the web page will be truncated to the specified height.
  2220. Usually, <c>webPageHeight</c> should be set to 0 to determine the converter to automatically calculate the page height,
  2221. but there are some situations (web pages with frames for example) when the converter cannot calculate the page height correctly.
  2222. In this case, <c>webPageHeight</c> needs to be set, otherwise no content will appear in the generated pdf document.</para>
  2223. </remarks>
  2224. <param name="webPageWidth">Width in pixels of the internal browser that renders the web page.</param>
  2225. <param name="webPageHeight">Height in pixels of the internal browser that renders the web page.</param>
  2226. <example>
  2227. The following sample code shows how an HtmlToPdf Converter can be instantiated and a basic conversion performed.
  2228. <code language="cs">
  2229. HtmlToPdf converter = new HtmlToPdf(width, height);
  2230. PdfDocument doc = converter.ConvertUrl(url);
  2231. doc.Save(file);
  2232. doc.Close();
  2233. </code>
  2234. <code language="vb">
  2235. Dim converter as HtmlToPdf = New HtmlToPdf(width, height)
  2236. Dim doc as PdfDocument = converter.ConvertUrl(url)
  2237. doc.Save(file)
  2238. doc.Close()
  2239. </code>
  2240. </example>
  2241. <seealso cref="P:SelectPdf.HtmlToPdfOptions.WebPageWidth"/>
  2242. <seealso cref="P:SelectPdf.HtmlToPdfOptions.WebPageHeight"/>
  2243. </member>
  2244. <member name="M:SelectPdf.HtmlToPdf.ConvertUrl(System.String)">
  2245. <summary>
  2246. Gets a <see cref="T:SelectPdf.PdfDocument"/> object representing the result of the conversion of the specified url to pdf.
  2247. </summary>
  2248. <remarks>
  2249. The resulted <see cref="T:SelectPdf.PdfDocument"/> object can be modified and saved to a file, to a stream, to a memory buffer or to a HTTP response.
  2250. The <see cref="T:SelectPdf.PdfDocument"/> object must be closed after save to release the system resources used during conversion.
  2251. </remarks>
  2252. <param name="url">The full url of the web page to be converted to pdf. The url can be also the full path of a html file from the local file system.</param>
  2253. <returns>The <see cref="T:SelectPdf.PdfDocument"/> object that can be modified and saved to a file, to a stream, to a memory buffer or to a HTTP response.
  2254. </returns>
  2255. <example>
  2256. The following sample code shows how an HtmlToPdf Converter can be instantiated and a basic conversion performed.
  2257. <code language="cs">
  2258. HtmlToPdf converter = new HtmlToPdf();
  2259. PdfDocument doc = converter.ConvertUrl(url);
  2260. doc.Save(file);
  2261. doc.Close();
  2262. </code>
  2263. <code language="vb">
  2264. Dim converter as HtmlToPdf = New HtmlToPdf()
  2265. Dim doc as PdfDocument = converter.ConvertUrl(url)
  2266. doc.Save(file)
  2267. doc.Close()
  2268. </code>
  2269. </example>
  2270. </member>
  2271. <member name="M:SelectPdf.HtmlToPdf.ConvertHtmlString(System.String)">
  2272. <summary>
  2273. Gets a <see cref="T:SelectPdf.PdfDocument"/> object representing the result of the conversion of the specified html string to pdf.
  2274. </summary>
  2275. <remarks>
  2276. The resulted <see cref="T:SelectPdf.PdfDocument"/> object can be modified and saved to a file, to a stream, to a memory buffer or to a HTTP response.
  2277. The <see cref="T:SelectPdf.PdfDocument"/> object must be closed after save to release the system resources used during conversion.
  2278. <para>
  2279. This method does not use any base url and therefore the images or css files referenced by relative urls in the html string cannot be resolved by the converter to an absolute url.
  2280. If there are external resources referenced by relative urls, the <see cref="M:SelectPdf.HtmlToPdf.ConvertHtmlString(System.String,System.String)"/> method with the <c>baseUrl</c> additional parameter should be used.
  2281. </para>
  2282. </remarks>
  2283. <param name="htmlString">The html string to be converted to pdf.</param>
  2284. <returns>The <see cref="T:SelectPdf.PdfDocument"/> object that can be modified and saved to a file, to a stream, to a memory buffer or to a HTTP response.
  2285. </returns>
  2286. <example>
  2287. The following sample code shows how an HtmlToPdf Converter can be instantiated and a basic conversion performed.
  2288. <code language="cs">
  2289. HtmlToPdf converter = new HtmlToPdf();
  2290. PdfDocument doc = converter.ConvertHtmlString(html);
  2291. doc.Save(file);
  2292. doc.Close();
  2293. </code>
  2294. <code language="vb">
  2295. Dim converter as HtmlToPdf = New HtmlToPdf()
  2296. Dim doc as PdfDocument = converter.ConvertString(html)
  2297. doc.Save(file)
  2298. doc.Close()
  2299. </code>
  2300. </example>
  2301. </member>
  2302. <member name="M:SelectPdf.HtmlToPdf.ConvertHtmlString(System.String,System.String)">
  2303. <summary>
  2304. Gets a <see cref="T:SelectPdf.PdfDocument"/> object representing the result of the conversion of the specified html string to pdf.
  2305. </summary>
  2306. <remarks>
  2307. The resulted <see cref="T:SelectPdf.PdfDocument"/> object can be modified and saved to a file, to a stream, to a memory buffer or to a HTTP response.
  2308. The <see cref="T:SelectPdf.PdfDocument"/> object must be closed after save to release the system resources used during conversion.
  2309. <para>
  2310. The <c>baseUrl</c> parameter allows the converter to determine the full absolute urls from relative urls for images and css files appearing in the html string.
  2311. </para>
  2312. </remarks>
  2313. <param name="htmlString">The html string to be converted to pdf.</param>
  2314. <param name="baseUrl">This parameter allows the converter to resolve relative urls. Basically, <c>baseUrl + relative image/css url = full absolute url</c>.</param>
  2315. <returns>The <see cref="T:SelectPdf.PdfDocument"/> object that can be modified and saved to a file, to a stream, to a memory buffer or to a HTTP response.
  2316. </returns>
  2317. <example>
  2318. The following sample code shows how an HtmlToPdf Converter can be instantiated and a basic conversion performed.
  2319. <code language="cs">
  2320. HtmlToPdf converter = new HtmlToPdf();
  2321. PdfDocument doc = converter.ConvertHtmlString(html, baseUrl);
  2322. doc.Save(file);
  2323. doc.Close();
  2324. </code>
  2325. <code language="vb">
  2326. Dim converter as HtmlToPdf = New HtmlToPdf()
  2327. Dim doc as PdfDocument = converter.ConvertString(html, baseUrl)
  2328. doc.Save(file)
  2329. doc.Close()
  2330. </code>
  2331. </example>
  2332. </member>
  2333. <member name="P:SelectPdf.HtmlToPdf.Options">
  2334. <summary>
  2335. Gets a reference to an object that controls the html to pdf conversion process and the generated pdf document properties.
  2336. </summary>
  2337. <remarks>
  2338. This property can be used to control the generated pdf header, footer, margins, page size and orientation, compression level, content resizing and many more.
  2339. Check <see cref="T:SelectPdf.HtmlToPdfOptions"/> for complete details.
  2340. </remarks>
  2341. </member>
  2342. <member name="P:SelectPdf.HtmlToPdf.Header">
  2343. <summary>
  2344. Gets a reference to an object that controls the properties of the custom header of the generated pdf document.
  2345. </summary>
  2346. <remarks>The header is displayed in the generated pdf document only if the <see cref="P:SelectPdf.HtmlToPdfOptions.DisplayHeader"/> property is set to true.
  2347. </remarks>
  2348. </member>
  2349. <member name="P:SelectPdf.HtmlToPdf.Footer">
  2350. <summary>
  2351. Gets a reference to an object that controls the properties of the custom footer of the generated pdf document.
  2352. </summary>
  2353. <remarks>The footer is displayed in the generated pdf document only if the <see cref="P:SelectPdf.HtmlToPdfOptions.DisplayFooter"/> property is set to true.
  2354. </remarks>
  2355. </member>
  2356. <member name="P:SelectPdf.HtmlToPdf.ConversionResult">
  2357. <summary>
  2358. Gets a reference to an object that offers information about the result of the html to pdf conversion process.
  2359. </summary>
  2360. <remarks>
  2361. After a successful conversion this property is initialized with an instance of the <see cref="T:SelectPdf.HtmlToPdfResult"/> class.
  2362. If the conversion failed this property returns a null value.
  2363. </remarks>
  2364. </member>
  2365. <member name="T:SelectPdf.HtmlToPdfOptions">
  2366. <summary>
  2367. This class contains various options used for the html to pdf conversion.
  2368. </summary>
  2369. <remarks>
  2370. The <see cref="T:SelectPdf.HtmlToPdf"/> class defines a reference to an object of this type.</remarks>
  2371. </member>
  2372. <member name="P:SelectPdf.HtmlToPdfOptions.MarginLeft">
  2373. <summary>
  2374. The left margin of the pdf document.
  2375. </summary>
  2376. <remarks>
  2377. The margin is specified in points. 1 point is 1/72 inch.
  2378. </remarks>
  2379. </member>
  2380. <member name="P:SelectPdf.HtmlToPdfOptions.MarginRight">
  2381. <summary>
  2382. The right margin of the pdf document.
  2383. </summary>
  2384. <remarks>
  2385. The margin is specified in points. 1 point is 1/72 inch.
  2386. </remarks>
  2387. </member>
  2388. <member name="P:SelectPdf.HtmlToPdfOptions.MarginTop">
  2389. <summary>
  2390. The top margin of the pdf document.
  2391. </summary>
  2392. <remarks>
  2393. The margin is specified in points. 1 point is 1/72 inch.
  2394. </remarks>
  2395. </member>
  2396. <member name="P:SelectPdf.HtmlToPdfOptions.MarginBottom">
  2397. <summary>
  2398. The bottom margin of the pdf document.
  2399. </summary>
  2400. <remarks>
  2401. The margin is specified in points. 1 point is 1/72 inch.
  2402. </remarks>
  2403. </member>
  2404. <member name="P:SelectPdf.HtmlToPdfOptions.PdfCompressionLevel">
  2405. <summary>
  2406. This property controls the compression level of the generated pdf document.
  2407. </summary>
  2408. <remarks>The default value is <see cref="F:SelectPdf.PdfCompressionLevel.Normal"/>.</remarks>
  2409. </member>
  2410. <member name="P:SelectPdf.HtmlToPdfOptions.JpegCompressionEnabled">
  2411. <summary>
  2412. Gets or sets a flag indicating if the JPEG compression is enabled or not for the images in the generated pdf document.
  2413. </summary>
  2414. <remarks>
  2415. By default the JPEG compression is enabled to reduce the size of the generated pdf document. When the JPEG compression is enabled
  2416. the quality of the images in the generated pdf is lower than the quality of the original images from the web page,
  2417. and this quality depends on the <see cref="P:SelectPdf.HtmlToPdfOptions.JpegCompressionLevel"/> parameter. When the <see cref="P:SelectPdf.HtmlToPdfOptions.JpegCompressionLevel"/> is increased, the quality of the images in pdf decreases.
  2418. </remarks>
  2419. </member>
  2420. <member name="P:SelectPdf.HtmlToPdfOptions.JpegCompressionLevel">
  2421. <summary>
  2422. Gets or sets the compression level of images in the generated pdf document.
  2423. </summary>
  2424. <remarks>
  2425. This property can take values between 0 and 100. It has effect only when the <see cref="P:SelectPdf.HtmlToPdfOptions.JpegCompressionEnabled"/> is set to true.
  2426. When the <see cref="P:SelectPdf.HtmlToPdfOptions.JpegCompressionLevel"/> is 0, the compression rate is the lowest and the quality of the images is the best.
  2427. When the <see cref="P:SelectPdf.HtmlToPdfOptions.JpegCompressionLevel"/> is 100, the compression rate is the highest and quality of the images in PDF is the worst.
  2428. <para></para>
  2429. The default JPEG compression level is 10, which should offer a good balance between the compression rate and
  2430. the quality of the images in pdf.
  2431. </remarks>
  2432. </member>
  2433. <member name="P:SelectPdf.HtmlToPdfOptions.PdfPageSize">
  2434. <summary>
  2435. This property controls the size of the generated document pages.
  2436. </summary>
  2437. <remarks>The default size of the pdf document pages is <see cref="F:SelectPdf.PdfPageSize.A4"/>. When this property is set to <see cref="F:SelectPdf.PdfPageSize.Custom"/>,
  2438. a custom size can be specified for the generated pdf document pages using the <see cref="P:SelectPdf.HtmlToPdfOptions.PdfPageCustomSize"/> property.
  2439. </remarks>
  2440. </member>
  2441. <member name="P:SelectPdf.HtmlToPdfOptions.PdfPageCustomSize">
  2442. <summary>
  2443. This property can be used to specify a custom pdf document page size.
  2444. </summary>
  2445. <remarks>
  2446. The property is taken into account only when <see cref="P:SelectPdf.HtmlToPdfOptions.PdfPageSize"/> property is set to <see cref="F:SelectPdf.PdfPageSize.Custom"/>.
  2447. The custom width and height of the pdf page is specified in points. 1 point is 1/72 inch.
  2448. </remarks>
  2449. </member>
  2450. <member name="P:SelectPdf.HtmlToPdfOptions.AutoFitWidth">
  2451. <summary>Specifies the html content horizontal auto fit mode.</summary>
  2452. <remarks>
  2453. The converter considers both <see cref="P:SelectPdf.HtmlToPdfOptions.AutoFitWidth"/> and <see cref="P:SelectPdf.HtmlToPdfOptions.AutoFitHeight"/> when the html content is rendered in the pdf page or specified rectangle.
  2454. <para></para>
  2455. <para></para>
  2456. If this property is set to <see cref="F:SelectPdf.HtmlToPdfPageFitMode.NoAdjustment"/>, the html content is not resized horizontally in any way to fit the available space. If the content is larger,
  2457. it will be cut and not all of it will be displayed in the generated pdf file.
  2458. <para></para>
  2459. If this property is set to <see cref="F:SelectPdf.HtmlToPdfPageFitMode.ShrinkOnly"/>, the html content is resized only if the content width is larger than the destination space
  2460. (pdf page or rectangle) width.
  2461. In this case, the content is shrunk to fit the destination space width and the elements that it contains (texts, images) will appear smaller in the generated
  2462. pdf document than in the original web page.
  2463. If the original content width is smaller than the destination width, no adjustments will be done and the content will be rendered exactly as it is,
  2464. even though some additional white space might appear to its right.
  2465. <para></para>
  2466. If this property is set to <see cref="F:SelectPdf.HtmlToPdfPageFitMode.AutoFit"/>, the html content is resized to fit the available width of the destination space.
  2467. If the original content width is smaller than the destination width,
  2468. the elements rendered (texts, images) will appear larger in the generated pdf document. If the original content width is larger than the destination width,
  2469. the elements rendered (texts, images) will appear smaller in the generated pdf document.
  2470. <para>The default value of this property is <see cref="F:SelectPdf.HtmlToPdfPageFitMode.ShrinkOnly"/>.</para>
  2471. </remarks>
  2472. </member>
  2473. <member name="P:SelectPdf.HtmlToPdfOptions.AutoFitHeight">
  2474. <summary>Specifies the html content vertical auto fit mode.</summary>
  2475. <remarks>
  2476. The converter considers both <see cref="P:SelectPdf.HtmlToPdfOptions.AutoFitWidth"/> and <see cref="P:SelectPdf.HtmlToPdfOptions.AutoFitHeight"/> when the html content is rendered in the pdf page or specified rectangle.
  2477. <para></para>
  2478. <para></para>
  2479. If this property is set to <see cref="F:SelectPdf.HtmlToPdfPageFitMode.NoAdjustment"/>, the html content is not resized vertically in any way to fit the available space. If the content is larger,
  2480. it will be cut and not all of it will be displayed in the generated pdf file.
  2481. <para></para>
  2482. If this property is set to <see cref="F:SelectPdf.HtmlToPdfPageFitMode.ShrinkOnly"/>, the html content is resized only if the content height is larger than the destination space
  2483. (pdf page or rectangle) height.
  2484. In this case, the content is shrunk to fit the destination space height and the elements that it contains (texts, images) will appear smaller in the generated
  2485. pdf document than in the original web page.
  2486. If the original content height is smaller than the destination height, no adjustments will be done and the content will be rendered exactly as it is,
  2487. even though some additional white space might appear at the bottom.
  2488. <para></para>
  2489. If this property is set to <see cref="F:SelectPdf.HtmlToPdfPageFitMode.AutoFit"/>, the converter will treat it like <see cref="F:SelectPdf.HtmlToPdfPageFitMode.ShrinkOnly"/>.
  2490. <para>The default value of this property is <see cref="F:SelectPdf.HtmlToPdfPageFitMode.NoAdjustment"/> and for rendering, the converter will only take <see cref="P:SelectPdf.HtmlToPdfOptions.AutoFitWidth"/> into consideration.</para>
  2491. </remarks>
  2492. </member>
  2493. <member name="P:SelectPdf.HtmlToPdfOptions.PdfPageOrientation">
  2494. <summary>
  2495. This property controls the page orientation of the generated pdf document pages.
  2496. </summary>
  2497. <remarks>The default pdf page orientation is <see cref="F:SelectPdf.PdfPageOrientation.Portrait"/>.
  2498. </remarks>
  2499. </member>
  2500. <member name="P:SelectPdf.HtmlToPdfOptions.DisplayHeader">
  2501. <summary>
  2502. Controls if a custom header is displayed in the generated pdf document.
  2503. </summary>
  2504. <remarks>
  2505. The header properties can be customized using the <see cref="T:SelectPdf.PdfHeader"/> object exposed by <see cref="P:SelectPdf.HtmlToPdf.Header"/> property of the <see cref="T:SelectPdf.HtmlToPdf"/> converter class.
  2506. <para>Note: The default value of this property is false and the generated pdf document will not have a custom header.</para>
  2507. </remarks>
  2508. </member>
  2509. <member name="P:SelectPdf.HtmlToPdfOptions.DisplayFooter">
  2510. <summary>
  2511. Controls if a custom footer is displayed in the generated pdf document.
  2512. </summary>
  2513. <remarks>
  2514. The footer properties can be customized using the <see cref="T:SelectPdf.PdfFooter"/> object exposed by <see cref="P:SelectPdf.HtmlToPdf.Footer"/> property of the <see cref="T:SelectPdf.HtmlToPdf"/> converter class.
  2515. <para>Note: The default value of this property is false and the generated pdf document will not have a custom footer.</para>
  2516. </remarks>
  2517. </member>
  2518. <member name="P:SelectPdf.HtmlToPdfOptions.EmbedFonts">
  2519. <summary>
  2520. Instructs the converter to embed all the needed fonts into the pdf document or not.
  2521. </summary>
  2522. <remarks>
  2523. The default value for this property is false and the fonts are not automatically embedded.
  2524. <para>
  2525. This property does not control the web fonts (fonts that are downloaded with the web page). The web fonts are always embedded because they are not installed on the machine.
  2526. </para>
  2527. </remarks>
  2528. </member>
  2529. <member name="P:SelectPdf.HtmlToPdfOptions.ExternalLinksEnabled">
  2530. <summary>
  2531. Controls the rendering of external hyperlinks in pdf.
  2532. </summary>
  2533. <remarks>
  2534. The default value for this property is true and in this case all external hyperlinks from the web page will be rendered in the generated pdf document.
  2535. <para>When this property is set to false, external links are ignore and they do not appear in the generated pdf document.</para>
  2536. </remarks>
  2537. </member>
  2538. <member name="P:SelectPdf.HtmlToPdfOptions.InternalLinksEnabled">
  2539. <summary>
  2540. Controls the conversion of internal html links to internal pdf links.
  2541. </summary>
  2542. <remarks>
  2543. The default value for this property is true and in this case all internal hyperlinks from the web page (links that point within the web page) will be rendered in the
  2544. generated pdf document as internal pdf links (clicking one of them will jump within the pdf document).
  2545. </remarks>
  2546. </member>
  2547. <member name="P:SelectPdf.HtmlToPdfOptions.WebPageWidth">
  2548. <summary>Gets or sets the width of the converted web page as it would appear in the internal browser used to render the html.</summary>
  2549. <remarks>The web page width is specified in pixels and the default value is 1024px.
  2550. The page width is only an indication of the minimum page width recommended for conversion. If the content does not fit this width,
  2551. the converter will automatically resize the internal browser to fit the whole html content. To avoid this, the <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageFixedSize"/> property needs to be set to true.
  2552. When <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageFixedSize"/> is true, the web page will be rendered with the specified <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageWidth"/> and <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageHeight"/> even though the content might be truncated.
  2553. <para></para>
  2554. <para></para>
  2555. If <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageWidth"/> is set to 0, the converter will automatically determine the page width, finding the width that will fit the html content.
  2556. <para>This property can also be set directly in the constructor of <see cref="T:SelectPdf.HtmlToPdf"/> class.</para>
  2557. </remarks>
  2558. </member>
  2559. <member name="P:SelectPdf.HtmlToPdfOptions.WebPageHeight">
  2560. <summary>Gets or sets the height of the converted web page as it would appear in the internal browser used to render the html.</summary>
  2561. <remarks>
  2562. The web page height is specified in pixels and the default value is 0px. This means that the converter will automatically calculate the page height.
  2563. <para>Generally this property does not need to be changed, but there are situations when the converter cannot calculate correctly the web page height (for example for web pages with frames) and
  2564. in that case, <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageHeight"/> needs to be set, otherwise no content might appear in the generated pdf.
  2565. </para>
  2566. <para>
  2567. Note: If the <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageHeight"/> is set, the content that exceeds this page height is truncated and will not appear in the generated pdf document.
  2568. Only using the default 0 value will allow the whole page content to be rendered all the time in the generated pdf document.
  2569. </para>
  2570. <para>This property can also be set directly in the constructor of <see cref="T:SelectPdf.HtmlToPdf"/> class.</para>
  2571. </remarks>
  2572. </member>
  2573. <member name="P:SelectPdf.HtmlToPdfOptions.WebPageFixedSize">
  2574. <summary>Controls whether the web page is rendered with a fixed size internal browser or the size automatically extends to make the whole content visible.</summary>
  2575. <remarks>
  2576. The default value of this property is false.
  2577. <para></para>
  2578. <para></para>
  2579. If the web page does not fit the dimensions specified by the <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageWidth"/> and <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageHeight"/> properties and <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageFixedSize"/>
  2580. is set to false, the converter will try to automatically calculate a larger width and height to be able to display the whole html content.
  2581. <para>
  2582. If <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageFixedSize"/> is set to true, this will indicate the converter not to calculate another width and height, but use width and height specified by <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageWidth"/> and <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageHeight"/>.
  2583. These dimensions with be used even though the content will not fit the available space and it will be truncated.
  2584. </para>
  2585. <para>
  2586. Note: If <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageFixedSize"/> is set to true, a page height needs to be set using <see cref="P:SelectPdf.HtmlToPdfOptions.WebPageHeight"/>, because the default value (0) will make the converter fail (cannot render a web page with no height).
  2587. </para>
  2588. </remarks>
  2589. </member>
  2590. <member name="P:SelectPdf.HtmlToPdfOptions.VisibleWebElementId">
  2591. <summary>
  2592. Use this property to convert only a certain section of the page, specified by the html element ID.
  2593. </summary>
  2594. </member>
  2595. <member name="P:SelectPdf.HtmlToPdfOptions.StartupMode">
  2596. <summary>
  2597. Use this property to specify how the conversion starts.
  2598. </summary>
  2599. <remarks>
  2600. By default this is set to <see cref="F:SelectPdf.HtmlToPdfStartupMode.Automatic"/> and the conversion is started as soon as the page loads (and <see cref="P:SelectPdf.HtmlToPdfOptions.MinPageLoadTime"/> elapses).
  2601. If set to <see cref="F:SelectPdf.HtmlToPdfStartupMode.Manual"/>, the conversion is started only by a javascript call to <c>SelectPdf.startConversion()</c> from within the web page.
  2602. </remarks>
  2603. </member>
  2604. <member name="P:SelectPdf.HtmlToPdfOptions.StartupScript">
  2605. <summary>
  2606. Use this property to specify some JavaScript code that will be injected into the page that is converted.
  2607. </summary>
  2608. <remarks>The JavaScript code specified here will run before any other script on the page.</remarks>
  2609. </member>
  2610. <member name="P:SelectPdf.HtmlToPdfOptions.KeepTextsTogether">
  2611. <summary>
  2612. This property instructs the converter whether to try to avoid cutting off the text lines between pdf pages or not.
  2613. </summary>
  2614. <remarks>The default value is true and the converter tries to avoid text cutting between pdf pages.</remarks>
  2615. </member>
  2616. <member name="P:SelectPdf.HtmlToPdfOptions.KeepImagesTogether">
  2617. <summary>
  2618. This property instructs the converter whether to try to avoid cutting off the images between pdf pages or not.
  2619. </summary>
  2620. <remarks>The default value is false and the converter does not try to avoid images cutting between pdf pages.</remarks>
  2621. </member>
  2622. <member name="P:SelectPdf.HtmlToPdfOptions.JavaScriptEnabled">
  2623. <summary>
  2624. Enable scripts when rendering the url or html string.
  2625. </summary>
  2626. <remarks>The default value of this property is true and the converter will run any javascript available when the page loads.
  2627. <para></para>
  2628. <para>Note: If the javascript requires some time to load, <see cref="P:SelectPdf.HtmlToPdfOptions.MinPageLoadTime"/> property should be set to delay the conversion
  2629. with the specified number of seconds and allow the javascript to run.</para>
  2630. </remarks>
  2631. </member>
  2632. <member name="P:SelectPdf.HtmlToPdfOptions.PluginsEnabled">
  2633. <summary>
  2634. A flag indicating if plugins (like Flash players) are enabled in the converter.
  2635. </summary>
  2636. <remarks>
  2637. The default value for this property is true.
  2638. </remarks>
  2639. </member>
  2640. <member name="P:SelectPdf.HtmlToPdfOptions.CssMediaType">
  2641. <summary>
  2642. Indicates what css styles are used when the web page is rendered.
  2643. </summary>
  2644. <remarks>The default value is <see cref="F:SelectPdf.HtmlToPdfCssMediaType.Screen"/> and the page is rendered like in a regular web browser.
  2645. If the page contains printer specific styles, the property should be set to <see cref="F:SelectPdf.HtmlToPdfCssMediaType.Print"/> to have the page rendered using those css styles.</remarks>
  2646. </member>
  2647. <member name="P:SelectPdf.HtmlToPdfOptions.RenderPageOnTimeout">
  2648. <summary>
  2649. A flag indicating if the page is rendered even if a navigation timeout occurs. The default value is False and a navigation timeout exception is raised.
  2650. </summary>
  2651. </member>
  2652. <member name="P:SelectPdf.HtmlToPdfOptions.ScaleImages">
  2653. <summary>
  2654. A flag indicating if the images from the page are scaled during the conversion process. The default value is False and images are not scaled.
  2655. </summary>
  2656. </member>
  2657. <member name="P:SelectPdf.HtmlToPdfOptions.DrawBackground">
  2658. <summary>
  2659. Gets or sets a flag indicating if the web page background is rendered in pdf.
  2660. </summary>
  2661. <remarks>
  2662. The default value for this property is true and the page background is rendered into the generated pdf.
  2663. Even though it might be white, it will still make invisible any pdf element that was rendered behind it.
  2664. Setting this property to false can make visible the existing pdf elements behind this html element.
  2665. </remarks>
  2666. </member>
  2667. <member name="P:SelectPdf.HtmlToPdfOptions.HttpCookies">
  2668. <summary>
  2669. Gets the collection of custom HTTP cookies used for the conversion.
  2670. </summary>
  2671. <remarks>
  2672. This property returns a reference to the collection of custom HTTP cookies to be sent by the converter to the web server when the web page is rendered.
  2673. A cookie is defined by a name/value pair that can be added to the collection using the <see cref="M:System.Collections.Specialized.NameValueCollection.Add(System.String,System.String)"/> method of the <see cref="P:SelectPdf.HtmlToPdfOptions.HttpCookies"/> property.
  2674. </remarks>
  2675. </member>
  2676. <member name="P:SelectPdf.HtmlToPdfOptions.HttpHeaders">
  2677. <summary>
  2678. Get the collection of custom HTTP headers used for the conversion.
  2679. </summary>
  2680. <remarks>
  2681. This property returns a reference to the collection of custom HTTP headers to be sent by the converter to the web server when the web page is rendered.
  2682. A custom HTTP header is defined by a name/value pair
  2683. that can be added to the collection using the <see cref="M:System.Collections.Specialized.NameValueCollection.Add(System.String,System.String)"/> method of the <see cref="P:SelectPdf.HtmlToPdfOptions.HttpHeaders"/> property.
  2684. </remarks>
  2685. </member>
  2686. <member name="P:SelectPdf.HtmlToPdfOptions.HttpPostParameters">
  2687. <summary>
  2688. Gets the collection of custom HTTP POST parameters used for the conversion.
  2689. </summary>
  2690. <remarks>
  2691. This property returns a reference to the collection of custom HTTP POST parameters that will be sent by the converter to the web server when the web page is rendered.
  2692. A POST parameter is defined by a name/value pair that can be added to the collection using the <see cref="M:System.Collections.Specialized.NameValueCollection.Add(System.String,System.String)"/> method of the <see cref="P:SelectPdf.HtmlToPdfOptions.HttpPostParameters"/> property.
  2693. When this collection has at least one parameter, the rendered page is a accessed via POST method. Otherwise the method is GET.
  2694. </remarks>
  2695. </member>
  2696. <member name="P:SelectPdf.HtmlToPdfOptions.MinPageLoadTime">
  2697. <summary>
  2698. An additional time in seconds to wait for asynchronous items to be loaded before the web page is rendered.
  2699. </summary>
  2700. <remarks>
  2701. A delay of this type could be necessary if javascripts are loaded when the page is rendered or if Flash movies are played.
  2702. </remarks>
  2703. </member>
  2704. <member name="P:SelectPdf.HtmlToPdfOptions.MaxPageLoadTime">
  2705. <summary>
  2706. The web page navigation timeout in seconds.
  2707. </summary>
  2708. <remarks>Default value is 60 seconds. This value should be increased if large web pages are loaded.</remarks>
  2709. </member>
  2710. <member name="P:SelectPdf.HtmlToPdfOptions.Authentication">
  2711. <summary>
  2712. Handles authentication options if the web page being converted requires authentication.
  2713. </summary>
  2714. </member>
  2715. <member name="P:SelectPdf.HtmlToPdfOptions.PdfDocumentInformation">
  2716. <summary>
  2717. Gets a reference to the object that specifies the generated pdf document properties.
  2718. </summary>
  2719. </member>
  2720. <member name="P:SelectPdf.HtmlToPdfOptions.SecurityOptions">
  2721. <summary>
  2722. Gets a reference to the object that specifies the generated pdf document security settings.
  2723. </summary>
  2724. <remarks>
  2725. This property returns a reference to a <see cref="T:SelectPdf.PdfSecurityOptions"/> object that can be used to control the generated pdf
  2726. document security settings (like password, printing or editing restrictions).
  2727. </remarks>
  2728. </member>
  2729. <member name="P:SelectPdf.HtmlToPdfOptions.PdfBookmarkOptions">
  2730. <summary>
  2731. Gets a reference to the object that controls the bookmarks creation for the generated pdf document.
  2732. </summary>
  2733. <remarks>
  2734. This property needs to be set to instruct the html to pdf converter to automatically generate some bookmarks in the pdf document. The converter will create bookmarks for the web elements
  2735. specified by the <see cref="P:SelectPdf.PdfBookmarkOptions.CssSelectors"/> of the <see cref="P:SelectPdf.HtmlToPdfOptions.PdfBookmarkOptions"/> property.
  2736. </remarks>
  2737. </member>
  2738. <member name="P:SelectPdf.HtmlToPdfOptions.HiddenWebElements">
  2739. <summary>
  2740. Gets a reference to the object that controls the visibility of some web elements in the generated pdf document.
  2741. </summary>
  2742. <remarks>
  2743. This property needs to be set to instruct the html to pdf converter to hide some elements from the web page and not render them in the pdf document.
  2744. The converter will not render the web elements specified by the <see cref="P:SelectPdf.HiddenWebElements.CssSelectors"/> of the <see cref="P:SelectPdf.HtmlToPdfOptions.HiddenWebElements"/> property.
  2745. </remarks>
  2746. </member>
  2747. <member name="P:SelectPdf.HtmlToPdfOptions.ViewerPreferences">
  2748. <summary>
  2749. Controls how the pdf document will appear in a pdf viewer (like Adobe Reader).
  2750. </summary>
  2751. </member>
  2752. <member name="P:SelectPdf.HtmlToPdfOptions.ProxyOptions">
  2753. <summary>
  2754. Gets a reference to an object containing the proxy settings used to access the web page that is being converted.
  2755. </summary>
  2756. </member>
  2757. <member name="P:SelectPdf.HtmlToPdfOptions.PdfStandard">
  2758. <summary>
  2759. Defines the pdf standard used by the generated pdf document.
  2760. </summary>
  2761. <remarks>
  2762. The default value is <see cref="F:SelectPdf.PdfStandard.Full"/> and in this case the full set of pdf features can be used in the generated document.
  2763. This property can be used to instruct the converter to generate PDF/A, PDF/X or PDF/SiqQ compliant documents.
  2764. </remarks>
  2765. </member>
  2766. <member name="P:SelectPdf.HtmlToPdfOptions.ColorSpace">
  2767. <summary>
  2768. Gets or sets the color space of the generated pdf document.
  2769. </summary>
  2770. <remarks>
  2771. The possible values are <see cref="F:SelectPdf.PdfColorSpace.RGB"/>, <see cref="F:SelectPdf.PdfColorSpace.CMYK"/> or <see cref="F:SelectPdf.PdfColorSpace.GrayScale"/>. The default
  2772. color space is <see cref="F:SelectPdf.PdfColorSpace.RGB"/>.
  2773. </remarks>
  2774. </member>
  2775. <member name="P:SelectPdf.HtmlToPdfOptions.MaximumConcurrentConversions">
  2776. <summary>
  2777. Maximum number of html to pdf conversions that can be performed simultaneously.
  2778. </summary>
  2779. <remarks>
  2780. This parameter must be set before the first conversion performed by the application.
  2781. When this property is set with a negative value or zero, the concurrency level is maximum. The default value is 4.
  2782. <para>If the maximum number is reached and more conversion requests arrive, they will wait in a queue for an available spot.</para>
  2783. </remarks>
  2784. </member>
  2785. <member name="P:SelectPdf.HtmlToPdfOptions.GenerateSinglePagePdf">
  2786. <summary>
  2787. Generate a single page PDF. The converter will automatically resize the PDF page to fit all the content in a single page.
  2788. </summary>
  2789. <remarks>The default value of this property is False.</remarks>
  2790. </member>
  2791. <member name="P:SelectPdf.HtmlToPdfOptions.WebElementsMappingOptions">
  2792. <summary>
  2793. Gets a reference to the object controlling the retrieval of HTML elements position in the generated PDF.
  2794. In order to retrieve the position in PDF for a list of HTML elements, the <see cref="P:SelectPdf.WebElementsMappingOptions.CssSelectors"/> property of
  2795. <see cref="T:SelectPdf.WebElementsMappingOptions"/> must be set with an array of strings containing the selectors of the HTML elements.
  2796. The positions of the HTML elements in the generated PDF document will be returned in the
  2797. <see cref="P:SelectPdf.WebElementsMappingOptions.Result"/> object.
  2798. </summary>
  2799. </member>
  2800. <member name="P:SelectPdf.HtmlToPdfOptions.PageBreaksEnhancedAlgorithm">
  2801. <summary>
  2802. Gets or sets a flag indicating if an enhanced custom page breaks algorithm is used.
  2803. The enhanced algorithm is slower but it will prevent the appearance of hidden text in the PDF when custom page breaks are used.
  2804. </summary>
  2805. <remarks>The default value for this property is False.</remarks>
  2806. </member>
  2807. <member name="P:SelectPdf.HtmlToPdfOptions.DisplayCutText">
  2808. <summary>
  2809. Gets or sets a flag indicating if the text that is out of the calculated rendering rectangle is displayed or not.
  2810. </summary>
  2811. <remarks>The default value for this property is False.</remarks>
  2812. </member>
  2813. <member name="T:SelectPdf.PdfBookmark">
  2814. <summary>
  2815. Represents a bookmark in a pdf document.
  2816. </summary>
  2817. </member>
  2818. <member name="P:SelectPdf.PdfBookmark.Text">
  2819. <summary>
  2820. Gets or sets the bookmark text.
  2821. </summary>
  2822. </member>
  2823. <member name="P:SelectPdf.PdfBookmark.Color">
  2824. <summary>
  2825. Gets or sets the bookmark text color.
  2826. </summary>
  2827. </member>
  2828. <member name="P:SelectPdf.PdfBookmark.Style">
  2829. <summary>
  2830. Gets or sets the bookmark text style.
  2831. </summary>
  2832. </member>
  2833. <member name="P:SelectPdf.PdfBookmark.Destination">
  2834. <summary>
  2835. Gets or sets the bookmark destination.
  2836. </summary>
  2837. </member>
  2838. <member name="P:SelectPdf.PdfBookmark.Parent">
  2839. <summary>
  2840. Gets the parent of the current bookmark or null if the bookmark has no parent.
  2841. </summary>
  2842. </member>
  2843. <member name="P:SelectPdf.PdfBookmark.ChildNodes">
  2844. <summary>
  2845. Gets the child bookmark collection.
  2846. </summary>
  2847. </member>
  2848. <member name="T:SelectPdf.PdfBookmarksCollection">
  2849. <summary>
  2850. Represents the collection of bookmarks in a pdf document.
  2851. </summary>
  2852. </member>
  2853. <member name="F:SelectPdf.PdfBookmarksCollection.document">
  2854. <summary>
  2855. The parent PDF Document.
  2856. </summary>
  2857. </member>
  2858. <member name="M:SelectPdf.PdfBookmarksCollection.#ctor(SelectPdf.PdfDocument)">
  2859. <summary>
  2860. Creates a collection of bookmarks for this document.
  2861. </summary>
  2862. <param name="document">The PDF document for which this collection is created.</param>
  2863. </member>
  2864. <member name="M:SelectPdf.PdfBookmarksCollection.GetEnumerator">
  2865. <summary>
  2866. Gets the collection enumerator.
  2867. </summary>
  2868. <returns>The collection enumerator.</returns>
  2869. </member>
  2870. <member name="M:SelectPdf.PdfBookmarksCollection.Add(System.String,SelectPdf.PdfDestination)">
  2871. <summary>
  2872. Adds a new bookmark to the bookmarks collection.
  2873. </summary>
  2874. <param name="text">The bookmark text.</param>
  2875. <param name="destination">The bookmark destination.</param>
  2876. <returns>The newly created pdf bookmark.</returns>
  2877. </member>
  2878. <member name="M:SelectPdf.PdfBookmarksCollection.Insert(System.Int32,System.String,SelectPdf.PdfDestination)">
  2879. <summary>
  2880. Creates a new bookmark and inserts it at the specified zero based index in the bookmarks collection.
  2881. </summary>
  2882. <param name="index">The zero based index where to insert the bookmark.</param>
  2883. <param name="text">The bookmark text.</param>
  2884. <param name="destination">The bookmark destination.</param>
  2885. <returns>The newly created pdf bookmark.</returns>
  2886. </member>
  2887. <member name="M:SelectPdf.PdfBookmarksCollection.Remove(SelectPdf.PdfBookmark)">
  2888. <summary>
  2889. Removes the specified pdf bookmark.
  2890. </summary>
  2891. <param name="bookmark">The pdf bookmark to be removed.</param>
  2892. </member>
  2893. <member name="M:SelectPdf.PdfBookmarksCollection.RemoveAt(System.Int32)">
  2894. <summary>
  2895. Removes the pdf bookmark at the specified index in the bookmarks collection.
  2896. </summary>
  2897. <param name="index">The zero based index of the pdf bookmark to be removed.</param>
  2898. </member>
  2899. <member name="P:SelectPdf.PdfBookmarksCollection.Document">
  2900. <summary>
  2901. The parent pdf document of the bookmarks collection.
  2902. </summary>
  2903. </member>
  2904. <member name="P:SelectPdf.PdfBookmarksCollection.Item(System.Int32)">
  2905. <summary>
  2906. Gets or sets the bookmark at the specified zero based index in the bookmarks collection.
  2907. </summary>
  2908. <param name="index">The zero based bookmark index in the pdf bookmarks collection.</param>
  2909. <returns>The pdf bookmark at the specified index.</returns>
  2910. </member>
  2911. <member name="P:SelectPdf.PdfBookmarksCollection.Count">
  2912. <summary>
  2913. The number of bookmarks in the pdf bookmarks collection.
  2914. </summary>
  2915. </member>
  2916. <member name="T:SelectPdf.PdfBookmarkStyle">
  2917. <summary>
  2918. The pdf bookmark text style.
  2919. </summary>
  2920. </member>
  2921. <member name="F:SelectPdf.PdfBookmarkStyle.Normal">
  2922. <summary>
  2923. Normal text style.
  2924. </summary>
  2925. </member>
  2926. <member name="F:SelectPdf.PdfBookmarkStyle.Italic">
  2927. <summary>
  2928. The text is italic.
  2929. </summary>
  2930. </member>
  2931. <member name="F:SelectPdf.PdfBookmarkStyle.Bold">
  2932. <summary>
  2933. The text is bold.
  2934. </summary>
  2935. </member>
  2936. <member name="T:SelectPdf.PdfDestinationFitMode">
  2937. <summary>
  2938. Specifies the auto-fit mode for a <see cref="T:SelectPdf.PdfDestination"/> object.
  2939. </summary>
  2940. </member>
  2941. <member name="F:SelectPdf.PdfDestinationFitMode.None">
  2942. <summary>
  2943. Does not try to automatically fit the page.
  2944. </summary>
  2945. <remarks>
  2946. Displays the page specified, with the coordinates (left, top) positioned
  2947. at the upper-left corner of the window and the contents of the page magnified by the factor zoom.
  2948. A null value for any of the parameters left, top, or zoom specifies that the current value of that parameter is to be retained unchanged.
  2949. A zoom value of 0 has the same meaning as a null value.
  2950. </remarks>
  2951. </member>
  2952. <member name="F:SelectPdf.PdfDestinationFitMode.EntirePage">
  2953. <summary>
  2954. Automatically fits the entire page.
  2955. </summary>
  2956. <remarks>
  2957. Displays the page specified, with its contents magnified just enough to fit the entire page
  2958. within the window both horizontally and vertically.
  2959. If the required horizontal and vertical magnification factors are different,
  2960. use the smaller of the two, centering the page within the window in the other dimension.
  2961. </remarks>
  2962. </member>
  2963. <member name="F:SelectPdf.PdfDestinationFitMode.EntirePageWidth">
  2964. <summary>
  2965. Automatically fits the entire width of the page.
  2966. </summary>
  2967. <remarks>
  2968. Displays the page specified, with the vertical coordinate top positioned
  2969. at the top edge of the window and the contents of the page magnified
  2970. just enough to fit the entire width of the page within the window.
  2971. </remarks>
  2972. </member>
  2973. <member name="F:SelectPdf.PdfDestinationFitMode.EntirePageHeight">
  2974. <summary>
  2975. Automatically fits the entire height of the page.
  2976. </summary>
  2977. <remarks>
  2978. Displays the page specified, with the horizontal coordinate left positioned
  2979. at the left edge of the window and the contents of the page magnified
  2980. just enough to fit the entire height of the page within the window.
  2981. </remarks>
  2982. </member>
  2983. <member name="F:SelectPdf.PdfDestinationFitMode.BoundingBox">
  2984. <summary>
  2985. Automatically fits the bounding box.
  2986. </summary>
  2987. <remarks>
  2988. Displays the page specified, with its contents magnified
  2989. just enough to fit its bounding box entirely within the window both horizontally
  2990. and vertically. If the required horizontal and vertical magnification
  2991. factors are different, use the smaller of the two, centering the bounding box
  2992. within the window in the other dimension.
  2993. </remarks>
  2994. </member>
  2995. <member name="F:SelectPdf.PdfDestinationFitMode.BoundingBoxWidth">
  2996. <summary>
  2997. Automatically fits the entire bounding box width of the page.
  2998. </summary>
  2999. <remarks>
  3000. Displays the page specified, with the vertical coordinate top positioned at the top edge
  3001. of the window and the contents of the page magnified just enough to fit the entire width of its
  3002. bounding box within the window. A null value for top specifies that the current value of that
  3003. parameter is to be retained unchanged.
  3004. </remarks>
  3005. </member>
  3006. <member name="F:SelectPdf.PdfDestinationFitMode.BoundingBoxHeight">
  3007. <summary>
  3008. Automatically fits the entire bounding box height of the page.
  3009. </summary>
  3010. <remarks>
  3011. Displays the page specified, with the horizontal coordinate left positioned at the left
  3012. edge of the window and the contents of the page magnified just enough to fit the entire height
  3013. of its bounding box within the window. A null value for left specifies that the current value of that
  3014. parameter is to be retained unchanged.
  3015. </remarks>
  3016. </member>
  3017. <member name="T:SelectPdf.PdfDocument">
  3018. <summary>
  3019. Represents a pdf document.
  3020. </summary>
  3021. <remarks>
  3022. This class provides the API to create, load, modify and save a pdf document.
  3023. </remarks>
  3024. </member>
  3025. <member name="M:SelectPdf.PdfDocument.#ctor">
  3026. <summary>
  3027. Creates an empty pdf document object.
  3028. </summary>
  3029. <remarks>New pdf pages can be added to the document and new pdf elements can be added to these new document pages.</remarks>
  3030. </member>
  3031. <member name="M:SelectPdf.PdfDocument.#ctor(SelectPdf.PdfStandard)">
  3032. <summary>
  3033. Creates an empty pdf document object.
  3034. </summary>
  3035. <param name="pdfStandard">Defines the pdf standard used by the generated pdf document.
  3036. The default value is <see cref="F:SelectPdf.PdfStandard.Full"/> and in this case the full set of pdf features can be used in the generated document.
  3037. This parameter can be used to generate PDF/A, PDF/X or PDF/SiqQ compliant documents.
  3038. </param>
  3039. <remarks>New pdf pages can be added to the document and new pdf elements can be added to these new document pages.</remarks>
  3040. </member>
  3041. <member name="M:SelectPdf.PdfDocument.#ctor(System.IO.Stream)">
  3042. <summary>
  3043. Loads a pdf document from the specified stream.
  3044. </summary>
  3045. <param name="stream">The pdf document stream.</param>
  3046. </member>
  3047. <member name="M:SelectPdf.PdfDocument.#ctor(System.String)">
  3048. <summary>
  3049. Loads a pdf document from an existing pdf file.
  3050. </summary>
  3051. <param name="fileName">
  3052. The full path to the existing pdf document file.
  3053. </param>
  3054. </member>
  3055. <member name="M:SelectPdf.PdfDocument.#ctor(System.IO.Stream,System.String)">
  3056. <summary>
  3057. Loads a pdf document from a stream containing a password protected pdf document.
  3058. </summary>
  3059. <remarks>
  3060. The specified password can be a user or owner password.
  3061. </remarks>
  3062. <param name="stream">The stream containing the pdf document.</param>
  3063. <param name="password">The password to open the specified pdf document.</param>
  3064. </member>
  3065. <member name="M:SelectPdf.PdfDocument.#ctor(System.String,System.String)">
  3066. <summary>
  3067. Loads a pdf document from an existing password protected pdf file.
  3068. </summary>
  3069. <param name="fileName">The full path to the existing pdf file.</param>
  3070. <param name="password">The password to open the specified pdf document.</param>
  3071. </member>
  3072. <member name="M:SelectPdf.PdfDocument.Close">
  3073. <summary>
  3074. Closes the current pdf document.
  3075. </summary>
  3076. <remarks>
  3077. Calling this method will release all the resources allocated by the pdf document.
  3078. <para></para>
  3079. <note type="important">
  3080. Always call this method after the document was saved.
  3081. </note>
  3082. <para>
  3083. </para>
  3084. <note type="note">
  3085. If the document was created from a stream, the stream will be closed if it was not explicitly detached
  3086. by calling the <see cref="M:SelectPdf.PdfDocument.DetachStream"/> before the document is closed.
  3087. </note>
  3088. </remarks>
  3089. </member>
  3090. <member name="M:SelectPdf.PdfDocument.DetachStream">
  3091. <summary>
  3092. Detaches the stream that was used to load the pdf document, leaving it open in case the current pdf document is closed.
  3093. </summary>
  3094. <remarks>
  3095. Call this method to detach the stream from which the pdf document was created. When this method is called before
  3096. calling <see cref="M:SelectPdf.PdfDocument.Close"/>, the <see cref="M:SelectPdf.PdfDocument.Close"/> method will not close the detached stream.
  3097. </remarks>
  3098. </member>
  3099. <member name="M:SelectPdf.PdfDocument.Save(System.String)">
  3100. <summary>
  3101. Saves the pdf document to the specified file.
  3102. </summary>
  3103. <param name="fileName">The name of the file where to save the document. It can be a full path or a relative path.</param>
  3104. </member>
  3105. <member name="M:SelectPdf.PdfDocument.Save(System.IO.Stream)">
  3106. <summary>
  3107. Saves the pdf document to the specified stream.
  3108. </summary>
  3109. <param name="stream">The stream where to save the pdf document.</param>
  3110. </member>
  3111. <member name="M:SelectPdf.PdfDocument.Save">
  3112. <summary>
  3113. Saves the pdf document as byte array.
  3114. </summary>
  3115. <remarks>
  3116. The byte array can be further saved to a file or sent over HTTP as a response to the browser.
  3117. </remarks>
  3118. <returns>The byte array representation of the document.</returns>
  3119. </member>
  3120. <member name="M:SelectPdf.PdfDocument.Save(System.Web.HttpResponse,System.Boolean,System.String)">
  3121. <summary>
  3122. Saves the pdf document to a HTTP stream.
  3123. </summary>
  3124. <param name="httpResponse">The HTTP response object.</param>
  3125. <param name="displayInline">If this is true, the pdf document will be automatically opened in browser, otherwise the
  3126. user will be asked to save or open the downloaded pdf document.</param>
  3127. <param name="fileName">The name of the pdf document. This name is used by the browser when it opens the pdf document inline
  3128. or the name suggested for saving the document when the document is sent as an attachment.</param>
  3129. </member>
  3130. <member name="M:SelectPdf.PdfDocument.AddTemplate(System.Single,System.Single)">
  3131. <summary>
  3132. Adds a new template with the specified width and height to the pdf document templates collection.
  3133. </summary>
  3134. <remarks>
  3135. The template location is top left corner of the pdf page. Use <see cref="M:SelectPdf.PdfDocument.AddTemplate(System.Drawing.RectangleF)"/> to specify another location for the template.
  3136. </remarks>
  3137. <param name="width">The pdf template width.</param>
  3138. <param name="height">The pdf template height.</param>
  3139. <returns>The newly added pdf template.</returns>
  3140. </member>
  3141. <member name="M:SelectPdf.PdfDocument.AddTemplate(System.Drawing.RectangleF)">
  3142. <summary>
  3143. Adds a new template with the specified bounds to the pdf document templates collection.
  3144. </summary>
  3145. <param name="bounds">The template element bounds.</param>
  3146. <returns>The newly added pdf template.</returns>
  3147. </member>
  3148. <member name="M:SelectPdf.PdfDocument.AddPage">
  3149. <summary>
  3150. Creates a new pdf page and adds it to the pdf document pages collection.
  3151. </summary>
  3152. <remarks>
  3153. If there is a previous page in the pages collection, the orientation and size are inherited from that page, otherwise a first page with
  3154. the default <see cref="F:SelectPdf.PdfPageSize.A4"/> size and <see cref="F:SelectPdf.PdfPageOrientation.Portrait"/> orientation is created.
  3155. <para></para>
  3156. The page margins are inherited from the default pdf document margins specified in <see cref="P:SelectPdf.PdfDocument.Margins"/> property.</remarks>
  3157. <returns>The newly created pdf page.</returns>
  3158. </member>
  3159. <member name="M:SelectPdf.PdfDocument.AddPage(SelectPdf.PdfMargins)">
  3160. <summary>
  3161. Creates a new pdf page with the specified margins and adds it to the pdf document pages collection.
  3162. </summary>
  3163. <remarks>
  3164. If there is a previous page in the pages collection, the orientation and size are inherited from that page, otherwise a first page with
  3165. the default <see cref="F:SelectPdf.PdfPageSize.A4"/> size and <see cref="F:SelectPdf.PdfPageOrientation.Portrait"/> orientation is created.</remarks>
  3166. <param name="pageMargins">The pdf page margins.</param>
  3167. <returns>The newly created pdf page.</returns>
  3168. </member>
  3169. <member name="M:SelectPdf.PdfDocument.AddPage(SelectPdf.PdfCustomPageSize,SelectPdf.PdfMargins)">
  3170. <summary>
  3171. Creates a new pdf page with the specified size and margins and adds it to the pdf document pages collection.
  3172. </summary>
  3173. <remarks>
  3174. If there is a previous page in the pages collection, the orientation is inherited from that page, otherwise a first page with
  3175. the default <see cref="F:SelectPdf.PdfPageOrientation.Portrait"/> orientation is created.</remarks>
  3176. <param name="pageSize">The pdf page size.</param>
  3177. <param name="pageMargins">The pdf page margins.</param>
  3178. <returns>The newly created pdf page.</returns>
  3179. </member>
  3180. <member name="M:SelectPdf.PdfDocument.AddPage(SelectPdf.PdfCustomPageSize,SelectPdf.PdfMargins,SelectPdf.PdfPageOrientation)">
  3181. <summary>
  3182. Creates a new pdf page with the specified size, margins and orientation and adds it to the pdf document pages collection.
  3183. </summary>
  3184. <param name="pageSize">The pdf page size.</param>
  3185. <param name="pageMargins">The pdf page margins.</param>
  3186. <param name="pageOrientation">The pdf page orientation.</param>
  3187. <returns>The newly created pdf page.</returns>
  3188. </member>
  3189. <member name="M:SelectPdf.PdfDocument.AddPage(SelectPdf.PdfPage)">
  3190. <summary>
  3191. Adds the specified page to the pdf document pages collection.
  3192. </summary>
  3193. <remarks>
  3194. The specified page can belong to another pdf document.
  3195. <para></para>
  3196. <note type="important">The source pdf document must remain opened until the current document is saved.</note>
  3197. </remarks>
  3198. <param name="pdfPage">The page to be added to the collection.</param>
  3199. </member>
  3200. <member name="M:SelectPdf.PdfDocument.InsertPage(System.Int32,SelectPdf.PdfCustomPageSize,SelectPdf.PdfMargins,SelectPdf.PdfPageOrientation)">
  3201. <summary>
  3202. Creates a new pdf page with the specified size, margins and orientation and inserts it into the pdf document pages collection
  3203. at the specified index.
  3204. </summary>
  3205. <param name="index">The index where the new pdf page will be inserted.</param>
  3206. <param name="pageSize">The pdf page size.</param>
  3207. <param name="pageMargins">The pdf page margins.</param>
  3208. <param name="pageOrientation">The pdf page orientation.</param>
  3209. <returns>The newly created pdf page.</returns>
  3210. </member>
  3211. <member name="M:SelectPdf.PdfDocument.InsertPage(System.Int32,SelectPdf.PdfPage)">
  3212. <summary>
  3213. Inserts the specified page into the pdf document pages collection at the specified index.
  3214. </summary>
  3215. <remarks>
  3216. The specified page can belong to another pdf document.
  3217. <para></para>
  3218. <note>The source pdf document must remain opened until the current document is saved.</note>
  3219. </remarks>
  3220. <param name="pageIndex">The index where the pdf page will be inserted.</param>
  3221. <param name="pdfPage">The pdf page to be inserted into the collection.</param>
  3222. </member>
  3223. <member name="M:SelectPdf.PdfDocument.Append(SelectPdf.PdfDocument)">
  3224. <summary>
  3225. Appends all pages from another pdf document to the current pdf document.
  3226. </summary>
  3227. <remarks>
  3228. A custom range of pages from another document can be appended to the current document calling the
  3229. <see cref="M:SelectPdf.PdfPageCollection.Add(SelectPdf.PdfPage)"/> method on the <see cref="P:SelectPdf.PdfDocument.Pages"/> collection for each page to be appended.
  3230. <para></para>
  3231. <note type="important"></note>
  3232. The appended document must remain opened until the current document is saved.</remarks>
  3233. <param name="doc">The document to be appended.</param>
  3234. </member>
  3235. <member name="M:SelectPdf.PdfDocument.RemovePage(SelectPdf.PdfPage)">
  3236. <summary>
  3237. Removes the specified page from the pdf document pages collection.
  3238. </summary>
  3239. <param name="pdfPage">The pdf page to be removed.</param>
  3240. </member>
  3241. <member name="M:SelectPdf.PdfDocument.RemovePageAt(System.Int32)">
  3242. <summary>
  3243. Removes the pdf page at the specified index in pdf document pages collection.
  3244. </summary>
  3245. <param name="index">The zero based index of the pdf page to be removed.</param>
  3246. </member>
  3247. <member name="M:SelectPdf.PdfDocument.AddFont(System.Drawing.Font)">
  3248. <summary>
  3249. Adds a system font to the pdf fonts collection.
  3250. </summary>
  3251. <remarks>
  3252. If the font was already added, the method returns the existing font.
  3253. By default the font is embedded into the pdf document in order to support Unicode texts.
  3254. </remarks>
  3255. <param name="font">The system font to be added to the fonts collection.</param>
  3256. <returns>The pdf font added to the fonts collection.</returns>
  3257. </member>
  3258. <member name="M:SelectPdf.PdfDocument.AddFont(System.Drawing.Font,System.Boolean)">
  3259. <summary>
  3260. Adds a system font to the pdf fonts collection.
  3261. </summary>
  3262. <remarks>
  3263. If the font was already added, the method returns the existing font. The <c>embedFont</c> parameter indicates if the added font
  3264. will be embedded into the pdf document or not.</remarks>
  3265. <param name="font">Font for adding.The system font to be added to the fonts collection.</param>
  3266. <param name="embedFont">Specifies if the font will be embedded into the pdf document or not.</param>
  3267. <returns>The pdf font added to the fonts collection.</returns>
  3268. </member>
  3269. <member name="M:SelectPdf.PdfDocument.AddFont(System.String)">
  3270. <summary>
  3271. Adds a system font to the pdf fonts collection. The font is loaded from the specified file.
  3272. </summary>
  3273. <remarks>
  3274. If the font was already added, the method returns the existing pdf font.
  3275. </remarks>
  3276. <param name="fontFileName">The file name of the font to be added.</param>
  3277. <returns>The pdf font added to the fonts collection.</returns>
  3278. </member>
  3279. <member name="M:SelectPdf.PdfDocument.AddFont(SelectPdf.PdfStandardFont)">
  3280. <summary>
  3281. Adds a standard font to the pdf fonts collection.
  3282. </summary>
  3283. <remarks>
  3284. If the font was already added, the method returns the existing pdf font.
  3285. </remarks>
  3286. <param name="stdFont">The standard font family.</param>
  3287. <returns>The pdf font added to the fonts collection.</returns>
  3288. </member>
  3289. <member name="M:SelectPdf.PdfDocument.AddFont(SelectPdf.PdfStandardCJKFont)">
  3290. <summary>
  3291. Adds a standard CJK font to the pdf fonts collection.
  3292. </summary>
  3293. <remarks>
  3294. If the font was already added, the method returns the existing pdf font.
  3295. </remarks>
  3296. <param name="stdCJKFont">The standard CJK font to add to the pdf document fonts collection.</param>
  3297. <returns>The pdf font added to the fonts collection.</returns>
  3298. </member>
  3299. <member name="M:SelectPdf.PdfDocument.GetPagesCount(System.String)">
  3300. <summary>
  3301. Returns the number of pages in a specified pdf document.
  3302. </summary>
  3303. <param name="fileName">The pdf file.</param>
  3304. <returns>The number of pages in the specified pdf document.</returns>
  3305. </member>
  3306. <member name="M:SelectPdf.PdfDocument.GetPagesCount(System.IO.Stream)">
  3307. <summary>
  3308. Returns the number of pages in a specified pdf document.
  3309. </summary>
  3310. <param name="stream">The stream containing the pdf document.</param>
  3311. <returns>The number of pages in the specified pdf document.</returns>
  3312. </member>
  3313. <member name="M:SelectPdf.PdfDocument.AddBookmark(System.String,SelectPdf.PdfDestination)">
  3314. <summary>
  3315. Creates a root bookmark in the current pdf document.
  3316. </summary>
  3317. <param name="text">The bookmark text.</param>
  3318. <param name="destination">The bookmark destination.</param>
  3319. <returns>The newly added bookmark.</returns>
  3320. </member>
  3321. <member name="M:SelectPdf.PdfDocument.AddBookmark(System.String,SelectPdf.PdfDestination,SelectPdf.PdfBookmark)">
  3322. <summary>
  3323. Creates a child bookmark in the current pdf document under the specified parent bookmark.
  3324. </summary>
  3325. <param name="text">The bookmark text.</param>
  3326. <param name="destination">The bookmark destination.</param>
  3327. <param name="parent">The parent bookmark.</param>
  3328. <returns>The newly added bookmark.</returns>
  3329. </member>
  3330. <member name="P:SelectPdf.PdfDocument.Pages">
  3331. <summary>
  3332. Gets the pdf document pages collection.
  3333. </summary>
  3334. </member>
  3335. <member name="P:SelectPdf.PdfDocument.Fonts">
  3336. <summary>
  3337. Gets the pdf document fonts collection.
  3338. </summary>
  3339. </member>
  3340. <member name="P:SelectPdf.PdfDocument.Templates">
  3341. <summary>
  3342. Gets the pdf document templates collection.
  3343. </summary>
  3344. </member>
  3345. <member name="P:SelectPdf.PdfDocument.Bookmarks">
  3346. <summary>
  3347. Gets the bookmarks collection of the pdf document.
  3348. </summary>
  3349. </member>
  3350. <member name="P:SelectPdf.PdfDocument.Margins">
  3351. <summary>
  3352. The default pdf document margins.
  3353. </summary>
  3354. <remarks>
  3355. A new pages will use the default margins if no margins are specified when the page is added.</remarks>
  3356. </member>
  3357. <member name="P:SelectPdf.PdfDocument.Header">
  3358. <summary>
  3359. Represents the default pdf document header template.
  3360. </summary>
  3361. <remarks>
  3362. The header space is automatically taken into account when calculating the available space for rendering in a pdf page.
  3363. <para></para>
  3364. This template is automatically docked to the top of the pdf page.</remarks>
  3365. </member>
  3366. <member name="P:SelectPdf.PdfDocument.Footer">
  3367. <summary>
  3368. Represents the default pdf document footer template.
  3369. </summary>
  3370. <remarks>
  3371. The footer space is automatically taken into account when calculating the available space for rendering in a pdf page.
  3372. <para></para>
  3373. This template is automatically docked to the bottom of the pdf page.</remarks>
  3374. </member>
  3375. <member name="P:SelectPdf.PdfDocument.DocumentInformation">
  3376. <summary>
  3377. Gets a reference to the object that specifies the pdf document properties.
  3378. </summary>
  3379. </member>
  3380. <member name="P:SelectPdf.PdfDocument.Security">
  3381. <summary>
  3382. Gets a reference to the object that specifies the pdf document security settings.
  3383. </summary>
  3384. </member>
  3385. <member name="P:SelectPdf.PdfDocument.ViewerPreferences">
  3386. <summary>
  3387. Controls how the pdf document will appear in a pdf viewer (like Adobe Reader).
  3388. </summary>
  3389. </member>
  3390. <member name="P:SelectPdf.PdfDocument.OpenAction">
  3391. <summary>
  3392. The action to be performed when the pdf document is opened.
  3393. </summary>
  3394. <remarks>
  3395. The pdf document can perform 2 types of actions when it is opened:
  3396. <list type="bullet">
  3397. <item>
  3398. <description><see cref="T:SelectPdf.PdfActionGoTo"/> - The pdf document opens at a specific <see cref="T:SelectPdf.PdfDestination"/>.</description>
  3399. </item>
  3400. <item>
  3401. <description><see cref="T:SelectPdf.PdfActionJavaScript"/> - The pdf document will run a specific javascript.</description>
  3402. </item>
  3403. </list>
  3404. </remarks>
  3405. </member>
  3406. <member name="P:SelectPdf.PdfDocument.CompressionLevel">
  3407. <summary>
  3408. Gets or sets the pdf document compression level.
  3409. </summary>
  3410. </member>
  3411. <member name="P:SelectPdf.PdfDocument.JpegCompressionEnabled">
  3412. <summary>
  3413. Gets or sets a flag indicating if the JPEG compression is enabled or not for the images in the generated pdf document.
  3414. </summary>
  3415. <remarks>
  3416. By default the JPEG compression is enabled to reduce the size of the generated pdf document. When the JPEG compression is enabled
  3417. the quality of the images in the generated pdf is lower than the quality of the original images from the web page,
  3418. and this quality depends on the <see cref="P:SelectPdf.PdfDocument.JpegCompressionLevel"/> parameter. When the <see cref="P:SelectPdf.PdfDocument.JpegCompressionLevel"/> is increased, the quality of the images in pdf decreases.
  3419. </remarks>
  3420. </member>
  3421. <member name="P:SelectPdf.PdfDocument.JpegCompressionLevel">
  3422. <summary>
  3423. Gets or sets the compression level of images in the generated pdf document.
  3424. </summary>
  3425. <remarks>
  3426. This property can take values between 0 and 100. It has effect only when the <see cref="P:SelectPdf.PdfDocument.JpegCompressionEnabled"/> is set to true.
  3427. When the <see cref="P:SelectPdf.PdfDocument.JpegCompressionLevel"/> is 0, the compression rate is the lowest and the quality of the images is the best.
  3428. When the <see cref="P:SelectPdf.PdfDocument.JpegCompressionLevel"/> is 100, the compression rate is the highest and quality of the images in PDF is the worst.
  3429. <para></para>
  3430. The default JPEG compression level is 10, which should offer a good balance between the compression rate and
  3431. the quality of the images in pdf.
  3432. </remarks>
  3433. </member>
  3434. <member name="T:SelectPdf.PdfDocumentInformation">
  3435. <summary>
  3436. This class provides the possibility to control the pdf document properties.
  3437. </summary>
  3438. <remarks>
  3439. Using this class, the pdf document properties (author, title, keywords, etc) can be controlled.
  3440. </remarks>
  3441. </member>
  3442. <member name="P:SelectPdf.PdfDocumentInformation.Title">
  3443. <summary>
  3444. Gets or sets the pdf document title.
  3445. </summary>
  3446. </member>
  3447. <member name="P:SelectPdf.PdfDocumentInformation.Author">
  3448. <summary>
  3449. Gets or sets the name of the pdf document author.
  3450. </summary>
  3451. </member>
  3452. <member name="P:SelectPdf.PdfDocumentInformation.Subject">
  3453. <summary>
  3454. Gets or sets the subject of the pdf document.
  3455. </summary>
  3456. </member>
  3457. <member name="P:SelectPdf.PdfDocumentInformation.Keywords">
  3458. <summary>
  3459. Gets or sets the pdf document keywords.
  3460. </summary>
  3461. </member>
  3462. <member name="P:SelectPdf.PdfDocumentInformation.Producer">
  3463. <summary>
  3464. Gets or sets the name of the application that generated the pdf document (Select.Pdf SDK).
  3465. </summary>
  3466. </member>
  3467. <member name="P:SelectPdf.PdfDocumentInformation.CreationDate">
  3468. <summary>
  3469. Gets or sets the date and time when the pdf document was created.
  3470. </summary>
  3471. </member>
  3472. <member name="T:SelectPdf.PdfDocumentOpenAction">
  3473. <summary>
  3474. Encapsulates an action to be performed when the pdf document is opened.
  3475. </summary>
  3476. <remarks>
  3477. The pdf document can perform 2 types of actions when it is opened:
  3478. <list type="bullet">
  3479. <item>
  3480. <description><see cref="T:SelectPdf.PdfActionGoTo"/> - The pdf document opens at a specific <see cref="T:SelectPdf.PdfDestination"/>.</description>
  3481. </item>
  3482. <item>
  3483. <description><see cref="T:SelectPdf.PdfActionJavaScript"/> - The pdf document will run a specific javascript.</description>
  3484. </item>
  3485. </list>
  3486. </remarks>
  3487. </member>
  3488. <member name="P:SelectPdf.PdfDocumentOpenAction.Action">
  3489. <summary>
  3490. The pdf document open action as an instance of the <see cref="T:SelectPdf.PdfActionGoTo"/> or <see cref="T:SelectPdf.PdfActionJavaScript"/> classes.
  3491. </summary>
  3492. </member>
  3493. <member name="T:SelectPdf.PdfFontCollection">
  3494. <summary>
  3495. Represents a collection of fonts in a pdf document.
  3496. </summary>
  3497. </member>
  3498. <member name="F:SelectPdf.PdfFontCollection.document">
  3499. <summary>
  3500. The parent PDF Document
  3501. </summary>
  3502. </member>
  3503. <member name="M:SelectPdf.PdfFontCollection.#ctor(SelectPdf.PdfDocument)">
  3504. <summary>
  3505. Creates a font collection for the specified PDF document
  3506. </summary>
  3507. <param name="document"></param>
  3508. </member>
  3509. <member name="M:SelectPdf.PdfFontCollection.GetEnumerator">
  3510. <summary>
  3511. Gets the collection enumerator.
  3512. </summary>
  3513. <returns>The collection enumerator.</returns>
  3514. </member>
  3515. <member name="M:SelectPdf.PdfFontCollection.Add(System.Drawing.Font)">
  3516. <summary>
  3517. Adds a system font to the pdf fonts collection.
  3518. </summary>
  3519. <remarks>
  3520. If the font was already added, the method returns the existing font.
  3521. By default the font is embedded into the pdf document in order to support Unicode texts.
  3522. </remarks>
  3523. <param name="font">The system font to be added to the fonts collection.</param>
  3524. <returns>The pdf font added to the fonts collection.</returns>
  3525. </member>
  3526. <member name="M:SelectPdf.PdfFontCollection.Add(System.Drawing.Font,System.Boolean)">
  3527. <summary>
  3528. Adds a system font to the pdf fonts collection.
  3529. </summary>
  3530. <remarks>
  3531. If the font was already added, the method returns the existing font. The <c>embedFont</c> parameter indicates if the added font
  3532. will be embedded into the pdf document or not.</remarks>
  3533. <param name="font">Font for adding.The system font to be added to the fonts collection.</param>
  3534. <param name="embedFont">Specifies if the font will be embedded into the pdf document or not.</param>
  3535. <returns>The pdf font added to the fonts collection.</returns>
  3536. </member>
  3537. <member name="M:SelectPdf.PdfFontCollection.Add(System.String)">
  3538. <summary>
  3539. Adds a system font to the pdf fonts collection. The font is loaded from the specified file.
  3540. </summary>
  3541. <remarks>
  3542. If the font was already added, the method returns the existing pdf font.
  3543. </remarks>
  3544. <param name="fontFileName">The file name of the font to be added.</param>
  3545. <returns>The pdf font added to the fonts collection.</returns>
  3546. </member>
  3547. <member name="M:SelectPdf.PdfFontCollection.Add(SelectPdf.PdfStandardFont)">
  3548. <summary>
  3549. Adds a standard font to the pdf fonts collection.
  3550. </summary>
  3551. <remarks>
  3552. If the font was already added, the method returns the existing pdf font.
  3553. </remarks>
  3554. <param name="stdFont">The standard font family.</param>
  3555. <returns>The pdf font added to the fonts collection.</returns>
  3556. </member>
  3557. <member name="M:SelectPdf.PdfFontCollection.Add(SelectPdf.PdfStandardCJKFont)">
  3558. <summary>
  3559. Adds a standard CJK font to the pdf fonts collection.
  3560. </summary>
  3561. <remarks>
  3562. If the font was already added, the method returns the existing pdf font.
  3563. </remarks>
  3564. <param name="stdCJKFont">The standard CJK font to add to the pdf document fonts collection.</param>
  3565. <returns>The pdf font added to the fonts collection.</returns>
  3566. </member>
  3567. <member name="M:SelectPdf.PdfFontCollection.Add(SelectPdf.PdfFont)">
  3568. <summary>
  3569. Adds a pdf font to the pdf fonts collection.
  3570. </summary>
  3571. <remarks>
  3572. If the font was already added, the method returns the existing pdf font.
  3573. </remarks>
  3574. <param name="font">The pdf font object to be add to the collection.</param>
  3575. <returns>The pdf font added to the fonts collection.</returns>
  3576. </member>
  3577. <member name="M:SelectPdf.PdfFontCollection.Add(SelectPdf.PdfFont[])">
  3578. <summary>
  3579. Adds the specified array of pdf fonts to the pdf document fonts collection.
  3580. </summary>
  3581. <param name="fonts">The pdf fonts to be added to the collection.</param>
  3582. </member>
  3583. <member name="M:SelectPdf.PdfFontCollection.Contains(SelectPdf.PdfFont)">
  3584. <summary>
  3585. Checks if the specified font belongs to the fonts collection.
  3586. </summary>
  3587. <param name="font">The specified pdf font.</param>
  3588. <returns>True if the font is found in the collection, otherwise returns false.</returns>
  3589. </member>
  3590. <member name="M:SelectPdf.PdfFontCollection.IndexOf(SelectPdf.PdfFont)">
  3591. <summary>
  3592. Returns the index of the specified font in the fonts collection.
  3593. </summary>
  3594. <param name="font">The font to search in collection.</param>
  3595. <returns>The index of font or -1 if the font does not exist.</returns>
  3596. </member>
  3597. <member name="M:SelectPdf.PdfFontCollection.Remove(SelectPdf.PdfFont)">
  3598. <summary>
  3599. Removes the specified pdf font from the fonts collection.
  3600. </summary>
  3601. <param name="font">The font to be removed from the pdf fonts collection.</param>
  3602. </member>
  3603. <member name="M:SelectPdf.PdfFontCollection.Insert(System.Int32,SelectPdf.PdfFont)">
  3604. <summary>
  3605. Inserts a font to the specified index in the pdf fonts collection.
  3606. </summary>
  3607. <param name="font">The font to be inserted in the collection.</param>
  3608. <param name="index">Index in collection where to insert the font.</param>
  3609. </member>
  3610. <member name="P:SelectPdf.PdfFontCollection.Item(System.Int32)">
  3611. <summary>
  3612. Gets or sets the font at the specified zero based index in the fonts collection.
  3613. </summary>
  3614. <param name="index">The zero based font index in the fonts pages collection.</param>
  3615. <returns>The pdf font at the specified index.</returns>
  3616. </member>
  3617. <member name="T:SelectPdf.PdfMargins">
  3618. <summary>
  3619. Represents the settings for a pdf page margins.
  3620. </summary>
  3621. </member>
  3622. <member name="M:SelectPdf.PdfMargins.#ctor">
  3623. <summary>
  3624. Initializes all margins with 0
  3625. </summary>
  3626. </member>
  3627. <member name="M:SelectPdf.PdfMargins.#ctor(System.Single)">
  3628. <summary>
  3629. Initializes all margins with the same value
  3630. </summary>
  3631. <param name="all">The value for all document margins.</param>
  3632. </member>
  3633. <member name="M:SelectPdf.PdfMargins.#ctor(System.Single,System.Single,System.Single,System.Single)">
  3634. <summary>
  3635. Default constructor initializes with 0 all the margins
  3636. </summary>
  3637. <param name="left">The left margin</param>
  3638. <param name="right">The right margin</param>
  3639. <param name="top">The top margin</param>
  3640. <param name="bottom">The bottom margin</param>
  3641. </member>
  3642. <member name="P:SelectPdf.PdfMargins.Empty">
  3643. <summary>
  3644. Empty margins object
  3645. </summary>
  3646. </member>
  3647. <member name="T:SelectPdf.PdfPageElement">
  3648. <summary>
  3649. The base class for all graphic elements from a pdf document.
  3650. </summary>
  3651. </member>
  3652. <member name="M:SelectPdf.PdfPageElement.Render(SelectPdf.PdfCanvas)">
  3653. <summary>
  3654. Renders the current pdf element on the specified canvas.
  3655. </summary>
  3656. <remarks>
  3657. The canvas can be a <see cref="T:SelectPdf.PdfPage"/> or a <see cref="T:SelectPdf.PdfTemplate"/>.
  3658. </remarks>
  3659. <param name="canvas">The canvas where the current pdf element will be rendered. Can be a pdf page or template.</param>
  3660. <returns>The result of adding the current pdf element to the specified canvas.</returns>
  3661. </member>
  3662. <member name="T:SelectPdf.PdfAction">
  3663. <summary>
  3664. Base class for the pdf actions.
  3665. </summary>
  3666. <remarks>
  3667. The pdf document can perform 2 types of actions when it is opened:
  3668. <list type="bullet">
  3669. <item>
  3670. <description><see cref="T:SelectPdf.PdfActionGoTo"/> - The pdf document opens at a specific <see cref="T:SelectPdf.PdfDestination"/>.</description>
  3671. </item>
  3672. <item>
  3673. <description><see cref="T:SelectPdf.PdfActionJavaScript"/> - The pdf document will run a specific javascript.</description>
  3674. </item>
  3675. </list>
  3676. </remarks>
  3677. </member>
  3678. <member name="T:SelectPdf.PdfActionGoTo">
  3679. <summary>
  3680. Represents a Go To action in a pdf document.
  3681. </summary>
  3682. </member>
  3683. <member name="M:SelectPdf.PdfActionGoTo.#ctor(SelectPdf.PdfDestination)">
  3684. <summary>
  3685. Creates a Go To action based on the specified pdf destination.
  3686. </summary>
  3687. <param name="destination">The destination of the Go To action.</param>
  3688. </member>
  3689. <member name="P:SelectPdf.PdfActionGoTo.Destination">
  3690. <summary>
  3691. Gets or sets the pdf destination of the Go To action.
  3692. </summary>
  3693. </member>
  3694. <member name="T:SelectPdf.PdfActionJavaScript">
  3695. <summary>
  3696. Represents a JavaScript action in a pdf document.
  3697. </summary>
  3698. </member>
  3699. <member name="M:SelectPdf.PdfActionJavaScript.#ctor(System.String)">
  3700. <summary>
  3701. Creates a JavaScript action based on a JavaScript code.
  3702. </summary>
  3703. <param name="javaScript">The JavaScript code.</param>
  3704. </member>
  3705. <member name="P:SelectPdf.PdfActionJavaScript.JavaScript">
  3706. <summary>
  3707. Gets or sets the JavaScript code executed by this action.
  3708. </summary>
  3709. </member>
  3710. <member name="T:SelectPdf.PdfColor">
  3711. <summary>
  3712. Represents a pdf color.
  3713. </summary>
  3714. </member>
  3715. <member name="M:SelectPdf.PdfColor.#ctor(System.Drawing.Color)">
  3716. <summary>
  3717. Creates a pdf color based on a .NET system color.
  3718. </summary>
  3719. <param name="color">The .NET system color.</param>
  3720. </member>
  3721. <member name="M:SelectPdf.PdfColor.#ctor(System.Single)">
  3722. <summary>
  3723. Creates a Gray-scale color based on a gray level.
  3724. </summary>
  3725. <param name="gray">A value between 0 and 1 to specify the gray level.</param>
  3726. </member>
  3727. <member name="M:SelectPdf.PdfColor.#ctor(System.Byte,System.Byte,System.Byte)">
  3728. <summary>
  3729. Creates a pdf color based on RGB values.
  3730. </summary>
  3731. <param name="red">Red value.</param>
  3732. <param name="green">Green value.</param>
  3733. <param name="blue">Blue value.</param>
  3734. </member>
  3735. <member name="M:SelectPdf.PdfColor.#ctor(System.Single,System.Single,System.Single,System.Single)">
  3736. <summary>
  3737. Creates a pdf color based on GMYK values.
  3738. </summary>
  3739. <param name="cyan">Cyan value.</param>
  3740. <param name="magenta">Magenta value.</param>
  3741. <param name="yellow">Yellow value.</param>
  3742. <param name="key">Key value.</param>
  3743. </member>
  3744. <member name="M:SelectPdf.PdfColor.op_Implicit(System.Drawing.Color)~SelectPdf.PdfColor">
  3745. <summary>
  3746. Implicit operator to convert a .NET system color to a pdf color.
  3747. </summary>
  3748. <param name="color">The .NET system color.</param>
  3749. <returns>The pdf color.</returns>
  3750. </member>
  3751. <member name="M:SelectPdf.PdfColor.op_Implicit(SelectPdf.PdfColor)~System.Drawing.Color">
  3752. <summary>
  3753. Implicit operator to convert a pdf color to a .NET system color.
  3754. </summary>
  3755. <param name="color">The pdf color.</param>
  3756. <returns>The .NET system color.</returns>
  3757. </member>
  3758. <member name="P:SelectPdf.PdfColor.Empty">
  3759. <summary>
  3760. An empty color.
  3761. </summary>
  3762. </member>
  3763. <member name="P:SelectPdf.PdfColor.Red">
  3764. <summary>
  3765. Gets or sets the Red value of this pdf color.
  3766. </summary>
  3767. </member>
  3768. <member name="P:SelectPdf.PdfColor.Blue">
  3769. <summary>
  3770. Gets or sets the Blue value of this pdf color.
  3771. </summary>
  3772. </member>
  3773. <member name="P:SelectPdf.PdfColor.Green">
  3774. <summary>
  3775. Gets or sets the Green value of this pdf color.
  3776. </summary>
  3777. </member>
  3778. <member name="P:SelectPdf.PdfColor.Gray">
  3779. <summary>
  3780. Gets or sets the Gray level of this pdf color.
  3781. </summary>
  3782. </member>
  3783. <member name="P:SelectPdf.PdfColor.Cyan">
  3784. <summary>
  3785. Gets or sets the Cyan value of this pdf color.
  3786. </summary>
  3787. </member>
  3788. <member name="P:SelectPdf.PdfColor.Magenta">
  3789. <summary>
  3790. Gets or sets the Magenta value of this pdf color.
  3791. </summary>
  3792. </member>
  3793. <member name="P:SelectPdf.PdfColor.Yellow">
  3794. <summary>
  3795. Gets or sets the Yellow value of this pdf color.
  3796. </summary>
  3797. </member>
  3798. <member name="P:SelectPdf.PdfColor.Key">
  3799. <summary>
  3800. Gets or sets the Key value of this pdf color.
  3801. </summary>
  3802. </member>
  3803. <member name="T:SelectPdf.PdfDocumentException">
  3804. <summary>
  3805. Exception thrown by the pdf document related objects.
  3806. </summary>
  3807. </member>
  3808. <member name="M:SelectPdf.PdfDocumentException.#ctor(System.String)">
  3809. <summary>
  3810. Constructor.
  3811. </summary>
  3812. <param name="message">The exception message.</param>
  3813. </member>
  3814. <member name="M:SelectPdf.PdfDocumentException.#ctor(System.String,System.Exception)">
  3815. <summary>
  3816. Constructor.
  3817. </summary>
  3818. <param name="message">The exception message.</param>
  3819. <param name="innerException">The inner exception that triggered this exception.</param>
  3820. </member>
  3821. <member name="T:SelectPdf.PdfFont">
  3822. <summary>
  3823. Represents a font in a pdf document.
  3824. </summary>
  3825. </member>
  3826. <member name="M:SelectPdf.PdfFont.GetCharWidth(System.Char)">
  3827. <summary>
  3828. Gets the width of the specified character in points.
  3829. </summary>
  3830. <param name="c">The character to be measured.</param>
  3831. <returns>The character width in points.</returns>
  3832. </member>
  3833. <member name="M:SelectPdf.PdfFont.GetTextWidth(System.String)">
  3834. <summary>
  3835. Get the width in points of the specified string.
  3836. </summary>
  3837. <param name="text">The string to be measured.</param>
  3838. <returns>The width of the string in points.</returns>
  3839. </member>
  3840. <member name="M:SelectPdf.PdfFont.GetTextSize(System.String)">
  3841. <summary>
  3842. Gets the size of the specified string in points.
  3843. </summary>
  3844. <param name="text">The string to be measured.</param>
  3845. <returns>The size of the string in points.</returns>
  3846. </member>
  3847. <member name="M:SelectPdf.PdfFont.GetSystemFont">
  3848. <summary>
  3849. Converts the current pdf font to a corresponding system font.
  3850. </summary>
  3851. <returns>A system font corresponding to the current pdf font object.</returns>
  3852. </member>
  3853. <member name="M:SelectPdf.PdfFont.Clone(SelectPdf.PdfDocument)">
  3854. <summary>
  3855. Creates a clone of this font in the specified pdf document.
  3856. </summary>
  3857. <param name="document">The pdf document where the font is cloned.</param>
  3858. <returns>The font object clone.</returns>
  3859. </member>
  3860. <member name="P:SelectPdf.PdfFont.FontFamily">
  3861. <summary>
  3862. Gets the name of the font family.
  3863. </summary>
  3864. </member>
  3865. <member name="P:SelectPdf.PdfFont.Height">
  3866. <summary>
  3867. Gets the font height.
  3868. </summary>
  3869. </member>
  3870. <member name="P:SelectPdf.PdfFont.Size">
  3871. <summary>
  3872. Gets or sets the font size in points.
  3873. </summary>
  3874. </member>
  3875. <member name="P:SelectPdf.PdfFont.FontBaseFamily">
  3876. <summary>
  3877. Gets the predefined family name.
  3878. </summary>
  3879. </member>
  3880. <member name="P:SelectPdf.PdfFont.IsUnderline">
  3881. <summary>
  3882. A flag to indicate if the font is underline.
  3883. </summary>
  3884. </member>
  3885. <member name="P:SelectPdf.PdfFont.IsStrikeout">
  3886. <summary>
  3887. A flag to indicate if the font is strikeout.
  3888. </summary>
  3889. </member>
  3890. <member name="T:SelectPdf.PdfPage">
  3891. <summary>
  3892. Represents a page in a pdf document.
  3893. </summary>
  3894. </member>
  3895. <member name="M:SelectPdf.PdfPage.Add(SelectPdf.PdfPageElement)">
  3896. <summary>
  3897. Adds the specified pdf element to the current page.
  3898. </summary>
  3899. <param name="element">The element to be added to the current pdf page.</param>
  3900. <returns>The result of adding the element to the page.</returns>
  3901. </member>
  3902. <member name="P:SelectPdf.PdfPage.Orientation">
  3903. <summary>
  3904. Pdf page orientation.
  3905. </summary>
  3906. <remarks>The default page orientation is <see cref="F:SelectPdf.PdfPageOrientation.Portrait"/>.
  3907. </remarks>
  3908. </member>
  3909. <member name="P:SelectPdf.PdfPage.Rotation">
  3910. <summary>
  3911. Pdf page rotation.
  3912. </summary>
  3913. <remarks>
  3914. The pdf page can be rotated with 90, 180 or 270 degrees from the original position.
  3915. </remarks>
  3916. </member>
  3917. <member name="P:SelectPdf.PdfPage.CustomHeader">
  3918. <summary>
  3919. Represents the custom header template for the pdf page.
  3920. </summary>
  3921. <remarks>It will replace the default pdf document header template specified by <see cref="P:SelectPdf.PdfDocument.Header"/>.</remarks>
  3922. </member>
  3923. <member name="P:SelectPdf.PdfPage.CustomFooter">
  3924. <summary>
  3925. Represents the custom footer template for the pdf page.
  3926. </summary>
  3927. <remarks>It will replace the default pdf document footer template specified by <see cref="P:SelectPdf.PdfDocument.Footer"/>.</remarks>
  3928. </member>
  3929. <member name="P:SelectPdf.PdfPage.DisplayHeader">
  3930. <summary>
  3931. Controls if a custom header is displayed in the current pdf page.
  3932. </summary>
  3933. </member>
  3934. <member name="P:SelectPdf.PdfPage.DisplayFooter">
  3935. <summary>
  3936. Controls if a custom footer is displayed in the current pdf page.
  3937. </summary>
  3938. </member>
  3939. <member name="P:SelectPdf.PdfPage.Margins">
  3940. <summary>
  3941. Gets the pdf page margins.
  3942. </summary>
  3943. </member>
  3944. <member name="P:SelectPdf.PdfPage.PageSize">
  3945. <summary>
  3946. Gets the pdf page size in points.
  3947. </summary>
  3948. </member>
  3949. <member name="P:SelectPdf.PdfPage.Document">
  3950. <summary>
  3951. The parent pdf document of the current page.
  3952. </summary>
  3953. </member>
  3954. <member name="P:SelectPdf.PdfPage.PageIndex">
  3955. <summary>
  3956. The index of the current page in the pdf pages collection.
  3957. </summary>
  3958. </member>
  3959. <member name="T:SelectPdf.PdfRenderingResult">
  3960. <summary>
  3961. The result of adding a pdf element to a pdf page or template.
  3962. </summary>
  3963. </member>
  3964. <member name="F:SelectPdf.PdfRenderingResult.pageIndex">
  3965. <summary>
  3966. The end page index
  3967. </summary>
  3968. </member>
  3969. <member name="F:SelectPdf.PdfRenderingResult.pageBounds">
  3970. <summary>
  3971. The bounds inside the end page
  3972. </summary>
  3973. </member>
  3974. <member name="M:SelectPdf.PdfRenderingResult.#ctor">
  3975. <summary>
  3976. Construct a PdfRenderingResult object with no page information
  3977. </summary>
  3978. </member>
  3979. <member name="M:SelectPdf.PdfRenderingResult.#ctor(System.Int32,System.Drawing.RectangleF)">
  3980. <summary>
  3981. Constructs PdfRenderingResult object based on the page index and the bounds
  3982. inside the page where the element rendering ended.
  3983. </summary>
  3984. <param name="endPageIndex"></param>
  3985. <param name="endPageBounds"></param>
  3986. </member>
  3987. <member name="P:SelectPdf.PdfRenderingResult.PdfPageLastIndex">
  3988. <summary>
  3989. The index of the pdf page where the rendering of the page element ended.
  3990. </summary>
  3991. <remarks>
  3992. This information is useful when other pdf elements are added to the <see cref="T:SelectPdf.PdfDocument"/> object.
  3993. </remarks>
  3994. </member>
  3995. <member name="P:SelectPdf.PdfRenderingResult.PdfPageLastRectangle">
  3996. <summary>
  3997. The bounds inside the pdf page where the rendering of the page element ended.
  3998. </summary>
  3999. <remarks>
  4000. This information is useful when other pdf elements are added to the <see cref="T:SelectPdf.PdfDocument"/> object.
  4001. <para>
  4002. Note: The last page is specified by the <see cref="P:SelectPdf.PdfRenderingResult.PdfPageLastIndex"/> property.
  4003. </para>
  4004. </remarks>
  4005. </member>
  4006. <member name="T:SelectPdf.PdfTemplateAnchoring">
  4007. <summary>
  4008. The anchoring position of a pdf template.
  4009. </summary>
  4010. </member>
  4011. <member name="F:SelectPdf.PdfTemplateAnchoring.NotAnchored">
  4012. <summary>
  4013. The template is not anchored.
  4014. </summary>
  4015. </member>
  4016. <member name="F:SelectPdf.PdfTemplateAnchoring.Center">
  4017. <summary>
  4018. The template will be anchored in the center of the pdf page.
  4019. </summary>
  4020. <remarks>
  4021. The center of the template rectangle will be same with the center of the page.
  4022. </remarks>
  4023. </member>
  4024. <member name="F:SelectPdf.PdfTemplateAnchoring.TopLeft">
  4025. <summary>
  4026. The template will be anchored in the top left corner of the pdf page.
  4027. </summary>
  4028. <remarks>
  4029. The template location will be the top left corner of the page.
  4030. </remarks>
  4031. </member>
  4032. <member name="F:SelectPdf.PdfTemplateAnchoring.TopRight">
  4033. <summary>
  4034. The template will be anchored in the top right corner of the pdf page.
  4035. </summary>
  4036. <remarks>
  4037. The right side of the template will be aligned with the right side of the page,
  4038. and the top side of the template will be aligned with the top side of the page
  4039. </remarks>
  4040. </member>
  4041. <member name="F:SelectPdf.PdfTemplateAnchoring.BottomLeft">
  4042. <summary>
  4043. The template will be anchored in the bottom left corner of the pdf page.
  4044. </summary>
  4045. <remarks>
  4046. The left side of the template will be aligned with the left side of the
  4047. page and the bottom side of the document will be aligned with the bottom
  4048. side of the page.
  4049. </remarks>
  4050. </member>
  4051. <member name="F:SelectPdf.PdfTemplateAnchoring.BottomRight">
  4052. <summary>
  4053. The template will be anchored in the bottom left corner of the pdf page.
  4054. </summary>
  4055. <remarks>
  4056. The right side of the document will be aligned with the right side of the
  4057. pdf page and the bottom side of the document will be aligned with the bottom
  4058. side of the PDF page
  4059. </remarks>
  4060. </member>
  4061. <member name="T:SelectPdf.PdfTemplateCollection">
  4062. <summary>
  4063. Represents the collection of pages in a pdf document. A pdf template is repeated on each page of the pdf document.
  4064. </summary>
  4065. </member>
  4066. <member name="M:SelectPdf.PdfTemplateCollection.GetEnumerator">
  4067. <summary>
  4068. Gets the collection enumerator.
  4069. </summary>
  4070. <returns>The collection enumerator.</returns>
  4071. </member>
  4072. <member name="M:SelectPdf.PdfTemplateCollection.Add(System.Single,System.Single)">
  4073. <summary>
  4074. Adds a new template with the specified width and height to the pdf document templates collection.
  4075. </summary>
  4076. <remarks>
  4077. The template location is top left corner of the pdf page. Use <see cref="M:SelectPdf.PdfTemplateCollection.Add(System.Drawing.RectangleF)"/> to specify another location for the template.
  4078. </remarks>
  4079. <param name="width">The pdf template width.</param>
  4080. <param name="height">The pdf template height.</param>
  4081. <returns>The newly added pdf template.</returns>
  4082. </member>
  4083. <member name="M:SelectPdf.PdfTemplateCollection.Add(System.Drawing.RectangleF)">
  4084. <summary>
  4085. Adds a new template with the specified bounds to the pdf document templates collection.
  4086. </summary>
  4087. <param name="bounds">The template element bounds.</param>
  4088. <returns>The newly added pdf template.</returns>
  4089. </member>
  4090. <member name="P:SelectPdf.PdfTemplateCollection.Item(System.Int32)">
  4091. <summary>
  4092. Gets or sets the template at the specified zero based index in the templates collection.
  4093. </summary>
  4094. <param name="index">The zero based template index in the pdf templates collection.</param>
  4095. <returns>The pdf template at the specified index.</returns>
  4096. </member>
  4097. <member name="P:SelectPdf.PdfTemplateCollection.Count">
  4098. <summary>
  4099. The number of templates in pdf templates collection.
  4100. </summary>
  4101. </member>
  4102. <member name="P:SelectPdf.PdfTemplateCollection.Header">
  4103. <summary>
  4104. Represents the default pdf document header template.
  4105. </summary>
  4106. <remarks>
  4107. The header space is automatically taken into account when calculating the available space for rendering in a pdf page.
  4108. <para></para>
  4109. This template is automatically docked to the top of the pdf page.</remarks>
  4110. </member>
  4111. <member name="P:SelectPdf.PdfTemplateCollection.Footer">
  4112. <summary>
  4113. Represents the default pdf document footer template.
  4114. </summary>
  4115. <remarks>
  4116. The footer space is automatically taken into account when calculating the available space for rendering in a pdf page.
  4117. <para></para>
  4118. This template is automatically docked to the bottom of the pdf page.</remarks>
  4119. </member>
  4120. <member name="T:SelectPdf.PdfTemplateDocking">
  4121. <summary>
  4122. The docking style of a pdf template.
  4123. </summary>
  4124. </member>
  4125. <member name="F:SelectPdf.PdfTemplateDocking.NotDocked">
  4126. <summary>
  4127. The template is not docked in the pdf page.
  4128. </summary>
  4129. </member>
  4130. <member name="F:SelectPdf.PdfTemplateDocking.Top">
  4131. <summary>
  4132. The template is docked to the top of the pdf page.
  4133. </summary>
  4134. <remarks>
  4135. The template width and location will be adjusted for docking.
  4136. </remarks>
  4137. </member>
  4138. <member name="F:SelectPdf.PdfTemplateDocking.Bottom">
  4139. <summary>
  4140. The template is docked to the bottom of the pdf page.
  4141. </summary>
  4142. <remarks>
  4143. The template width and location will be adjusted for docking.
  4144. </remarks>
  4145. </member>
  4146. <member name="F:SelectPdf.PdfTemplateDocking.Left">
  4147. <summary>
  4148. The template is docked to the left of the pdf page.
  4149. </summary>
  4150. <remarks>
  4151. The template location and height will be adjusted for docking.
  4152. </remarks>
  4153. </member>
  4154. <member name="F:SelectPdf.PdfTemplateDocking.Right">
  4155. <summary>
  4156. The template is docked to the right of the pdf page.
  4157. </summary>
  4158. <remarks>
  4159. The template location and height will be adjusted for docking.
  4160. </remarks>
  4161. </member>
  4162. <member name="F:SelectPdf.PdfTemplateDocking.Fill">
  4163. <summary>
  4164. The template fills the pdf page.
  4165. </summary>
  4166. <remarks>
  4167. The template location will be the top left corner and the size will be the size of the pdf page. The docking
  4168. will take into account the existing document docked templates (like header, footer).
  4169. </remarks>
  4170. </member>
  4171. <member name="T:SelectPdf.PdfTextSection">
  4172. <summary>
  4173. Represents a text that can be added to the header or footer templates of a pdf document.
  4174. </summary>
  4175. </member>
  4176. <member name="F:SelectPdf.PdfTextSection.text">
  4177. <summary>
  4178. The string to be written
  4179. </summary>
  4180. </member>
  4181. <member name="F:SelectPdf.PdfTextSection.x">
  4182. <summary>
  4183. The start x position
  4184. </summary>
  4185. </member>
  4186. <member name="F:SelectPdf.PdfTextSection.y">
  4187. <summary>
  4188. The start y position
  4189. </summary>
  4190. </member>
  4191. <member name="F:SelectPdf.PdfTextSection.width">
  4192. <summary>
  4193. The width of destination rectangle
  4194. </summary>
  4195. </member>
  4196. <member name="F:SelectPdf.PdfTextSection.height">
  4197. <summary>
  4198. The height of the destination rectangle
  4199. Is optional
  4200. </summary>
  4201. </member>
  4202. <member name="F:SelectPdf.PdfTextSection.font">
  4203. <summary>
  4204. The text font
  4205. </summary>
  4206. </member>
  4207. <member name="F:SelectPdf.PdfTextSection.multiPageText">
  4208. <summary>
  4209. When true a paginable text is rendered
  4210. </summary>
  4211. </member>
  4212. <member name="F:SelectPdf.PdfTextSection.paginate">
  4213. <summary>
  4214. When true the text can be paginated
  4215. </summary>
  4216. </member>
  4217. <member name="F:SelectPdf.PdfTextSection.textAlign">
  4218. <summary>
  4219. Horizontal text alignment.
  4220. </summary>
  4221. </member>
  4222. <member name="F:SelectPdf.PdfTextSection.verticalTextAlign">
  4223. <summary>
  4224. Vertical text alignment.
  4225. </summary>
  4226. </member>
  4227. <member name="F:SelectPdf.PdfTextSection.rightToLeft">
  4228. <summary>
  4229. Indicates whether RTL should be checked.
  4230. </summary>
  4231. </member>
  4232. <member name="F:SelectPdf.PdfTextSection.characterSpacing">
  4233. <summary>
  4234. Character spacing value.
  4235. </summary>
  4236. </member>
  4237. <member name="F:SelectPdf.PdfTextSection.wordSpacing">
  4238. <summary>
  4239. Word spacing value.
  4240. </summary>
  4241. </member>
  4242. <member name="F:SelectPdf.PdfTextSection.leading">
  4243. <summary>
  4244. Text leading.
  4245. </summary>
  4246. </member>
  4247. <member name="M:SelectPdf.PdfTextSection.#ctor(System.Single,System.Single,System.String,System.Drawing.Font)">
  4248. <summary>
  4249. Creates a text object that can be added to the header or footer templates of a pdf document.
  4250. </summary>
  4251. <remarks>
  4252. The text element that will be rendered at the specified (x,y) position in the pdf header or footer using the specified font.
  4253. The height of the rendered text will be auto-determined. The width is the available width in page.
  4254. </remarks>
  4255. <param name="x">The start X coordinate where the text will be rendered.</param>
  4256. <param name="y">The start Y coordinate where the text will be rendered.</param>
  4257. <param name="text">The text to be rendered.</param>
  4258. <param name="font">The text font.</param>
  4259. </member>
  4260. <member name="M:SelectPdf.PdfTextSection.#ctor(System.Single,System.Single,System.Single,System.String,System.Drawing.Font)">
  4261. <summary>
  4262. Creates a text object that can be added to the header or footer templates of a pdf document.
  4263. </summary>
  4264. <remarks>
  4265. The text element that will be rendered at the specified (x,y) position in the pdf header or footer using the specified font.
  4266. The width of the text is specified as parameter. The height of the rendered text will be auto-determined.
  4267. </remarks>
  4268. <param name="x">The start X coordinate where the text will be rendered.</param>
  4269. <param name="y">The start Y coordinate where the text will be rendered.</param>
  4270. <param name="width">The width of the destination rectangle.</param>
  4271. <param name="text">The text to be rendered.</param>
  4272. <param name="font">The text font.</param>
  4273. </member>
  4274. <member name="M:SelectPdf.PdfTextSection.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Drawing.Font)">
  4275. <summary>
  4276. Creates a text object that can be added to the header or footer templates of a pdf document.
  4277. </summary>
  4278. <remarks>
  4279. The text element that will be rendered at the specified (x,y) position in the pdf header or footer using the specified font.
  4280. The width and height of the text on the destination page are also specified.
  4281. </remarks>
  4282. <param name="x">The start X coordinate where the text will be rendered.</param>
  4283. <param name="y">The start Y coordinate where the text will be rendered.</param>
  4284. <param name="width">The width of the destination rectangle.</param>
  4285. <param name="height">The height of the destination rectangle.</param>
  4286. <param name="text">The text to be rendered.</param>
  4287. <param name="font">The text font.</param>
  4288. </member>
  4289. <member name="M:SelectPdf.PdfTextSection.#ctor(System.Single,System.Single,System.Single,System.String,System.Drawing.Font,System.Drawing.Color)">
  4290. <summary>
  4291. Creates a text object that can be added to the header or footer templates of a pdf document.
  4292. </summary>
  4293. <remarks>
  4294. The text element that will be rendered at the specified (x,y) position in the pdf header or footer using the specified font and color.
  4295. The width of the text is specified as parameter. The height of the rendered text will be auto-determined.
  4296. </remarks>
  4297. <param name="x">The start X coordinate where the text will be rendered.</param>
  4298. <param name="y">The start Y coordinate where the text will be rendered.</param>
  4299. <param name="width">The width of the destination rectangle.</param>
  4300. <param name="text">The text to be rendered.</param>
  4301. <param name="font">The text font.</param>
  4302. <param name="color">The text color.</param>
  4303. </member>
  4304. <member name="M:SelectPdf.PdfTextSection.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Drawing.Font,System.Drawing.Color)">
  4305. <summary>
  4306. Creates a text object that can be added to the header or footer templates of a pdf document.
  4307. </summary>
  4308. <remarks>
  4309. The text element that will be rendered at the specified (x,y) position in the pdf header or footer using the specified font and color.
  4310. The width and height of the text on the destination page are also specified.
  4311. </remarks>
  4312. <param name="x">The start X coordinate where the text will be rendered.</param>
  4313. <param name="y">The start Y coordinate where the text will be rendered.</param>
  4314. <param name="width">The width of the destination rectangle.</param>
  4315. <param name="height">The height of the destination rectangle.</param>
  4316. <param name="text">The text to be rendered.</param>
  4317. <param name="font">The text font.</param>
  4318. <param name="color">The text color.</param>
  4319. </member>
  4320. <member name="P:SelectPdf.PdfTextSection.HorizontalAlign">
  4321. <summary>
  4322. Gets or sets the horizontal text alignment.
  4323. </summary>
  4324. </member>
  4325. <member name="P:SelectPdf.PdfTextSection.VerticalAlign">
  4326. <summary>
  4327. Gets or sets the vertical text alignment.
  4328. </summary>
  4329. </member>
  4330. <member name="P:SelectPdf.PdfTextSection.RightToLeft">
  4331. <summary>
  4332. Indicates if the text is in a right-to-left language.
  4333. </summary>
  4334. </member>
  4335. <member name="P:SelectPdf.PdfTextSection.CharacterSpacing">
  4336. <summary>
  4337. Gets or sets an additional spacing between characters.
  4338. </summary>
  4339. </member>
  4340. <member name="P:SelectPdf.PdfTextSection.WordSpacing">
  4341. <summary>
  4342. Gets or sets an additional space between words.
  4343. </summary>
  4344. <remarks>The words separator is consider the space character with code 32.</remarks>
  4345. </member>
  4346. <member name="P:SelectPdf.PdfTextSection.Leading">
  4347. <summary>
  4348. Gets or sets a value that indicates the vertical distance between the baselines of adjacent lines of text.
  4349. </summary>
  4350. </member>
  4351. <member name="P:SelectPdf.PdfTextSection.Direction">
  4352. <summary>
  4353. Gets or sets an angle to control the text direction.
  4354. </summary>
  4355. <remarks>
  4356. The default value is 0. Adding a value in degrees will rotate the text counter-clockwise.
  4357. </remarks>
  4358. </member>
  4359. <member name="P:SelectPdf.PdfTextSection.TextRise">
  4360. <summary>
  4361. Gets or sets the distance to move the text baseline up or down from its default location.
  4362. </summary>
  4363. <remarks>
  4364. Adjustments to the baseline are useful for drawing superscripts or subscripts.
  4365. <para></para>
  4366. Positive values of text rise move the baseline up and creates a superscript text.
  4367. <para></para>
  4368. Negative values of text rise move the baseline down and creates a subscript text.
  4369. </remarks>
  4370. </member>
  4371. <member name="P:SelectPdf.PdfTextSection.BackColor">
  4372. <summary>
  4373. Gets or sets the element background color.
  4374. </summary>
  4375. </member>
  4376. <member name="P:SelectPdf.PdfTextSection.ForeColor">
  4377. <summary>
  4378. Gets or sets the element foreground color.
  4379. </summary>
  4380. </member>
  4381. <member name="P:SelectPdf.PdfTextSection.Text">
  4382. <summary>
  4383. The text string that will be added to the pdf document header or footer.
  4384. </summary>
  4385. <remarks>
  4386. If <c>{page_number}</c> placeholder appears in this property, it will be replaced with the current pdf page number.
  4387. By default the page numbering starts with 1. This can be changed using the <see cref="P:SelectPdf.PdfFooter.FirstPageNumber"/> property.
  4388. <para></para>
  4389. <para></para>
  4390. If <c>{total_pages}</c> placeholder appears in this property, it will be replaced with the total number of pages in the generated pdf document.
  4391. The total number of pages can be incremented with a value specified by the <see cref="P:SelectPdf.PdfFooter.TotalPagesOffset"/> property.
  4392. This could be useful when the generated pdf will be merged with other documents.
  4393. </remarks>
  4394. </member>
  4395. <member name="P:SelectPdf.PdfTextSection.X">
  4396. <summary>
  4397. Gets or sets the text start position on the X axis.
  4398. </summary>
  4399. </member>
  4400. <member name="P:SelectPdf.PdfTextSection.Y">
  4401. <summary>
  4402. Gets or sets the text start position on the Y axis.
  4403. </summary>
  4404. </member>
  4405. <member name="P:SelectPdf.PdfTextSection.Width">
  4406. <summary>
  4407. The width of destination rectangle where the text will be rendered.
  4408. </summary>
  4409. </member>
  4410. <member name="P:SelectPdf.PdfTextSection.Height">
  4411. <summary>
  4412. The height of the destination rectangle where the text will be rendered.
  4413. </summary>
  4414. </member>
  4415. <member name="P:SelectPdf.PdfTextSection.Font">
  4416. <summary>
  4417. The text font.
  4418. </summary>
  4419. </member>
  4420. <member name="P:SelectPdf.PdfTextSection.EmbedFont">
  4421. <summary>
  4422. A flag indicating if the text font will be embedded in the pdf document.
  4423. </summary>
  4424. </member>
  4425. <member name="P:SelectPdf.PdfTextSection.Transparency">
  4426. <summary>
  4427. Gets or sets the pdf element transparency.
  4428. </summary>
  4429. <remarks>The transparency is expressed as a value between 0 and 100.
  4430. <para></para>
  4431. The value 0 means completely transparent and 100 means completely opaque.
  4432. </remarks>
  4433. </member>
  4434. <member name="T:SelectPdf.PdfViewerPreferences">
  4435. <summary>
  4436. The pdf viewer preferences. Controls how the pdf document appears in a pdf viewer (like Adobe Reader).
  4437. </summary>
  4438. </member>
  4439. <member name="P:SelectPdf.PdfViewerPreferences.HideToolbar">
  4440. <summary>
  4441. Gets or sets a flag specifying whether to hide the pdf viewer application's tool bars when the document is active.
  4442. </summary>
  4443. <remarks>
  4444. The default value for this property is false.
  4445. </remarks>
  4446. </member>
  4447. <member name="P:SelectPdf.PdfViewerPreferences.HideMenuBar">
  4448. <summary>
  4449. Gets or sets a flag specifying whether to hide the pdf viewer application's menu bar when the document is active.
  4450. </summary>
  4451. <remarks>
  4452. The default value for this property is false.
  4453. </remarks>
  4454. </member>
  4455. <member name="P:SelectPdf.PdfViewerPreferences.HideWindowUI">
  4456. <summary>
  4457. Gets or sets a flag specifying whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.
  4458. </summary>
  4459. <remarks>
  4460. The default value for this property is false.
  4461. </remarks>
  4462. </member>
  4463. <member name="P:SelectPdf.PdfViewerPreferences.FitWindow">
  4464. <summary>
  4465. Gets or sets a flag specifying whether to resize the document's window to fit the size of the first displayed page.
  4466. </summary>
  4467. <remarks>
  4468. The default value for this property is false.
  4469. </remarks>
  4470. </member>
  4471. <member name="P:SelectPdf.PdfViewerPreferences.CenterWindow">
  4472. <summary>
  4473. Gets or sets a flag specifying whether to position the document's window in the center of the screen.
  4474. </summary>
  4475. <remarks>
  4476. The default value for this property is false.
  4477. </remarks>
  4478. </member>
  4479. <member name="P:SelectPdf.PdfViewerPreferences.DisplayDocTitle">
  4480. <summary>
  4481. Gets or sets a flag specifying whether the window's title bar should display the document title.
  4482. </summary>
  4483. <remarks>
  4484. The default value for this property is false.
  4485. </remarks>
  4486. </member>
  4487. <member name="P:SelectPdf.PdfViewerPreferences.NonFullScreenPageMode">
  4488. <summary>
  4489. Gets or sets the document page mode when the pdf viewer application exits the full screen mode.
  4490. </summary>
  4491. <remarks>
  4492. This property is taken into account only if <see cref="P:SelectPdf.PdfViewerPreferences.PageMode"/> is set to <see cref="F:SelectPdf.PdfViewerPageMode.FullScreen"/>. Otherwise it is ignored.
  4493. <para>
  4494. The default value for this property is <see cref="F:SelectPdf.PdfViewerFullScreenExitMode.UseNone"/>.
  4495. </para>
  4496. </remarks>
  4497. </member>
  4498. <member name="P:SelectPdf.PdfViewerPreferences.PageMode">
  4499. <summary>
  4500. Gets or sets the document page mode when the pdf document is opened in a pdf viewer.
  4501. </summary>
  4502. <remarks>
  4503. The default value for this property is <see cref="F:SelectPdf.PdfViewerPageMode.UseNone"/>.
  4504. </remarks>
  4505. </member>
  4506. <member name="P:SelectPdf.PdfViewerPreferences.PageLayout">
  4507. <summary>
  4508. Gets or sets the page layout to be used when the document is opened.
  4509. </summary>
  4510. <remarks>
  4511. The default value for this property is <see cref="F:SelectPdf.PdfViewerPageLayout.OneColumn"/>.
  4512. </remarks>
  4513. </member>
  4514. <member name="T:SelectPdf.PdfFontType">
  4515. <summary>
  4516. The list of supported fonts for the header and footer
  4517. </summary>
  4518. </member>
  4519. <member name="F:SelectPdf.PdfFontType.None">
  4520. <summary>
  4521. None
  4522. </summary>
  4523. </member>
  4524. <member name="F:SelectPdf.PdfFontType.Helvetica">
  4525. <summary>
  4526. Helvetica
  4527. </summary>
  4528. </member>
  4529. <member name="F:SelectPdf.PdfFontType.HelveticaBold">
  4530. <summary>
  4531. HelveticaBold
  4532. </summary>
  4533. </member>
  4534. <member name="F:SelectPdf.PdfFontType.HelveticaOblique">
  4535. <summary>
  4536. HelveticaOblique
  4537. </summary>
  4538. </member>
  4539. <member name="F:SelectPdf.PdfFontType.HelvetivaBoldOblique">
  4540. <summary>
  4541. HelvetivaBoldOblique
  4542. </summary>
  4543. </member>
  4544. <member name="F:SelectPdf.PdfFontType.Courier">
  4545. <summary>
  4546. Courier
  4547. </summary>
  4548. </member>
  4549. <member name="F:SelectPdf.PdfFontType.CourierBold">
  4550. <summary>
  4551. CourierBold
  4552. </summary>
  4553. </member>
  4554. <member name="F:SelectPdf.PdfFontType.CourierOblique">
  4555. <summary>
  4556. CourierOblique
  4557. </summary>
  4558. </member>
  4559. <member name="F:SelectPdf.PdfFontType.CourierBoldOblique">
  4560. <summary>
  4561. CourierBoldOblique
  4562. </summary>
  4563. </member>
  4564. <member name="F:SelectPdf.PdfFontType.TimesRoman">
  4565. <summary>
  4566. TimesRoman
  4567. </summary>
  4568. </member>
  4569. <member name="F:SelectPdf.PdfFontType.TimesBold">
  4570. <summary>
  4571. TimesBold
  4572. </summary>
  4573. </member>
  4574. <member name="F:SelectPdf.PdfFontType.TimesBoldItalic">
  4575. <summary>
  4576. TimesBoldItalic
  4577. </summary>
  4578. </member>
  4579. <member name="F:SelectPdf.PdfFontType.TimesItalic">
  4580. <summary>
  4581. TimesItalic
  4582. </summary>
  4583. </member>
  4584. <member name="F:SelectPdf.PdfFontType.Symbol">
  4585. <summary>
  4586. Symbol
  4587. </summary>
  4588. </member>
  4589. <member name="F:SelectPdf.PdfFontType.ZapfDingbats">
  4590. <summary>
  4591. ZapfDingbats
  4592. </summary>
  4593. </member>
  4594. <member name="T:SelectPdf.PdfFooter">
  4595. <summary>
  4596. Handles the properties of the footer of the generated pdf document.
  4597. </summary>
  4598. <remarks>
  4599. This class encapsulates the options to control the footer in the rendered pdf document. The <see cref="T:SelectPdf.HtmlToPdf"/> class contains a
  4600. reference to an object of this type.
  4601. <para></para>
  4602. The footer is displayed only if <see cref="P:SelectPdf.HtmlToPdfOptions.DisplayFooter"/> property of the <see cref="P:SelectPdf.HtmlToPdf.Options"/> object is true.
  4603. If the <see cref="P:SelectPdf.HtmlToPdfOptions.DisplayFooter"/> property of the <see cref="P:SelectPdf.HtmlToPdf.Options"/>
  4604. object is false, the footer will not be displayed and all the options set here will have no effect.
  4605. </remarks>
  4606. </member>
  4607. <member name="M:SelectPdf.PdfFooter.Add(SelectPdf.PdfSectionElement)">
  4608. <summary>
  4609. Adds an additional element to the footer of the pdf document.
  4610. </summary>
  4611. <remarks>
  4612. There are 3 section elements that can be added to the footer of the pdf document: <see cref="T:SelectPdf.PdfHtmlSection"/>, <see cref="T:SelectPdf.PdfTextSection"/> and <see cref="T:SelectPdf.PdfImageSection"/>.
  4613. </remarks>
  4614. <param name="element">The element that will be rendered in the pdf footer.</param>
  4615. </member>
  4616. <member name="M:SelectPdf.PdfFooter.AddTextArea(SelectPdf.PdfTextSection)">
  4617. <summary>
  4618. Adds a TextArea element to the additional elements list rendered after the
  4619. predefined footer elements. The additional elements are rendered in the order they
  4620. are added to the list.
  4621. </summary>
  4622. <param name="textArea">The TextArea object to be rendered.</param>
  4623. </member>
  4624. <member name="M:SelectPdf.PdfFooter.AddImageArea(SelectPdf.PdfImageSection)">
  4625. <summary>
  4626. Adds an ImageArea element to the additional elements list rendered after the
  4627. predefined footer elements. The additional elements are rendered in the order they
  4628. are added to the list.
  4629. </summary>
  4630. <param name="imageArea">The ImageArea object to be rendered.</param>
  4631. </member>
  4632. <member name="M:SelectPdf.PdfFooter.AddHtmlToPdfArea(SelectPdf.PdfHtmlSection)">
  4633. <summary>
  4634. Adds a PdfHtmlSection element to the additional elements list rendered after the
  4635. predefined footer elements. The additional elements are rendered in the order they
  4636. are added to the list.
  4637. </summary>
  4638. <param name="htmlArea">The PdfHtmlSection object to be rendered.</param>
  4639. </member>
  4640. <member name="P:SelectPdf.PdfFooter.Height">
  4641. <summary>
  4642. The height of the pdf document footer.
  4643. </summary>
  4644. <remarks>
  4645. This height is specified in points. 1 point is 1/72 inch. The default value is 35pt.
  4646. </remarks>
  4647. </member>
  4648. <member name="P:SelectPdf.PdfFooter.FirstPageNumber">
  4649. <summary>
  4650. Controls the page number for the first page being rendered.
  4651. </summary>
  4652. <remarks>
  4653. The page number is displayed setting a <c>{page_number}</c> placeholder in the <see cref="P:SelectPdf.PdfTextSection.Text"/> property.
  4654. By default the page numbers start with 1. This can be changed using the <see cref="P:SelectPdf.PdfFooter.FirstPageNumber"/> property.
  4655. </remarks>
  4656. </member>
  4657. <member name="P:SelectPdf.PdfFooter.TotalPagesOffset">
  4658. <summary>
  4659. Controls the total number of pages offset in the generated pdf document.
  4660. </summary>
  4661. <remarks>
  4662. The total number of pages is displayed setting a <c>{total_pages}</c> placeholder in the <see cref="P:SelectPdf.PdfTextSection.Text"/> property.
  4663. The total number of pages can be incremented with a value specified by the <see cref="P:SelectPdf.PdfFooter.TotalPagesOffset"/> property.
  4664. This could be useful when the generated pdf will be merged with other documents.
  4665. </remarks>
  4666. </member>
  4667. <member name="P:SelectPdf.PdfFooter.DisplayOnFirstPage">
  4668. <summary>
  4669. Controls the visibility of the footer on the first page of the generated pdf document.
  4670. </summary>
  4671. <remarks>
  4672. When this property is true the footer will be displayed on the first page of the pdf document, otherwise it will not be visible.
  4673. This property has priority over <see cref="P:SelectPdf.PdfFooter.DisplayOnOddPages"/>. The default value is true.
  4674. </remarks>
  4675. </member>
  4676. <member name="P:SelectPdf.PdfFooter.DisplayOnOddPages">
  4677. <summary>
  4678. Controls the visibility of the footer on the odd numbered pages of the generated pdf document.
  4679. </summary>
  4680. <remarks>
  4681. By default the footer is displayed on both odd and even numbered pages.
  4682. The <see cref="P:SelectPdf.PdfFooter.DisplayOnFirstPage"/> property has priority over <see cref="P:SelectPdf.PdfFooter.DisplayOnOddPages"/>.
  4683. </remarks>
  4684. </member>
  4685. <member name="P:SelectPdf.PdfFooter.DisplayOnEvenPages">
  4686. <summary>
  4687. Controls the visibility of the footer on the even numbered pages of the generated pdf document.
  4688. </summary>
  4689. <remarks>
  4690. By default the footer is displayed on both odd and even numbered pages.
  4691. </remarks>
  4692. </member>
  4693. <member name="T:SelectPdf.PdfHeader">
  4694. <summary>
  4695. Handles the properties of the header of the generated pdf document.
  4696. </summary>
  4697. <remarks>
  4698. This class encapsulates the options to control the header in the rendered pdf document. The <see cref="T:SelectPdf.HtmlToPdf"/> class contains a
  4699. reference to an object of this type.
  4700. <para></para>
  4701. The header is displayed only if <see cref="P:SelectPdf.HtmlToPdfOptions.DisplayHeader"/> property of the <see cref="P:SelectPdf.HtmlToPdf.Options"/> object is true.
  4702. If the <see cref="P:SelectPdf.HtmlToPdfOptions.DisplayHeader"/> property of the <see cref="P:SelectPdf.HtmlToPdf.Options"/>
  4703. object is false, the header will not be displayed and all the options set here will have no effect.
  4704. </remarks>
  4705. </member>
  4706. <member name="M:SelectPdf.PdfHeader.Add(SelectPdf.PdfSectionElement)">
  4707. <summary>
  4708. Adds an additional element to the header of the pdf document.
  4709. </summary>
  4710. <remarks>
  4711. There are 3 section elements that can be added to the header of the pdf document: <see cref="T:SelectPdf.PdfHtmlSection"/>, <see cref="T:SelectPdf.PdfTextSection"/> and <see cref="T:SelectPdf.PdfImageSection"/>.
  4712. </remarks>
  4713. <param name="element">The element that will be rendered in the pdf header.</param>
  4714. </member>
  4715. <member name="M:SelectPdf.PdfHeader.AddTextArea(SelectPdf.PdfTextSection)">
  4716. <summary>
  4717. Adds a TextArea element to the additional elements list rendered after the
  4718. predefined header elements. The additional elements are rendered in the order they
  4719. are added to the list.
  4720. </summary>
  4721. <param name="textArea">The TextArea object to be rendered.</param>
  4722. </member>
  4723. <member name="M:SelectPdf.PdfHeader.AddImageArea(SelectPdf.PdfImageSection)">
  4724. <summary>
  4725. Adds an ImageArea element to the additional elements list rendered after the
  4726. predefined header elements. The additional elements are rendered in the order they
  4727. are added to the list.
  4728. </summary>
  4729. <param name="imageArea">The ImageArea object to be rendered.</param>
  4730. </member>
  4731. <member name="M:SelectPdf.PdfHeader.AddHtmlToPdfArea(SelectPdf.PdfHtmlSection)">
  4732. <summary>
  4733. Adds a PdfHtmlSection element to the additional elements list rendered after the
  4734. predefined header elements. The additional elements are rendered in the order they
  4735. are added to the list.
  4736. </summary>
  4737. <param name="htmlArea">The PdfHtmlSection object to be rendered.</param>
  4738. </member>
  4739. <member name="P:SelectPdf.PdfHeader.Height">
  4740. <summary>
  4741. The height of the pdf document header.
  4742. </summary>
  4743. <remarks>
  4744. This height is specified in points. 1 point is 1/72 inch. The default value is 45pt.
  4745. </remarks>
  4746. </member>
  4747. <member name="P:SelectPdf.PdfHeader.FirstPageNumber">
  4748. <summary>
  4749. Controls the page number for the first page being rendered.
  4750. </summary>
  4751. <remarks>
  4752. The page number is displayed setting a <c>{page_number}</c> placeholder in the <see cref="P:SelectPdf.PdfTextSection.Text"/> property.
  4753. By default the page numbers start with 1. This can be changed using the <see cref="P:SelectPdf.PdfHeader.FirstPageNumber"/> property.
  4754. </remarks>
  4755. </member>
  4756. <member name="P:SelectPdf.PdfHeader.TotalPagesOffset">
  4757. <summary>
  4758. Controls the total number of pages offset in the generated pdf document.
  4759. </summary>
  4760. <remarks>
  4761. The total number of pages is displayed setting a <c>{total_pages}</c> placeholder in the <see cref="P:SelectPdf.PdfTextSection.Text"/> property.
  4762. The total number of pages can be incremented with a value specified by the <see cref="P:SelectPdf.PdfHeader.TotalPagesOffset"/> property.
  4763. This could be useful when the generated pdf will be merged with other documents.
  4764. </remarks>
  4765. </member>
  4766. <member name="P:SelectPdf.PdfHeader.DisplayOnFirstPage">
  4767. <summary>
  4768. Controls the visibility of the header on the first page of the generated pdf document.
  4769. </summary>
  4770. <remarks>
  4771. When this property is true the header will be displayed on the first page of the pdf document, otherwise it will not be visible.
  4772. This property has priority over <see cref="P:SelectPdf.PdfHeader.DisplayOnOddPages"/>. The default value is true.
  4773. </remarks>
  4774. </member>
  4775. <member name="P:SelectPdf.PdfHeader.DisplayOnOddPages">
  4776. <summary>
  4777. Controls the visibility of the header on the odd numbered pages of the generated pdf document.
  4778. </summary>
  4779. <remarks>
  4780. By default the header is displayed on both odd and even numbered pages.
  4781. The <see cref="P:SelectPdf.PdfHeader.DisplayOnFirstPage"/> property has priority over <see cref="P:SelectPdf.PdfHeader.DisplayOnOddPages"/>.
  4782. </remarks>
  4783. </member>
  4784. <member name="P:SelectPdf.PdfHeader.DisplayOnEvenPages">
  4785. <summary>
  4786. Controls the visibility of the header on the even numbered pages of the generated pdf document.
  4787. </summary>
  4788. <remarks>
  4789. By default the header is displayed on both odd and even numbered pages.
  4790. </remarks>
  4791. </member>
  4792. <member name="T:SelectPdf.PdfPageOrientation">
  4793. <summary>
  4794. The list of pdf pages available orientations.
  4795. </summary>
  4796. </member>
  4797. <member name="F:SelectPdf.PdfPageOrientation.Portrait">
  4798. <summary>
  4799. Portrait
  4800. </summary>
  4801. </member>
  4802. <member name="F:SelectPdf.PdfPageOrientation.Landscape">
  4803. <summary>
  4804. Landscape
  4805. </summary>
  4806. </member>
  4807. <member name="T:SelectPdf.PdfPageSize">
  4808. <summary>
  4809. The list of pdf standard page sizes.
  4810. </summary>
  4811. </member>
  4812. <member name="F:SelectPdf.PdfPageSize.Custom">
  4813. <summary>
  4814. Use specified page size
  4815. </summary>
  4816. </member>
  4817. <member name="F:SelectPdf.PdfPageSize.Letter">
  4818. <summary>
  4819. Letter format
  4820. </summary>
  4821. </member>
  4822. <member name="F:SelectPdf.PdfPageSize.Note">
  4823. <summary>
  4824. Note format
  4825. </summary>
  4826. </member>
  4827. <member name="F:SelectPdf.PdfPageSize.Legal">
  4828. <summary>
  4829. Legal format
  4830. </summary>
  4831. </member>
  4832. <member name="F:SelectPdf.PdfPageSize.A0">
  4833. <summary>
  4834. A0 format
  4835. </summary>
  4836. </member>
  4837. <member name="F:SelectPdf.PdfPageSize.A1">
  4838. <summary>
  4839. A1 format
  4840. </summary>
  4841. </member>
  4842. <member name="F:SelectPdf.PdfPageSize.A2">
  4843. <summary>
  4844. A2 format
  4845. </summary>
  4846. </member>
  4847. <member name="F:SelectPdf.PdfPageSize.A3">
  4848. <summary>
  4849. A3 format
  4850. </summary>
  4851. </member>
  4852. <member name="F:SelectPdf.PdfPageSize.A4">
  4853. <summary>
  4854. A4 format
  4855. </summary>
  4856. </member>
  4857. <member name="F:SelectPdf.PdfPageSize.A5">
  4858. <summary>
  4859. A5 format
  4860. </summary>
  4861. </member>
  4862. <member name="F:SelectPdf.PdfPageSize.A6">
  4863. <summary>
  4864. A6 format
  4865. </summary>
  4866. </member>
  4867. <member name="F:SelectPdf.PdfPageSize.A7">
  4868. <summary>
  4869. A7 format
  4870. </summary>
  4871. </member>
  4872. <member name="F:SelectPdf.PdfPageSize.A8">
  4873. <summary>
  4874. A8 format
  4875. </summary>
  4876. </member>
  4877. <member name="F:SelectPdf.PdfPageSize.A9">
  4878. <summary>
  4879. A9 format
  4880. </summary>
  4881. </member>
  4882. <member name="F:SelectPdf.PdfPageSize.A10">
  4883. <summary>
  4884. A0 format
  4885. </summary>
  4886. </member>
  4887. <member name="F:SelectPdf.PdfPageSize.B0">
  4888. <summary>
  4889. B0 format
  4890. </summary>
  4891. </member>
  4892. <member name="F:SelectPdf.PdfPageSize.B1">
  4893. <summary>
  4894. B1 format
  4895. </summary>
  4896. </member>
  4897. <member name="F:SelectPdf.PdfPageSize.B2">
  4898. <summary>
  4899. B2 format
  4900. </summary>
  4901. </member>
  4902. <member name="F:SelectPdf.PdfPageSize.B3">
  4903. <summary>
  4904. B3 format
  4905. </summary>
  4906. </member>
  4907. <member name="F:SelectPdf.PdfPageSize.B4">
  4908. <summary>
  4909. B4 format
  4910. </summary>
  4911. </member>
  4912. <member name="F:SelectPdf.PdfPageSize.B5">
  4913. <summary>
  4914. B5 format
  4915. </summary>
  4916. </member>
  4917. <member name="F:SelectPdf.PdfPageSize.ArchE">
  4918. <summary>
  4919. ArchE format
  4920. </summary>
  4921. </member>
  4922. <member name="F:SelectPdf.PdfPageSize.ArchD">
  4923. <summary>
  4924. ArchD format
  4925. </summary>
  4926. </member>
  4927. <member name="F:SelectPdf.PdfPageSize.ArchC">
  4928. <summary>
  4929. ArchC format
  4930. </summary>
  4931. </member>
  4932. <member name="F:SelectPdf.PdfPageSize.ArchB">
  4933. <summary>
  4934. ArchB format
  4935. </summary>
  4936. </member>
  4937. <member name="F:SelectPdf.PdfPageSize.ArchA">
  4938. <summary>
  4939. ArchA format
  4940. </summary>
  4941. </member>
  4942. <member name="F:SelectPdf.PdfPageSize.Flsa">
  4943. <summary>
  4944. Flsa format
  4945. </summary>
  4946. </member>
  4947. <member name="F:SelectPdf.PdfPageSize.HalfLetter">
  4948. <summary>
  4949. HalfLetter format
  4950. </summary>
  4951. </member>
  4952. <member name="F:SelectPdf.PdfPageSize.Letter11x17">
  4953. <summary>
  4954. 11x17 format
  4955. </summary>
  4956. </member>
  4957. <member name="F:SelectPdf.PdfPageSize.Ledger">
  4958. <summary>
  4959. Ledger format
  4960. </summary>
  4961. </member>
  4962. <member name="T:SelectPdf.PdfSecurityOptions">
  4963. <summary>
  4964. This class provides the options to control the pdf document security.
  4965. </summary>
  4966. <remarks>
  4967. The <see cref="T:SelectPdf.HtmlToPdfOptions"/> class defines a reference to an object of this type.
  4968. </remarks>
  4969. </member>
  4970. <member name="P:SelectPdf.PdfSecurityOptions.CanAssembleDocument">
  4971. <summary>
  4972. Allows inserting, rotating or deleting pages or bookmarks.
  4973. </summary>
  4974. </member>
  4975. <member name="P:SelectPdf.PdfSecurityOptions.CanCopyContent">
  4976. <summary>
  4977. Allows copying page contents such as text and images.
  4978. </summary>
  4979. </member>
  4980. <member name="P:SelectPdf.PdfSecurityOptions.CanEditAnnotations">
  4981. <summary>
  4982. Allows document annotations editing.
  4983. </summary>
  4984. </member>
  4985. <member name="P:SelectPdf.PdfSecurityOptions.CanEditContent">
  4986. <summary>
  4987. Allows modifying document content.
  4988. </summary>
  4989. </member>
  4990. <member name="P:SelectPdf.PdfSecurityOptions.CanFillFormFields">
  4991. <summary>
  4992. Allows filling in form fields.
  4993. </summary>
  4994. </member>
  4995. <member name="P:SelectPdf.PdfSecurityOptions.CanPrint">
  4996. <summary>
  4997. Allows printing.
  4998. </summary>
  4999. </member>
  5000. <member name="P:SelectPdf.PdfSecurityOptions.OwnerPassword">
  5001. <summary>Sets or gets the owner password.</summary>
  5002. <remarks>
  5003. This password is required to change permissions of the pdf document (like printing or editing).
  5004. </remarks>
  5005. </member>
  5006. <member name="P:SelectPdf.PdfSecurityOptions.UserPassword">
  5007. <summary>Gets or sets the user password. </summary>
  5008. <remarks>
  5009. This password is required to open the pdf document.
  5010. </remarks>
  5011. </member>
  5012. <member name="T:SelectPdf.PdfStandard">
  5013. <summary>
  5014. The list of pdf standards available.
  5015. </summary>
  5016. </member>
  5017. <member name="F:SelectPdf.PdfStandard.Full">
  5018. <summary>
  5019. The full pdf features can be used in the generated pdf document.
  5020. </summary>
  5021. </member>
  5022. <member name="F:SelectPdf.PdfStandard.PdfA">
  5023. <summary>
  5024. The generated pdf is in conformance with PDF/A standard which makes the document
  5025. suitable for long term archiving.
  5026. </summary>
  5027. <remarks>
  5028. All the true type fonts are embedded in the pdf document, external HTTP links are disabled,
  5029. transparencies are disabled, and some special metadata to identify the document as PDF/A compliant
  5030. is inserted in the generated pdf document.
  5031. </remarks>
  5032. </member>
  5033. <member name="F:SelectPdf.PdfStandard.PdfX">
  5034. <summary>
  5035. The generated PDF is in conformance with PDF/X standard which makes the document
  5036. suitable for graphics exchange.
  5037. </summary>
  5038. <remarks>
  5039. In PDF/X all the true type fonts are embedded
  5040. in the generated pdf document.
  5041. </remarks>
  5042. </member>
  5043. <member name="F:SelectPdf.PdfStandard.PdfSiqQLevelA">
  5044. <summary>
  5045. The generated PDF is in conformance with PDF/SiqQ Level A standard which makes the document
  5046. suitable for being digitally signed.
  5047. </summary>
  5048. <remarks>
  5049. In PDF/SiqQ Level A all the true type fonts are embedded in the pdf document and the
  5050. external HTTP links are disabled.
  5051. </remarks>
  5052. </member>
  5053. <member name="F:SelectPdf.PdfStandard.PdfSiqQLevelB">
  5054. <summary>
  5055. The generated PDF is in conformance with PDF/SiqQ Level B standard which makes the document
  5056. suitable for being digitally signed.
  5057. </summary>
  5058. <remarks>
  5059. In PDF/SiqQ Level A all the true type fonts are embedded
  5060. in the generated pdf document.
  5061. </remarks>
  5062. </member>
  5063. <member name="T:SelectPdf.PostConvertActionHandler">
  5064. <summary>
  5065. The delegate type for handling the PostConvertAction event of PdfConverter class.
  5066. </summary>
  5067. <param name="pcaEventArgs">The argument for the PostConvertAction event handler.</param>
  5068. </member>
  5069. <member name="T:SelectPdf.PostConvertActionEventArgs">
  5070. <summary>
  5071. This class encapsulates the arguments for the PostConvertAction event handler.
  5072. </summary>
  5073. </member>
  5074. <member name="M:SelectPdf.PostConvertActionEventArgs.#ctor(SelectPdf.HtmlToPdf,SelectPdf.PdfDocument,SelectPdf.HtmlToPdfResult)">
  5075. <summary>
  5076. Constructs the argument for the PostConvertAction event handler.
  5077. </summary>
  5078. <param name="pdfConverter">The PdfConverter object that triggered the PostConvertActionEven.</param>
  5079. <param name="pdfDocument">The PDF document created by the converter.</param>
  5080. <param name="conversionResult">The conversion summary offering information like the number of pages converted or
  5081. the last drawn region to inform from where to continue drawing.</param>
  5082. </member>
  5083. <member name="P:SelectPdf.PostConvertActionEventArgs.PdfDocument">
  5084. <summary>
  5085. The PDF document created by converter.
  5086. </summary>
  5087. </member>
  5088. <member name="P:SelectPdf.PostConvertActionEventArgs.PdfConverter">
  5089. <summary>
  5090. The PdfConverter object that triggered the PostConvertActionEvent.
  5091. </summary>
  5092. </member>
  5093. <member name="P:SelectPdf.PostConvertActionEventArgs.ConversionResult">
  5094. <summary>
  5095. The conversion summary including the rectangle rendered on the last page and the last page index.
  5096. This information is useful when new elements are added after conversion in PostConvertActionEvent handler.
  5097. </summary>
  5098. </member>
  5099. <member name="T:SelectPdf.UnitsConverter">
  5100. <summary>
  5101. Converts between various graphic units (pixels, points, etc).
  5102. </summary>
  5103. </member>
  5104. <member name="M:SelectPdf.UnitsConverter.PointsToPixels(System.Single)">
  5105. <summary>
  5106. Converts from points to pixels. The result of this method takes into account the
  5107. current screen resolution.
  5108. </summary>
  5109. <param name="points">The value in points to convert.</param>
  5110. <returns>The value in pixels.</returns>
  5111. </member>
  5112. <member name="M:SelectPdf.UnitsConverter.PixelsToPoints(System.Single)">
  5113. <summary>
  5114. Converts from pixels to points. The result of this method takes into account the
  5115. current screen resolution.
  5116. </summary>
  5117. <param name="pixels">The value in pixels to convert.</param>
  5118. <returns>The value in points.</returns>
  5119. </member>
  5120. <member name="T:SelectPdf.PdfTextVerticalAlign">
  5121. <summary>
  5122. Specifies vertical alignment of text.
  5123. </summary>
  5124. </member>
  5125. <member name="F:SelectPdf.PdfTextVerticalAlign.Top">
  5126. <summary>
  5127. Align top.
  5128. </summary>
  5129. </member>
  5130. <member name="F:SelectPdf.PdfTextVerticalAlign.Middle">
  5131. <summary>
  5132. Align center.
  5133. </summary>
  5134. </member>
  5135. <member name="F:SelectPdf.PdfTextVerticalAlign.Bottom">
  5136. <summary>
  5137. Align bottom.
  5138. </summary>
  5139. </member>
  5140. <member name="T:SelectPdf.PdfViewerFullScreenExitMode">
  5141. <summary>
  5142. Specifies how to display the pdf document on exiting full-screen mode.
  5143. </summary>
  5144. </member>
  5145. <member name="F:SelectPdf.PdfViewerFullScreenExitMode.UseNone">
  5146. <summary>
  5147. Neither document outline (bookmarks) nor thumbnail images are visible.
  5148. </summary>
  5149. </member>
  5150. <member name="F:SelectPdf.PdfViewerFullScreenExitMode.UseOutlines">
  5151. <summary>
  5152. Document outline (bookmarks) are visible.
  5153. </summary>
  5154. </member>
  5155. <member name="F:SelectPdf.PdfViewerFullScreenExitMode.UseThumbs">
  5156. <summary>
  5157. Thumbnail images are visible.
  5158. </summary>
  5159. </member>
  5160. <member name="F:SelectPdf.PdfViewerFullScreenExitMode.UseOC">
  5161. <summary>
  5162. Optional content group panel is visible.
  5163. </summary>
  5164. </member>
  5165. <member name="T:SelectPdf.PdfViewerPageLayout">
  5166. <summary>
  5167. Specifies the page layout to be used when the pdf document is opened in a viewer.
  5168. </summary>
  5169. </member>
  5170. <member name="F:SelectPdf.PdfViewerPageLayout.SinglePage">
  5171. <summary>
  5172. Displays one page at a time.
  5173. </summary>
  5174. </member>
  5175. <member name="F:SelectPdf.PdfViewerPageLayout.OneColumn">
  5176. <summary>
  5177. Displays the pages in one column.
  5178. </summary>
  5179. </member>
  5180. <member name="F:SelectPdf.PdfViewerPageLayout.TwoColumnLeft">
  5181. <summary>
  5182. Displays the pages in two columns, with odd-numbered pages on the left.
  5183. </summary>
  5184. </member>
  5185. <member name="F:SelectPdf.PdfViewerPageLayout.TwoColumnRight">
  5186. <summary>
  5187. Displays the pages in two columns, with odd-numbered pages on the right.
  5188. </summary>
  5189. </member>
  5190. <member name="T:SelectPdf.PdfViewerPageMode">
  5191. <summary>
  5192. Specifies the pdf document's page mode.
  5193. </summary>
  5194. </member>
  5195. <member name="F:SelectPdf.PdfViewerPageMode.UseNone">
  5196. <summary>
  5197. Neither document outline (bookmarks) nor thumbnail images are visible.
  5198. </summary>
  5199. </member>
  5200. <member name="F:SelectPdf.PdfViewerPageMode.UseOutlines">
  5201. <summary>
  5202. Document outline (bookmarks) are visible.
  5203. </summary>
  5204. </member>
  5205. <member name="F:SelectPdf.PdfViewerPageMode.UseThumbs">
  5206. <summary>
  5207. Thumbnail images are visible.
  5208. </summary>
  5209. </member>
  5210. <member name="F:SelectPdf.PdfViewerPageMode.FullScreen">
  5211. <summary>
  5212. Full-screen mode, with no menu bar, window controls or any other window visible.
  5213. </summary>
  5214. </member>
  5215. <member name="F:SelectPdf.PdfViewerPageMode.UseOC">
  5216. <summary>
  5217. Optional content group panel is visible.
  5218. </summary>
  5219. </member>
  5220. <member name="F:SelectPdf.PdfViewerPageMode.UseAttachments">
  5221. <summary>
  5222. Document attachments are visible.
  5223. </summary>
  5224. </member>
  5225. <member name="T:SelectPdf.HtmlToPdfViewerPreferences">
  5226. <summary>
  5227. The pdf viewer preferences. Controls how the pdf document appears in a pdf viewer (like Adobe Reader).
  5228. </summary>
  5229. </member>
  5230. <member name="P:SelectPdf.HtmlToPdfViewerPreferences.HideToolbar">
  5231. <summary>
  5232. Gets or sets a flag specifying whether to hide the pdf viewer application's tool bars when the document is active.
  5233. </summary>
  5234. <remarks>
  5235. The default value for this property is false.
  5236. </remarks>
  5237. </member>
  5238. <member name="P:SelectPdf.HtmlToPdfViewerPreferences.HideMenuBar">
  5239. <summary>
  5240. Gets or sets a flag specifying whether to hide the pdf viewer application's menu bar when the document is active.
  5241. </summary>
  5242. <remarks>
  5243. The default value for this property is false.
  5244. </remarks>
  5245. </member>
  5246. <member name="P:SelectPdf.HtmlToPdfViewerPreferences.HideWindowUI">
  5247. <summary>
  5248. Gets or sets a flag specifying whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.
  5249. </summary>
  5250. <remarks>
  5251. The default value for this property is false.
  5252. </remarks>
  5253. </member>
  5254. <member name="P:SelectPdf.HtmlToPdfViewerPreferences.FitWindow">
  5255. <summary>
  5256. Gets or sets a flag specifying whether to resize the document's window to fit the size of the first displayed page.
  5257. </summary>
  5258. <remarks>
  5259. The default value for this property is false.
  5260. </remarks>
  5261. </member>
  5262. <member name="P:SelectPdf.HtmlToPdfViewerPreferences.CenterWindow">
  5263. <summary>
  5264. Gets or sets a flag specifying whether to position the document's window in the center of the screen.
  5265. </summary>
  5266. <remarks>
  5267. The default value for this property is false.
  5268. </remarks>
  5269. </member>
  5270. <member name="P:SelectPdf.HtmlToPdfViewerPreferences.DisplayDocTitle">
  5271. <summary>
  5272. Gets or sets a flag specifying whether the window's title bar should display the document title taken from <see cref="P:SelectPdf.HtmlToPdfOptions.PdfDocumentInformation"/> property.
  5273. </summary>
  5274. <remarks>
  5275. The default value for this property is false.
  5276. </remarks>
  5277. </member>
  5278. <member name="P:SelectPdf.HtmlToPdfViewerPreferences.NonFullScreenPageMode">
  5279. <summary>
  5280. Gets or sets the document page mode when the pdf viewer application exits the full screen mode.
  5281. </summary>
  5282. <remarks>
  5283. This property is taken into account only if <see cref="P:SelectPdf.HtmlToPdfViewerPreferences.PageMode"/> is set to <see cref="F:SelectPdf.PdfViewerPageMode.FullScreen"/>. Otherwise it is ignored.
  5284. <para>
  5285. The default value for this property is <see cref="F:SelectPdf.PdfViewerFullScreenExitMode.UseNone"/>.
  5286. </para>
  5287. </remarks>
  5288. </member>
  5289. <member name="P:SelectPdf.HtmlToPdfViewerPreferences.PageMode">
  5290. <summary>
  5291. Gets or sets the document page mode when the pdf document is opened in a pdf viewer.
  5292. </summary>
  5293. <remarks>
  5294. The default value for this property is <see cref="F:SelectPdf.PdfViewerPageMode.UseNone"/>.
  5295. </remarks>
  5296. </member>
  5297. <member name="P:SelectPdf.HtmlToPdfViewerPreferences.PageLayout">
  5298. <summary>
  5299. Gets or sets the page layout to be used when the document is opened.
  5300. </summary>
  5301. <remarks>
  5302. The default value for this property is <see cref="F:SelectPdf.PdfViewerPageLayout.OneColumn"/>.
  5303. </remarks>
  5304. </member>
  5305. <member name="T:SelectPdf.PdfViewerTextOrder">
  5306. <summary>
  5307. Used in pdf document viewer preferences to specify the reading order for texts.
  5308. </summary>
  5309. </member>
  5310. <member name="F:SelectPdf.PdfViewerTextOrder.L2R">
  5311. <summary>
  5312. Left to right.
  5313. </summary>
  5314. </member>
  5315. <member name="F:SelectPdf.PdfViewerTextOrder.R2L">
  5316. <summary>
  5317. Right to left.
  5318. </summary>
  5319. </member>
  5320. </members>
  5321. </doc>