ComPDFKit.Desk.xml 215 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>ComPDFKit.Desk</name>
  5. </assembly>
  6. <members>
  7. <member name="T:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation">
  8. <summary>
  9. A redact annotation displays text directly on the page.
  10. </summary>
  11. </member>
  12. <member name="P:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.QuardRects">
  13. <summary>
  14. Gets the areas that should be covered by the redaction annotation.
  15. </summary>
  16. </member>
  17. <member name="P:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.TextDa">
  18. <summary>
  19. Gets the text attribute displayed in the specified area after applying the redaction.
  20. </summary>
  21. </member>
  22. <member name="P:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.TextAlignment">
  23. <summary>
  24. Gets the text alignment displayed in the specified area after applying the redaction.
  25. </summary>
  26. </member>
  27. <member name="P:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.OutlineColor">
  28. <summary>
  29. Gets the color used for the redaction’s border in its marked state. Defaults to red.
  30. </summary>
  31. </member>
  32. <member name="P:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.FillColor">
  33. <summary>
  34. Gets the fill color displayed in the specified area after applying the redaction. The color is drawn on the specified rect. Defaults to black.
  35. </summary>
  36. </member>
  37. <member name="P:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.BorderWidth">
  38. <summary>
  39. Border width.
  40. </summary>
  41. </member>
  42. <member name="P:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.OverlayText">
  43. <summary>
  44. Gets the text displayed in the specified area after applying the redaction.
  45. </summary>
  46. </member>
  47. <member name="P:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.Rect">
  48. <summary>
  49. Gets the rectangle of Redact annotation on the page.
  50. </summary>
  51. </member>
  52. <member name="M:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.SetQuardRects(System.Collections.Generic.List{ComPDFKit.Import.CRect})">
  53. <summary>
  54. Uses the rects property to set the areas that should be covered by the redaction annotation.
  55. </summary>
  56. <param name="rects">Page area list </param>
  57. <returns>Returns true on success, false on failure</returns>
  58. </member>
  59. <member name="M:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.SetTextDa(ComPDFKit.PDFAnnotation.CTextAttribute)">
  60. <summary>
  61. Sets the text attribute displayed in the specified area after applying the redaction.
  62. </summary>
  63. <param name="textDa">Text attribute</param>
  64. <returns>Returns true on success, false on failure</returns>
  65. </member>
  66. <member name="M:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.SetTextAlignment(ComPDFKit.PDFAnnotation.C_TEXT_ALIGNMENT)">
  67. <summary>
  68. Sets the text alignment displayed in the specified area after applying the redaction.
  69. </summary>
  70. <param name="alignment">Text alignmnent</param>
  71. <returns>Returns true on success, false on failure</returns>
  72. </member>
  73. <member name="M:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.SetBorderWidth(System.Single)">
  74. <summary>
  75. Sets border width.
  76. </summary>
  77. <param name="borderWidth">Border width</param>
  78. <returns>Returns true on success, false on failure</returns>
  79. </member>
  80. <member name="M:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.SetOutlineColor(System.Byte[])">
  81. <summary>
  82. Sets the color used for the redaction’s border in its marked state. Defaults to red.
  83. </summary>
  84. <param name="outlineColor">RGB color value, range0-255</param>
  85. <returns>Returns true on success, false on failure</returns>
  86. </member>
  87. <member name="M:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.ClearOutlineColor">
  88. <summary>
  89. Removes the color used for the redaction’s border in its marked state. Defaults to red.
  90. </summary>
  91. <returns></returns>
  92. </member>
  93. <member name="M:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.SetFillColor(System.Byte[])">
  94. <summary>
  95. Sets the fill color displayed in the specified area after applying the redaction. The color is drawn on the specified rect. Defaults to black.
  96. </summary>
  97. <param name="fillColor">RGB color value, range0-255</param>
  98. <returns>Returns true on success, false on failure</returns>
  99. </member>
  100. <member name="M:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.SetOverlayText(System.String)">
  101. <summary>
  102. Sets the text displayed in the specified area after applying the redaction.
  103. </summary>
  104. <param name="text">Text content</param>
  105. <returns>Returns true on success, false on failure</returns>
  106. </member>
  107. <member name="M:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.SetRect(ComPDFKit.Import.CRect)">
  108. <summary>
  109. Sets annotation rectangle. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window.
  110. </summary>
  111. <param name="rect">PDF page rectangle area</param>
  112. <returns>Returns true on success, false on failure</returns>
  113. </member>
  114. <member name="M:ComPDFKit.PDFAnnotation.CPDFRedactAnnotation.ApplyRedaction">
  115. <summary>
  116. Applies redaction annotation.
  117. </summary>
  118. <returns>Returns true on success, false on failure.</returns>
  119. </member>
  120. <member name="T:ComPDFKit.PDFAnnotation.Form.CPDFCheckBoxWidget">
  121. <summary>
  122. A single checkbox form control which can be toggled to on or off.
  123. </summary>
  124. </member>
  125. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFCheckBoxWidget.SetChecked(System.Boolean)">
  126. <summary>
  127. Sets the state of CheckBox, true means selected, false otherwise.
  128. </summary>
  129. <param name="isChecked">State of CheckBox, true means selected, false otherwise.</param>
  130. <returns>Returns true on success, false on failure</returns>
  131. </member>
  132. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFCheckBoxWidget.IsChecked">
  133. <summary>
  134. Gets the state of CheckBox, true means selected, false otherwise.
  135. </summary>
  136. <returns>Selected state of CheckBox true if CheckBox is selected, false otherwise</returns>
  137. </member>
  138. <member name="T:ComPDFKit.PDFAnnotation.Form.CPDFComboBoxWidget">
  139. <summary>
  140. A form control which displays drop-down list. When isEditable() flag is set, it can be accompanied by an editable text box for editing custom value.
  141. </summary>
  142. </member>
  143. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFComboBoxWidget.IsEditable">
  144. <summary>
  145. Whether Combobox is editable.
  146. </summary>
  147. <returns>Returns whether Combobox is editable</returns>
  148. </member>
  149. <member name="T:ComPDFKit.PDFAnnotation.Form.CPDFListBoxWidget">
  150. <summary>
  151. A form field which displays scrollable list with choices.
  152. </summary>
  153. </member>
  154. <member name="T:ComPDFKit.PDFAnnotation.Form.CPDFPushButtonWidget">
  155. <summary>
  156. A simple push button that responds immediately to user input without retaining any state.
  157. </summary>
  158. </member>
  159. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFPushButtonWidget.SetButtonAction(ComPDFKit.PDFDocument.Action.CPDFAction)">
  160. <summary>
  161. Sets response action of PushButtonget. There are multiple subtypes of the action, and different actions are determined according to<see cref="P:ComPDFKit.PDFDocument.Action.CPDFAction.ActionType"/>more: <see cref="T:ComPDFKit.PDFDocument.Action.CPDFAction"/>
  162. </summary>
  163. <param name="action">Response action of PushButton</param>
  164. <returns>Returns true on success, false on failure</returns>
  165. </member>
  166. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFPushButtonWidget.GetButtonAction">
  167. <summary>
  168. Gets response action of PushButtonget. There are multiple subtypes of the action, and different actions are determined according to<see cref="P:ComPDFKit.PDFDocument.Action.CPDFAction.ActionType"/>more: <see cref="T:ComPDFKit.PDFDocument.Action.CPDFAction"/>
  169. </summary>
  170. <returns>Returns response of PushButton, more: <see cref="T:ComPDFKit.PDFDocument.Action.CPDFAction"/></returns>
  171. </member>
  172. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFPushButtonWidget.SetButtonTitle(System.String)">
  173. <summary>
  174. Sets PushButton label.
  175. </summary>
  176. <param name="title">PushButton label</param>
  177. <returns>Returns true on success, false on failure</returns>
  178. </member>
  179. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFPushButtonWidget.GetButtonTitle">
  180. <summary>
  181. Gets PushButton label.
  182. </summary>
  183. <returns>Returns PushButton title</returns>
  184. </member>
  185. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFPushButtonWidget.ReleaseAnnot">
  186. <summary>
  187. Releases resources. When the object is no longer in use, call this method to release resources.
  188. </summary>
  189. </member>
  190. <member name="T:ComPDFKit.PDFAnnotation.Form.CPDFRadioButtonWidget">
  191. <summary>
  192. Multiple RadioButton controls can be a list, when clicking a RadioButton, it is set as selected, others in the list set as unselected.
  193. Method to set multiple RadioButton in the same list: Set the fieldName of multiple RadioButton to the same value, such as:
  194. radiobutton1.SetFieldName("xxx");
  195. radiobutton2.SetFieldName("xxx");
  196. radiobutton3.SetFieldName("xxx");
  197. </summary>
  198. </member>
  199. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFRadioButtonWidget.SetChecked(System.Boolean)">
  200. <summary>
  201. Sets whether Radiobutton is selected, true means selected, false otherwise.
  202. </summary>
  203. <param name="isChecked">Whether it is selected</param>
  204. <returns>Returns true on success, false on failure</returns>
  205. </member>
  206. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFRadioButtonWidget.IsChecked">
  207. <summary>
  208. Whether Radiobutton is selected, true means selected, false otherwise.
  209. </summary>
  210. <returns>Returns the selected state of Radiobutton, true: selected, false: unselected.</returns>
  211. </member>
  212. <member name="T:ComPDFKit.PDFAnnotation.Form.CPDFSignatureWidget">
  213. <summary>
  214. Represents a signature field in a form. This is usually used to place a signature onto a page using an CPDFInkAnnotation.
  215. </summary>
  216. </member>
  217. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFSignatureWidget.IsSigned">
  218. <summary>
  219. Whether signature form is signed.
  220. </summary>
  221. <returns>Whether Signature form is signed</returns>
  222. </member>
  223. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFSignatureWidget.UpdateApWithText(System.String,System.String,System.String,System.Int32)">
  224. <summary>
  225. Updates form appearance by text.
  226. </summary>
  227. <param name="text">Text content of signature</param>
  228. <param name="fontName">Font name of signature text</param>
  229. <param name="color">Text color</param>
  230. <param name="rotation">Rotation value, range0,1,2,3</param>
  231. <returns>Returns true on success, false on failure</returns>
  232. </member>
  233. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFSignatureWidget.UpdateApWithImage(System.Byte[],System.Int32,System.Int32,ComPDFKit.Import.C_Scale_Type,System.Int32)">
  234. <summary>
  235. Updates form appearance by image.
  236. </summary>
  237. <param name="imageData">Bitmap data of image</param>
  238. <param name="imageWidth">Image width</param>
  239. <param name="imageHeight">Image height</param>
  240. <param name="scaleType">The zoom rule for filling the image into the form</param>
  241. <param name="rotation">Rotation value, range0,1,2,3</param>
  242. <returns>Returns true on success, false on failure</returns>
  243. </member>
  244. <!-- Badly formed XML comment ignored for member "M:ComPDFKit.PDFAnnotation.Form.CPDFSignatureWidget.UpdateApWithInk(System.Collections.Generic.List{System.Collections.Generic.List{ComPDFKit.Import.CPoint}},System.String,System.Int32)" -->
  245. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFSignatureWidget.SignWithName">
  246. <summary>
  247. Sets Signature form as signed.
  248. </summary>
  249. <returns>Returns true on success, false on failure</returns>
  250. </member>
  251. <member name="T:ComPDFKit.PDFAnnotation.Form.C_TEXTFILED_SPECIAL">
  252. <summary>
  253. Types of text field.
  254. </summary>
  255. </member>
  256. <member name="F:ComPDFKit.PDFAnnotation.Form.C_TEXTFILED_SPECIAL.C_TEXTFIELD_NORMAL">
  257. <summary>
  258. Text format
  259. </summary>
  260. </member>
  261. <member name="F:ComPDFKit.PDFAnnotation.Form.C_TEXTFILED_SPECIAL.C_TEXTFIELD_DATE">
  262. <summary>
  263. Date
  264. </summary>
  265. </member>
  266. <member name="T:ComPDFKit.PDFAnnotation.Form.CPDFTextWidget">
  267. <summary>
  268. A text form field in a PDF form. Allows the user to enter custom text.
  269. </summary>
  270. </member>
  271. <member name="P:ComPDFKit.PDFAnnotation.Form.CPDFTextWidget.Text">
  272. <summary>
  273. Gets the text content of TextField.
  274. </summary>
  275. </member>
  276. <member name="P:ComPDFKit.PDFAnnotation.Form.CPDFTextWidget.IsMultiLine">
  277. <summary>
  278. Whether to display multiline PDF text fields.
  279. </summary>
  280. </member>
  281. <member name="P:ComPDFKit.PDFAnnotation.Form.CPDFTextWidget.IsPassword">
  282. <summary>
  283. Whether the TextField content display password, password :*****
  284. </summary>
  285. </member>
  286. <member name="P:ComPDFKit.PDFAnnotation.Form.CPDFTextWidget.TextAttribute">
  287. <summary>
  288. Gets the text attribute of TextField text, more: <see cref="T:ComPDFKit.PDFAnnotation.CTextAttribute"/>
  289. </summary>
  290. </member>
  291. <member name="P:ComPDFKit.PDFAnnotation.Form.CPDFTextWidget.Alignment">
  292. <summary>
  293. Gets the the text alignment in TextField, more: <see cref="T:ComPDFKit.PDFAnnotation.C_TEXT_ALIGNMENT"/>
  294. </summary>
  295. </member>
  296. <member name="P:ComPDFKit.PDFAnnotation.Form.CPDFTextWidget.TextFieldSpecial">
  297. <summary>
  298. Gets the content format of TextField, format type: <see cref="T:ComPDFKit.PDFAnnotation.Form.C_TEXTFILED_SPECIAL"/>
  299. </summary>
  300. </member>
  301. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFTextWidget.SetText(System.String)">
  302. <summary>
  303. Sets the text content of TextField.
  304. </summary>
  305. <param name="text">Text content</param>
  306. <returns>Returns true on success, false on failure</returns>
  307. </member>
  308. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFTextWidget.SetMultiLine(System.Boolean)">
  309. <summary>
  310. Sets to display multiline PDF text fields.
  311. </summary>
  312. <param name="isMultiLine">Whether to display multiline PDF text fields.</param>
  313. <returns>Returns true on success, false on failure</returns>
  314. </member>
  315. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFTextWidget.SetTextAttribute(ComPDFKit.PDFAnnotation.CTextAttribute)">
  316. <summary>
  317. Sets the text attribute of TextField, more: <see cref="T:ComPDFKit.PDFAnnotation.CTextAttribute"/>
  318. </summary>
  319. <param name="textAttribute">Text attribute</param>
  320. <returns>Returns true on success, false on failure</returns>
  321. </member>
  322. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFTextWidget.SetJustification(ComPDFKit.PDFAnnotation.C_TEXT_ALIGNMENT)">
  323. <summary>
  324. Sets the text alignment of TextField, more: <see cref="T:ComPDFKit.PDFAnnotation.C_TEXT_ALIGNMENT"/>
  325. </summary>
  326. <param name="alignment">Text alignment</param>
  327. <returns>Returns true on success, false on failure</returns>
  328. </member>
  329. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFTextWidget.SetTextFieldSpecial(System.Boolean)">
  330. <summary>
  331. Sets the content format of TextField, format type: <see cref="T:ComPDFKit.PDFAnnotation.Form.C_TEXTFILED_SPECIAL"/>
  332. </summary>
  333. <param name="isDateSpecial">Whether it is date</param>
  334. <returns>Returns true on success, false on failure</returns>
  335. </member>
  336. <member name="T:ComPDFKit.PDFAnnotation.Form.C_WIDGET_TYPE">
  337. <summary>
  338. Form type.
  339. </summary>
  340. </member>
  341. <member name="F:ComPDFKit.PDFAnnotation.Form.C_WIDGET_TYPE.WIDGET_PUSHBUTTON">
  342. <summary>
  343. PushButton
  344. </summary>
  345. </member>
  346. <member name="F:ComPDFKit.PDFAnnotation.Form.C_WIDGET_TYPE.WIDGET_CHECKBOX">
  347. <summary>
  348. CheckBox
  349. </summary>
  350. </member>
  351. <member name="F:ComPDFKit.PDFAnnotation.Form.C_WIDGET_TYPE.WIDGET_RADIOBUTTON">
  352. <summary>
  353. Radiobutton
  354. </summary>
  355. </member>
  356. <member name="F:ComPDFKit.PDFAnnotation.Form.C_WIDGET_TYPE.WIDGET_TEXTFIELD">
  357. <summary>
  358. TextField
  359. </summary>
  360. </member>
  361. <member name="F:ComPDFKit.PDFAnnotation.Form.C_WIDGET_TYPE.WIDGET_COMBOBOX">
  362. <summary>
  363. Combobox
  364. </summary>
  365. </member>
  366. <member name="F:ComPDFKit.PDFAnnotation.Form.C_WIDGET_TYPE.WIDGET_LISTBOX">
  367. <summary>
  368. Listbox
  369. </summary>
  370. </member>
  371. <member name="F:ComPDFKit.PDFAnnotation.Form.C_WIDGET_TYPE.WIDGET_SIGNATUREFIELDS">
  372. <summary>
  373. Signature
  374. </summary>
  375. </member>
  376. <member name="F:ComPDFKit.PDFAnnotation.Form.C_WIDGET_TYPE.WIDGET_UNKNOWN">
  377. <summary>
  378. Unknown type
  379. </summary>
  380. </member>
  381. <member name="T:ComPDFKit.PDFAnnotation.Form.C_CHECK_STYLE">
  382. <summary>
  383. Fill type of CheckBox and Radiobutton.
  384. </summary>
  385. </member>
  386. <member name="F:ComPDFKit.PDFAnnotation.Form.C_CHECK_STYLE.CK_CHECK">
  387. <summary>
  388. </summary>
  389. </member>
  390. <member name="F:ComPDFKit.PDFAnnotation.Form.C_CHECK_STYLE.CK_CIRCLE">
  391. <summary>
  392. Solid circle
  393. </summary>
  394. </member>
  395. <member name="F:ComPDFKit.PDFAnnotation.Form.C_CHECK_STYLE.CK_CROSS">
  396. <summary>
  397. ×
  398. </summary>
  399. </member>
  400. <member name="F:ComPDFKit.PDFAnnotation.Form.C_CHECK_STYLE.CK_DIAMOND">
  401. <summary>
  402. Solid diamond
  403. </summary>
  404. </member>
  405. <member name="F:ComPDFKit.PDFAnnotation.Form.C_CHECK_STYLE.CK_SQUARE">
  406. <summary>
  407. Solid square
  408. </summary>
  409. </member>
  410. <member name="F:ComPDFKit.PDFAnnotation.Form.C_CHECK_STYLE.CK_STAR">
  411. <summary>
  412. Solid star
  413. </summary>
  414. </member>
  415. <member name="T:ComPDFKit.PDFAnnotation.Form.CPDFWidget">
  416. <summary>
  417. A visible form control. Every form element has a single parent CPDFWidget. Each form element is associated with a single CPDFAnnotation that is a visual representation of the form element in the document.
  418. </summary>
  419. </member>
  420. <member name="P:ComPDFKit.PDFAnnotation.Form.CPDFWidget.WidgeType">
  421. <summary>
  422. Gets form type. Refer to: <see cref="T:ComPDFKit.PDFAnnotation.Form.C_WIDGET_TYPE"/>
  423. </summary>
  424. </member>
  425. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.SetFieldName(System.String)">
  426. <summary>
  427. Sets internal name for the field.
  428. </summary>
  429. <param name="fieldName">List name of forms</param>
  430. </member>
  431. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.GetFieldName">
  432. <summary>
  433. Gets internal name for the field.
  434. If multiple forms have the same internal name, these forms are seen as one list, and their action affect each other. For example, in the CheckBox and Radiobutton list, when a form is set to be selected, others are set to be unselected.
  435. </summary>
  436. <returns>Returns name of form list</returns>
  437. </member>
  438. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.SetFieldFlag(System.Int32)">
  439. <summary>
  440. Sets form flag.
  441. </summary>
  442. <param name="fieldFlag">Form flag</param>
  443. <returns>Returns true on success, false on failure</returns>
  444. </member>
  445. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.GetFieldFlag">
  446. <summary>
  447. Gets form flag.
  448. </summary>
  449. <returns>Returns the form identifier</returns>
  450. </member>
  451. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.GetIsReadOnly">
  452. <summary>
  453. </summary>
  454. <returns></returns>
  455. </member>
  456. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.SetIsReadOnly(System.Boolean)">
  457. <summary>
  458. </summary>
  459. <param name="isReadOnly"></param>
  460. <returns></returns>
  461. </member>
  462. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.SetFieldType(System.String)">
  463. <summary>
  464. Sets the form field type.
  465. </summary>
  466. <param name="fieldType">Form field type</param>
  467. <returns>Returns true on success, false on failure</returns>
  468. </member>
  469. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.GetFieldType">
  470. <summary>
  471. Gets the form field type.
  472. </summary>
  473. <returns>Form field type</returns>
  474. </member>
  475. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.SetWidgetBgRGBColor(System.Byte[])">
  476. <summary>
  477. Sets the background color of the form.
  478. </summary>
  479. <param name="rgbColor">RGB color value</param>
  480. <returns>Returns true on success, false on failure</returns>
  481. </member>
  482. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.GetWidgetBgRGBColor(System.Byte[]@)">
  483. <summary>
  484. Gets the background color of the form.
  485. </summary>
  486. <returns>RGB color value</returns>
  487. </member>
  488. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.SetWidgetBorderRGBColor(System.Byte[])">
  489. <summary>
  490. Sets the border color of the form.
  491. </summary>
  492. <param name="rgbColor">Color</param>
  493. <returns>Returns true on success, false on failure</returns>
  494. </member>
  495. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.GetWidgetBorderRGBColor(System.Byte[]@)">
  496. <summary>
  497. Gets the background color of the form.
  498. </summary>
  499. <returns>RGB color value</returns>
  500. </member>
  501. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.SetWidgetBorderStyle(ComPDFKit.PDFAnnotation.C_BORDER_STYLE)">
  502. <summary>
  503. Sets border style of the form, more: <see cref="T:ComPDFKit.PDFAnnotation.C_BORDER_STYLE" />
  504. </summary>
  505. <param name="borderStyle">Border style</param>
  506. <returns>Returns true on success, false on failure</returns>
  507. </member>
  508. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.GetWidgetBorderStyle">
  509. <summary>
  510. Gets the border style of the form, more: <see cref="T:ComPDFKit.PDFAnnotation.C_BORDER_STYLE" />
  511. </summary>
  512. <returns>Returns the border style of the form</returns>
  513. </member>
  514. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.SetWidgetCheckStyle(ComPDFKit.PDFAnnotation.Form.C_CHECK_STYLE)">
  515. <summary>
  516. Sets the fill style of CheckBox or Radiobutton; more <see cref="T:ComPDFKit.PDFAnnotation.Form.C_CHECK_STYLE"/>
  517. </summary>
  518. <param name="checkStyle">Fill style</param>
  519. <returns>Returns true on success, false on failure</returns>
  520. </member>
  521. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.GetWidgetCheckStyle">
  522. <summary>
  523. Gets the fill style of CheckBox or Radiobutton; more <see cref="T:ComPDFKit.PDFAnnotation.Form.C_CHECK_STYLE"/>
  524. </summary>
  525. <returns>Returns true on success, false on failure</returns>
  526. </member>
  527. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.SetWidgetCheckColor(System.Byte[])">
  528. <summary>
  529. Sets fill color of CheckBox or Radiobutton.
  530. </summary>
  531. <param name="rgbColor">Color value of fill content of CheckBox or Radiobutton forms</param>
  532. <returns>Returns true on success, false on failure</returns>
  533. </member>
  534. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.GetWidgetCheckColor">
  535. <summary>
  536. Gets fill color of CheckBox or Radiobutton.
  537. </summary>
  538. <returns>Fill color of CheckBox or Radiobutton</returns>
  539. </member>
  540. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.UpdateFormAp">
  541. <summary>
  542. Updates form appearance.
  543. </summary>
  544. <returns>Returns true on success, false on failure</returns>
  545. </member>
  546. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidget.ResetForm">
  547. <summary>
  548. Resets forms.
  549. </summary>
  550. <returns>Returns true on success, false on failure</returns>
  551. </member>
  552. <member name="T:ComPDFKit.PDFAnnotation.Form.CPDFWidgetItems">
  553. <summary>
  554. Parent of Listbox or Combobox forms.
  555. </summary>
  556. </member>
  557. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidgetItems.LoadWidgetItems">
  558. <summary>
  559. Gets all items in ListBox or Combobox. more: <see cref="T:ComPDFKit.PDFAnnotation.Form.CWidgetItem"/>
  560. </summary>
  561. <returns>Returns all items in ListBox or Combobox</returns>
  562. </member>
  563. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidgetItems.GetItemsCount">
  564. <summary>
  565. Gets the total count of items in ListBox or Combobox forms.
  566. </summary>
  567. <returns>Returns the total count of ListBox or Combobox forms</returns>
  568. </member>
  569. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidgetItems.SelectItem(System.Int32)">
  570. <summary>
  571. Sets the index item as selected in ListBox or Combobox.
  572. </summary>
  573. <param name="index">Index of the selected item</param>
  574. <returns>Returns true on success, false on failure</returns>
  575. </member>
  576. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidgetItems.GetSelectedItem">
  577. <summary>
  578. Gets the selected items in ListBox or Combobox forms, more: <see cref="T:ComPDFKit.PDFAnnotation.Form.CWidgetItem"/>
  579. </summary>
  580. <returns>Returns the selected item in ListBox or Combobox forms</returns>
  581. </member>
  582. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidgetItems.IsMultiSelectListBox">
  583. <summary>
  584. Whether to allow to select multiple items in Listbox.
  585. </summary>
  586. <returns>Returns whether to allow to select multiple items in Listbox.</returns>
  587. </member>
  588. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidgetItems.AddOptionItem(System.Int32,System.String,System.String)">
  589. <summary>
  590. Inserts item in ListBox or Combobox at the specified index point.
  591. </summary>
  592. <param name="index">Index value of new items</param>
  593. <param name="value">Value of new items</param>
  594. <param name="text"> Text content of new items</param>
  595. <returns>Returns true on success, false on failure</returns>
  596. </member>
  597. <member name="M:ComPDFKit.PDFAnnotation.Form.CPDFWidgetItems.RemoveOptionItem(System.Int32)">
  598. <summary>
  599. Removes item in ListBox or Combobox at the specified index point.
  600. </summary>
  601. <param name="index">Index value of item to be removed.</param>
  602. <returns>Returns true on success, false on failure</returns>
  603. </member>
  604. <member name="T:ComPDFKit.PDFAnnotation.Form.CWidgetItem">
  605. <summary>
  606. Content of items in listbox and combobox form.
  607. </summary>
  608. </member>
  609. <member name="P:ComPDFKit.PDFAnnotation.Form.CWidgetItem.Value">
  610. <summary>
  611. Value of item.
  612. </summary>
  613. </member>
  614. <member name="P:ComPDFKit.PDFAnnotation.Form.CWidgetItem.Text">
  615. <summary>
  616. Text content of item.
  617. </summary>
  618. </member>
  619. <member name="T:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE">
  620. <summary>
  621. Annotation type.
  622. </summary>
  623. </member>
  624. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_UNKOWN">
  625. <summary>
  626. Unknown type.
  627. </summary>
  628. </member>
  629. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_TEXT">
  630. <summary>
  631. Note annotation.
  632. </summary>
  633. </member>
  634. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_LINK">
  635. <summary>
  636. Link annotation.
  637. </summary>
  638. </member>
  639. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_FREETEXT">
  640. <summary>
  641. Freetext annotation.
  642. </summary>
  643. </member>
  644. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_LINE">
  645. <summary>
  646. Line annotation.
  647. </summary>
  648. </member>
  649. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_SQUARE">
  650. <summary>
  651. Square annotation.
  652. </summary>
  653. </member>
  654. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_CIRCLE">
  655. <summary>
  656. Circle annotation.
  657. </summary>
  658. </member>
  659. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_POLYGON">
  660. <summary>
  661. Polygon annotation.(not support currently)
  662. </summary>
  663. </member>
  664. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_POLYLINE">
  665. <summary>
  666. Polyline annotation.(not support currently)
  667. </summary>
  668. </member>
  669. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_HIGHLIGHT">
  670. <summary>
  671. Highlight annotation.
  672. </summary>
  673. </member>
  674. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_UNDERLINE">
  675. <summary>
  676. Underline annotation.
  677. </summary>
  678. </member>
  679. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_SQUIGGLY">
  680. <summary>
  681. Squiggly annotation.
  682. </summary>
  683. </member>
  684. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_STRIKEOUT">
  685. <summary>
  686. Strikeout annotation.
  687. </summary>
  688. </member>
  689. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_STAMP">
  690. <summary>
  691. Stamp annotation.
  692. </summary>
  693. </member>
  694. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_CARET">
  695. <summary>
  696. not support currently.
  697. </summary>
  698. </member>
  699. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_INK">
  700. <summary>
  701. Ink annotation
  702. </summary>
  703. </member>
  704. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_POPUP">
  705. <summary>
  706. Popup annotation.(not support currently)
  707. </summary>
  708. </member>
  709. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_FILEATTACHMENT">
  710. <summary>
  711. File attachment annotation.(not support currently)
  712. </summary>
  713. </member>
  714. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_SOUND">
  715. <summary>
  716. Sound annotation.(not support currently)
  717. </summary>
  718. </member>
  719. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_MOVIE">
  720. <summary>
  721. Movie annotation.(not support currently)
  722. </summary>
  723. </member>
  724. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_WIDGET">
  725. <summary>
  726. Form form.
  727. </summary>
  728. </member>
  729. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_SCREEN">
  730. <summary>
  731. Not support currently.
  732. </summary>
  733. </member>
  734. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_PRINTERMARK">
  735. <summary>
  736. Not support currently.
  737. </summary>
  738. </member>
  739. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_TRAPNET">
  740. <summary>
  741. Not support currently.
  742. </summary>
  743. </member>
  744. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_WATERMARK">
  745. <summary>
  746. Watermark annotation.(not support currently)
  747. </summary>
  748. </member>
  749. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_3D">
  750. <summary>
  751. 3D annotation.(not support currently)
  752. </summary>
  753. </member>
  754. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_RICHMEDIA">
  755. <summary>
  756. Not support currently.
  757. </summary>
  758. </member>
  759. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_REDACT">
  760. <summary>
  761. Not support currently.
  762. </summary>
  763. </member>
  764. <member name="F:ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE.C_ANNOTATION_INTERCHANGE">
  765. <summary>
  766. Not support currently.
  767. </summary>
  768. </member>
  769. <member name="T:ComPDFKit.PDFAnnotation.C_BORDER_STYLE">
  770. <summary>
  771. Border style of annotation.
  772. </summary>
  773. </member>
  774. <member name="F:ComPDFKit.PDFAnnotation.C_BORDER_STYLE.BS_SOLID">
  775. <summary>
  776. Solid line
  777. </summary>
  778. </member>
  779. <member name="F:ComPDFKit.PDFAnnotation.C_BORDER_STYLE.BS_DASHDED">
  780. <summary>
  781. Dashed line
  782. </summary>
  783. </member>
  784. <member name="F:ComPDFKit.PDFAnnotation.C_BORDER_STYLE.BS_BEVELED">
  785. <summary>
  786. Not support currently
  787. </summary>
  788. </member>
  789. <member name="F:ComPDFKit.PDFAnnotation.C_BORDER_STYLE.BS_INSET">
  790. <summary>
  791. Not support currently
  792. </summary>
  793. </member>
  794. <member name="F:ComPDFKit.PDFAnnotation.C_BORDER_STYLE.BS_UNDERLINE">
  795. <summary>
  796. Not support currently
  797. </summary>
  798. </member>
  799. <member name="T:ComPDFKit.PDFAnnotation.CPDFAnnotationFlags">
  800. <summary>
  801. A enum of flags specifying various characteristics of the annotation.
  802. ComPDFKit doesn't support all of those flag settings.
  803. </summary>
  804. </member>
  805. <member name="F:ComPDFKit.PDFAnnotation.CPDFAnnotationFlags.CPDFAnnotationFlagInvisible">
  806. <summary>
  807. [IGNORED] If set, ignore annotation AP stream if there is no handler available.
  808. </summary>
  809. </member>
  810. <member name="F:ComPDFKit.PDFAnnotation.CPDFAnnotationFlags.CPDFAnnotationFlagHidden">
  811. <summary>
  812. If set, do not display or print the annotation or allow it to interact with the user.
  813. </summary>
  814. </member>
  815. <member name="F:ComPDFKit.PDFAnnotation.CPDFAnnotationFlags.CPDFAnnotationFlagPrint">
  816. <summary>
  817. [IGNORED] If set, print the annotation when the page is printed.
  818. </summary>
  819. </member>
  820. <member name="F:ComPDFKit.PDFAnnotation.CPDFAnnotationFlags.CPDFAnnotationFlagNoZoom">
  821. <summary>
  822. [IGNORED] If set, don't scale the annotation’s appearance to match the magnification of the page.
  823. </summary>
  824. </member>
  825. <member name="F:ComPDFKit.PDFAnnotation.CPDFAnnotationFlags.CPDFAnnotationFlagNoRotate">
  826. <summary>
  827. [IGNORED] If set, don't rotate the annotation’s appearance to match the rotation of the page.
  828. </summary>
  829. </member>
  830. <member name="F:ComPDFKit.PDFAnnotation.CPDFAnnotationFlags.CPDFAnnotationFlagNoView">
  831. <summary>
  832. [IGNORED] If set, don't display the annotation on the screen. (But printing might be allowed)
  833. </summary>
  834. </member>
  835. <member name="F:ComPDFKit.PDFAnnotation.CPDFAnnotationFlags.CPDFAnnotationFlagReadOnly">
  836. <summary>
  837. If set, don’t allow the annotation to be deleted or its properties to be modified, including `contents`.
  838. This is ignored for widget annotations (form elements).
  839. For widget annotations the `GetIsReadOnly` property of the associated form field should be used instead.
  840. This flag only restricts the ComPDFKit UI and does not impact programmatic modification of the annotation.
  841. </summary>
  842. </member>
  843. <member name="F:ComPDFKit.PDFAnnotation.CPDFAnnotationFlags.CPDFAnnotationFlagLocked">
  844. <summary>
  845. If set, don’t allow the annotation to be deleted or its properties to be modified, except for `contents`.
  846. </summary>
  847. </member>
  848. <member name="F:ComPDFKit.PDFAnnotation.CPDFAnnotationFlags.CPDFAnnotationFlagToggleNoView">
  849. <summary>
  850. [IGNORED] If set, invert the interpretation of the `.noView` flag for certain events.
  851. </summary>
  852. </member>
  853. <member name="F:ComPDFKit.PDFAnnotation.CPDFAnnotationFlags.CPDFAnnotationFlagLockedContents">
  854. <summary>
  855. [IGNORED] If set, don't allow the `contents` of the annotation to be modified by the user.
  856. </summary>
  857. </member>
  858. <member name="T:ComPDFKit.PDFAnnotation.CPDFAppearanceType">
  859. <summary>
  860. </summary>
  861. </member>
  862. <member name="T:ComPDFKit.PDFAnnotation.CPDFAnnotation">
  863. <summary>
  864. An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.PDF includes a wide variety of standard annotation types.
  865. Class Annot is the base class for all kinds of PDF annotations.It offers the base functions to get/set annotation's common properties, to move an annotation or reset appearance stream of an annotation. For concrete annotation types, please refer to derived classes. To get the count of annotations or get/add/remove an annotation, please refer to class CPDFPage.
  866. This class object can also be used to construct objects of other classes in order to do some more operation in annotation or access specified information of annotation.
  867. </summary>
  868. </member>
  869. <member name="P:ComPDFKit.PDFAnnotation.CPDFAnnotation.Page">
  870. <summary>
  871. Returns the page that the annotation is associated with.
  872. </summary>
  873. </member>
  874. <member name="P:ComPDFKit.PDFAnnotation.CPDFAnnotation.Type">
  875. <summary>
  876. Gets annotation type.
  877. </summary>
  878. </member>
  879. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.IsValid">
  880. <summary>
  881. Whether the object is valid.
  882. </summary>
  883. <returns>Returns true if valid, otherwise false</returns>
  884. </member>
  885. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.ReleaseAnnot">
  886. <summary>
  887. Releases resources of the object.
  888. </summary>
  889. </member>
  890. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetRect(ComPDFKit.Import.CRect)">
  891. <summary>
  892. Sets rectangle on the page.
  893. </summary>
  894. <param name="rect"> Rectangle on the page</param>
  895. <returns>Returns true on success, false on failure</returns>
  896. </member>
  897. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetRect">
  898. <summary>
  899. Gets rectangle on the page.
  900. </summary>
  901. <returns>Page rectangle area</returns>
  902. </member>
  903. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetFlags">
  904. <summary>
  905. Returns the flag of the annotation.
  906. </summary>
  907. <returns>The flag of the annotation.</returns>
  908. </member>
  909. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetFlags(System.Int32)">
  910. <summary>
  911. Sets the flag of the annotation.
  912. </summary>
  913. <param name="flags">The flag of the annotation.</param>
  914. <returns>Returns true on success, false on failure.</returns>
  915. </member>
  916. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetIsHidden">
  917. <summary>
  918. This is a convenience property that checks for `CPDFAnnotationFlagHidden` in `flags`.
  919. </summary>
  920. <returns></returns>
  921. </member>
  922. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetIsHidden(System.Boolean)">
  923. <summary>
  924. This is a convenience property that checks for `CPDFAnnotationFlagHidden` in `flags`.
  925. </summary>
  926. <param name="isHidden"></param>
  927. <returns></returns>
  928. </member>
  929. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetIsReadOnly">
  930. <summary>
  931. This is a convenience property that checks for `CPDFAnnotationFlagReadOnly` in `flags`.
  932. </summary>
  933. <returns></returns>
  934. </member>
  935. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetIsReadOnly(System.Boolean)">
  936. <summary>
  937. This is a convenience property that checks for `CPDFAnnotationFlagReadOnly` in `flags`.
  938. </summary>
  939. <param name="isReadOnly"></param>
  940. <returns></returns>
  941. </member>
  942. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetIsLocked">
  943. <summary>
  944. This is a convenience property that checks for `CPDFAnnotationFlagLocked` in `flags`.
  945. </summary>
  946. <returns></returns>
  947. </member>
  948. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetIsLocked(System.Boolean)">
  949. <summary>
  950. This is a convenience property that checks for `CPDFAnnotationFlagLocked` in `flags`.
  951. </summary>
  952. <param name="isLocked"></param>
  953. <returns></returns>
  954. </member>
  955. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetBorderWidth(System.Single)">
  956. <summary>
  957. Sets border width of the annotation.
  958. </summary>
  959. <param name="borderWidth">Border width</param>
  960. <returns>Returns true on success, false on failure.</returns>
  961. </member>
  962. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetBorderWidth">
  963. <summary>
  964. Gets border width of the annotation.
  965. </summary>
  966. <returns>Annotation border width</returns>
  967. </member>
  968. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetRGBColor(System.Byte[])">
  969. <summary>
  970. Sets annotation color.
  971. </summary>
  972. <param name="color">RGB color value</param>
  973. <returns>Returns true on success, false on failure</returns>
  974. </member>
  975. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetRGBColor">
  976. <summary>
  977. Gets annotation color.
  978. </summary>
  979. <returns>RGB color</returns>
  980. </member>
  981. <!-- Badly formed XML comment ignored for member "M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetTransparency(System.Byte)" -->
  982. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetTransparency">
  983. <summary>
  984. Gets annotation opacity.
  985. </summary>
  986. <returns>Annotation opacity</returns>
  987. </member>
  988. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetFilledRGBColor(System.Byte[])">
  989. <summary>
  990. Sets annotation fill color.
  991. </summary>
  992. <param name="filledColor">Color</param>
  993. <returns>Returns true on success, false on failure</returns>
  994. </member>
  995. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetFilledRGBColor(System.Byte[]@)">
  996. <summary>
  997. Gets annotation fill color.
  998. </summary>
  999. <param name="filledColor">Color</param>
  1000. <returns>Returns true on success, false on failure</returns>
  1001. </member>
  1002. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetFilledTransparency(System.Byte)">
  1003. <summary>
  1004. Sets annotation fill color opacity.
  1005. </summary>
  1006. <param name="transparency">Opacity</param>
  1007. <returns>Returns true on success, false on failure</returns>
  1008. </member>
  1009. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetFilledTransparency">
  1010. <summary>
  1011. Sets fill color opacity.
  1012. </summary>
  1013. <returns>Opaicty</returns>
  1014. </member>
  1015. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.ClearFilledRGBColor">
  1016. <summary>
  1017. Clears fill RGB color.
  1018. </summary>
  1019. <returns>Returns true on success, false on failure</returns>
  1020. </member>
  1021. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.ClearFilledTransparency">
  1022. <summary>
  1023. Clears fill color opacity.
  1024. </summary>
  1025. <returns>Returns true on success, false on failure</returns>
  1026. </member>
  1027. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetContent(System.String)">
  1028. <summary>
  1029. Sets annotation content.
  1030. </summary>
  1031. <param name="content">Content</param>
  1032. <returns>Returns true on success, false on failure</returns>
  1033. </member>
  1034. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetContent">
  1035. <summary>
  1036. Gets annotation content.
  1037. </summary>
  1038. <returns>Content</returns>
  1039. </member>
  1040. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetCreationDate(System.String)">
  1041. <summary>
  1042. Sets the creation date of annotation.
  1043. </summary>
  1044. <param name="date">Date</param>
  1045. <returns>Returns true on success, false on failure</returns>
  1046. </member>
  1047. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetCreationDate">
  1048. <summary>
  1049. Gets the creation date of annotation.
  1050. </summary>
  1051. <returns>Date</returns>
  1052. </member>
  1053. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetModifyDate(System.String)">
  1054. <summary>
  1055. Sets the modification date of annotation.
  1056. </summary>
  1057. <param name="date">Date</param>
  1058. <returns>Returns true on success, false on failure</returns>
  1059. </member>
  1060. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetModifyDate">
  1061. <summary>
  1062. Gets the modification date of annotation.
  1063. </summary>
  1064. <returns>Date</returns>
  1065. </member>
  1066. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetTitle(System.String)">
  1067. <summary>
  1068. Sets annotation author.
  1069. </summary>
  1070. <param name="title">Author</param>
  1071. <returns>Returns true on success, false on failure</returns>
  1072. </member>
  1073. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetTitle">
  1074. <summary>
  1075. Gets annotation author.
  1076. </summary>
  1077. <returns>Annotation author</returns>
  1078. </member>
  1079. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.UpdateAp">
  1080. <summary>
  1081. Updates annotation appearance.
  1082. </summary>
  1083. <returns>Returns true on success, false on failure</returns>
  1084. </member>
  1085. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.UpdateApWithBitmap(System.Byte[],System.Int32,System.Int32,System.Int32)">
  1086. <summary>
  1087. Upadates annotation appearance by Bitmap.
  1088. </summary>
  1089. <param name="imageData">Image data</param>
  1090. <param name="imageWidth">Image width</param>
  1091. <param name="imageHeight">Image height</param>
  1092. <param name="rotation">Rotation value</param>
  1093. <returns>Returns true on success, false on failure</returns>
  1094. </member>
  1095. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.RenderAnnot(System.Int32,System.Int32,System.Byte[],ComPDFKit.PDFAnnotation.CPDFAppearanceType)">
  1096. <summary>
  1097. Renders contents of the annotation to image.
  1098. </summary>
  1099. <param name="width">Annotation width</param>
  1100. <param name="height">Annotation height</param>
  1101. <param name="bmp_data">Image data</param>
  1102. <param name="type">Appearance type</param>
  1103. </member>
  1104. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.RenderAnnot(System.Int32,System.Int32,System.IntPtr,ComPDFKit.PDFAnnotation.CPDFAppearanceType)">
  1105. <summary>
  1106. Renders contents of the annotation to image.
  1107. </summary>
  1108. <param name="width">Annotation width</param>
  1109. <param name="height">Annotation height</param>
  1110. <param name="bmp_data">Image data handle</param>
  1111. <param name="type">Appearance type</param>
  1112. </member>
  1113. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetTextAttribute">
  1114. <summary>
  1115. Gets annotation text attribute, more:<see cref="T:ComPDFKit.PDFAnnotation.CTextAttribute"/>
  1116. </summary>
  1117. <returns>Text attribute</returns>
  1118. </member>
  1119. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetTextAttribute(ComPDFKit.PDFAnnotation.CTextAttribute)">
  1120. <summary>
  1121. Sets text attribute of annotation, more:<see cref="T:ComPDFKit.PDFAnnotation.CTextAttribute"/>
  1122. </summary>
  1123. <param name="textAttribute">Text attribute</param>
  1124. <returns>Returns true on success, false on failure</returns>
  1125. </member>
  1126. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetAuthor">
  1127. <summary>
  1128. Gets the author of annotation.
  1129. </summary>
  1130. <returns>Author</returns>
  1131. </member>
  1132. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.SetAuthor(System.String)">
  1133. <summary>
  1134. Sets the author of annotation.
  1135. </summary>
  1136. <param name="author">Author</param>
  1137. <returns>Returns true on success, false on failure</returns>
  1138. </member>
  1139. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.RemoveAnnot">
  1140. <summary>
  1141. Removes annotation.
  1142. </summary>
  1143. <returns>Returns true on success, false on failure</returns>
  1144. </member>
  1145. <member name="M:ComPDFKit.PDFAnnotation.CPDFAnnotation.GetRotation">
  1146. <summary>
  1147. Gets rotation angle of annotaton appearance.
  1148. </summary>
  1149. <returns>Rotation angle</returns>
  1150. </member>
  1151. <member name="T:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation">
  1152. <summary>
  1153. Circle annotation is an ellipse on the page. Despite the name "circle", a circle annotation can represent either a circle or a oval, which means the width and height of the annotation rectangle need not be equal.
  1154. </summary>
  1155. </member>
  1156. <member name="P:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.LineColor">
  1157. <summary>
  1158. Gets the border color.
  1159. </summary>
  1160. </member>
  1161. <member name="P:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.BgColor">
  1162. <summary>
  1163. Gets the background color.
  1164. </summary>
  1165. </member>
  1166. <member name="P:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.Transparency">
  1167. <summary>
  1168. Gets the border opacity.
  1169. </summary>
  1170. </member>
  1171. <member name="P:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.HasBgColor">
  1172. <summary>
  1173. Whether the background color exists.
  1174. </summary>
  1175. </member>
  1176. <member name="P:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.LineWidth">
  1177. <summary>
  1178. Gets the border width.
  1179. </summary>
  1180. </member>
  1181. <member name="P:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.Rect">
  1182. <summary>
  1183. Gets annotation rectangle. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window.
  1184. </summary>
  1185. </member>
  1186. <member name="P:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.BorderStyle">
  1187. <summary>
  1188. Gets the border style.
  1189. </summary>
  1190. </member>
  1191. <member name="P:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.Dash">
  1192. <summary>
  1193. Gets the line dash array.
  1194. </summary>
  1195. </member>
  1196. <member name="M:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.SetLineColor(System.Byte[])">
  1197. <summary>
  1198. Sets the border color.
  1199. </summary>
  1200. <param name="lineColor">RGB color value, range0-255</param>
  1201. <returns>Returns true on success, false on failure</returns>
  1202. </member>
  1203. <member name="M:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.SetBgColor(System.Byte[])">
  1204. <summary>
  1205. Sets the background color.
  1206. </summary>
  1207. <param name="bgColor">RGB color value, range0-255</param>
  1208. <returns>Returns true on success, false on failure</returns>
  1209. </member>
  1210. <member name="M:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.SetTransparency(System.Byte)">
  1211. <summary>
  1212. Sets color opacity.
  1213. </summary>
  1214. <param name="transparency">Color opacity, range0-255</param>
  1215. <returns>Returns true on success, false on failure</returns>
  1216. </member>
  1217. <member name="M:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.ClearBgColor">
  1218. <summary>
  1219. Clears background color.
  1220. </summary>
  1221. <returns>Returns true on success, false on failure</returns>
  1222. </member>
  1223. <member name="M:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.SetLineWidth(System.Single)">
  1224. <summary>
  1225. Sets the border width.
  1226. </summary>
  1227. <param name="lineWidth">Border width</param>
  1228. <returns>Returns true on success, false on failure</returns>
  1229. </member>
  1230. <member name="M:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.SetRect(ComPDFKit.Import.CRect)">
  1231. <summary>
  1232. Sets the rectangle of circle on the page.
  1233. </summary>
  1234. <param name="rect">Rectangle on the page</param>
  1235. <returns>Returns true on success, false on failure</returns>
  1236. </member>
  1237. <member name="M:ComPDFKit.PDFAnnotation.CPDFCircleAnnotation.SetBorderStyle(ComPDFKit.PDFAnnotation.C_BORDER_STYLE,System.Single[])">
  1238. <summary>
  1239. Sets the border style.
  1240. </summary>
  1241. <param name="bs">Border style</param>
  1242. <param name="dash">Sets the line dash array.</param>
  1243. <returns>Returns true on success, false on failure</returns>
  1244. </member>
  1245. <member name="T:ComPDFKit.PDFAnnotation.C_TEXT_ALIGNMENT">
  1246. <summary>
  1247. Text alignment.
  1248. </summary>
  1249. </member>
  1250. <member name="F:ComPDFKit.PDFAnnotation.C_TEXT_ALIGNMENT.ALIGNMENT_UNKNOW">
  1251. <summary>
  1252. Unknown type.
  1253. </summary>
  1254. </member>
  1255. <member name="F:ComPDFKit.PDFAnnotation.C_TEXT_ALIGNMENT.ALIGNMENT_LEFT">
  1256. <summary>
  1257. Left alignment.
  1258. </summary>
  1259. </member>
  1260. <member name="F:ComPDFKit.PDFAnnotation.C_TEXT_ALIGNMENT.ALIGNMENT_CENTER">
  1261. <summary>
  1262. Center alignment.
  1263. </summary>
  1264. </member>
  1265. <member name="F:ComPDFKit.PDFAnnotation.C_TEXT_ALIGNMENT.ALIGNMENT_RIGHT">
  1266. <summary>
  1267. Right alignment.
  1268. </summary>
  1269. </member>
  1270. <member name="T:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation">
  1271. <summary>
  1272. A free text annotation displays text directly on the page.
  1273. </summary>
  1274. </member>
  1275. <member name="P:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.FreeTextDa">
  1276. <summary>
  1277. Gets Freetext font style, more:<see cref="T:ComPDFKit.PDFAnnotation.CTextAttribute"/>
  1278. </summary>
  1279. </member>
  1280. <member name="P:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.Alignment">
  1281. <summary>
  1282. Gets text alignment of Freetext.
  1283. </summary>
  1284. </member>
  1285. <member name="P:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.LineColor">
  1286. <summary>
  1287. Border color.
  1288. </summary>
  1289. </member>
  1290. <member name="P:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.BgColor">
  1291. <summary>
  1292. Background color.
  1293. </summary>
  1294. </member>
  1295. <member name="P:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.Transparency">
  1296. <summary>
  1297. Opacity.
  1298. </summary>
  1299. </member>
  1300. <member name="P:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.HasBgColor">
  1301. <summary>
  1302. Whether the background color exists.
  1303. </summary>
  1304. </member>
  1305. <member name="P:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.LineWidth">
  1306. <summary>
  1307. Border width.
  1308. </summary>
  1309. </member>
  1310. <member name="P:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.Rect">
  1311. <summary>
  1312. Gets the rectangle of FreeText annotation on the page.
  1313. </summary>
  1314. </member>
  1315. <member name="P:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.Content">
  1316. <summary>
  1317. Gets content of FreeText annotation.
  1318. </summary>
  1319. </member>
  1320. <member name="M:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.SetFreetextDa(ComPDFKit.PDFAnnotation.CTextAttribute)">
  1321. <summary>
  1322. Sets Freetext font style, more:<see cref="T:ComPDFKit.PDFAnnotation.CTextAttribute"/>
  1323. </summary>
  1324. <param name="freetextDa">Text attribute</param>
  1325. <returns>Returns true on success, false on failure</returns>
  1326. </member>
  1327. <member name="M:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.SetFreetextAlignment(ComPDFKit.PDFAnnotation.C_TEXT_ALIGNMENT)">
  1328. <summary>
  1329. Sets text alignment of Freetext.
  1330. </summary>
  1331. <param name="alignment">Text alignmnent</param>
  1332. <returns>Returns true on success, false on failure</returns>
  1333. </member>
  1334. <member name="M:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.SetLineWidth(System.Single)">
  1335. <summary>
  1336. Sets border width.
  1337. </summary>
  1338. <param name="lineWidth">Border width</param>
  1339. <returns>Returns true on success, false on failure</returns>
  1340. </member>
  1341. <member name="M:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.SetTransparency(System.Byte)">
  1342. <summary>
  1343. Sets opacity.
  1344. </summary>
  1345. <param name="transparency">Color opacity, range 0-255</param>
  1346. <returns>Returns true on success, false on failure</returns>
  1347. </member>
  1348. <member name="M:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.SetLineColor(System.Byte[])">
  1349. <summary>
  1350. Sets border color.
  1351. </summary>
  1352. <param name="lineColor">RGB color value, range0-255</param>
  1353. <returns>Returns true on success, false on failure</returns>
  1354. </member>
  1355. <member name="M:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.SetBgColor(System.Byte[])">
  1356. <summary>
  1357. Sets background color.
  1358. </summary>
  1359. <param name="bgColor">RGB color value, range0-255</param>
  1360. <returns>Returns true on success, false on failure</returns>
  1361. </member>
  1362. <member name="M:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.ClearBgColor">
  1363. <summary>
  1364. Clears background color.
  1365. </summary>
  1366. <returns>Returns true on success, false on failure</returns>
  1367. </member>
  1368. <member name="M:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.SetRect(ComPDFKit.Import.CRect)">
  1369. <summary>
  1370. Sets annotation rectangle. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window.
  1371. </summary>
  1372. <param name="rect">PDF page rectangle area</param>
  1373. <returns>Returns true on success, false on failure</returns>
  1374. </member>
  1375. <member name="M:ComPDFKit.PDFAnnotation.CPDFFreeTextAnnotation.SetContent(System.String)">
  1376. <summary>
  1377. Sets content of FreeText annotation.
  1378. </summary>
  1379. <param name="content">Text content</param>
  1380. <returns>Returns true on success, false on failure</returns>
  1381. </member>
  1382. <member name="T:ComPDFKit.PDFAnnotation.CPDFHighlightAnnotation">
  1383. <summary>
  1384. Highlight annotation is a kind of text markup annotation, which is shown as a highlight area for the text in a PDF document.
  1385. </summary>
  1386. </member>
  1387. <member name="T:ComPDFKit.PDFAnnotation.CPDFInkAnnotation">
  1388. <summary>
  1389. Ink annotation.
  1390. </summary>
  1391. </member>
  1392. <!-- Badly formed XML comment ignored for member "P:ComPDFKit.PDFAnnotation.CPDFInkAnnotation.InkPath" -->
  1393. <member name="P:ComPDFKit.PDFAnnotation.CPDFInkAnnotation.Rect">
  1394. <summary>
  1395. Gets annotation rectangle. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window.
  1396. </summary>
  1397. </member>
  1398. <member name="P:ComPDFKit.PDFAnnotation.CPDFInkAnnotation.InkColor">
  1399. <summary>
  1400. Gets color.
  1401. </summary>
  1402. </member>
  1403. <member name="P:ComPDFKit.PDFAnnotation.CPDFInkAnnotation.Transparency">
  1404. <summary>
  1405. Gets opacity.
  1406. </summary>
  1407. </member>
  1408. <member name="P:ComPDFKit.PDFAnnotation.CPDFInkAnnotation.Thickness">
  1409. <summary>
  1410. Gets border width of ink annotation.
  1411. </summary>
  1412. </member>
  1413. <member name="P:ComPDFKit.PDFAnnotation.CPDFInkAnnotation.BorderStyle">
  1414. <summary>
  1415. Gets the border style.
  1416. </summary>
  1417. </member>
  1418. <member name="P:ComPDFKit.PDFAnnotation.CPDFInkAnnotation.Dash">
  1419. <summary>
  1420. Gets the line dash array.
  1421. </summary>
  1422. </member>
  1423. <!-- Badly formed XML comment ignored for member "M:ComPDFKit.PDFAnnotation.CPDFInkAnnotation.SetInkPath(System.Collections.Generic.List{System.Collections.Generic.List{ComPDFKit.Import.CPoint}})" -->
  1424. <member name="M:ComPDFKit.PDFAnnotation.CPDFInkAnnotation.SetInkColor(System.Byte[])">
  1425. <summary>
  1426. Sets color.
  1427. </summary>
  1428. <param name="inkColor">RGB color value, range0-255</param>
  1429. <returns>Returns true on success, false on failure</returns>
  1430. </member>
  1431. <member name="M:ComPDFKit.PDFAnnotation.CPDFInkAnnotation.SetTransparency(System.Byte)">
  1432. <summary>
  1433. Sets opacity.
  1434. </summary>
  1435. <param name="transparency">Color opacity, range0-255</param>
  1436. <returns>Returns true on success, false on failure</returns>
  1437. </member>
  1438. <member name="M:ComPDFKit.PDFAnnotation.CPDFInkAnnotation.SetThickness(System.Single)">
  1439. <summary>
  1440. Sets border width of ink annotation.
  1441. </summary>
  1442. <param name="thickness">Line width</param>
  1443. <returns>Returns true on success, false on failure</returns>
  1444. </member>
  1445. <member name="M:ComPDFKit.PDFAnnotation.CPDFInkAnnotation.SetRect(ComPDFKit.Import.CRect)">
  1446. <summary>
  1447. Sets annotation rectangle. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window.
  1448. </summary>
  1449. <param name="rect">Page rectangle area</param>
  1450. <returns>Returns true on success, false on failure</returns>
  1451. </member>
  1452. <member name="M:ComPDFKit.PDFAnnotation.CPDFInkAnnotation.SetInkRect(ComPDFKit.Import.CRect)">
  1453. <summary>
  1454. Sets rectangle of ink annotation on the page.
  1455. </summary>
  1456. <param name="rect">Rectangle on the page</param>
  1457. <returns>Returns true on success, false on failure</returns>
  1458. </member>
  1459. <member name="M:ComPDFKit.PDFAnnotation.CPDFInkAnnotation.SetBorderStyle(ComPDFKit.PDFAnnotation.C_BORDER_STYLE,System.Single[])">
  1460. <summary>
  1461. Sets the border style.
  1462. </summary>
  1463. <param name="bs">Border style</param>
  1464. <param name="dash">Sets the line dash array.</param>
  1465. <returns>Returns true on success, false on failure</returns>
  1466. </member>
  1467. <member name="T:ComPDFKit.PDFAnnotation.C_LINE_TYPE">
  1468. <summary>
  1469. Start and end point type of line.
  1470. </summary>
  1471. </member>
  1472. <member name="F:ComPDFKit.PDFAnnotation.C_LINE_TYPE.LINETYPE_UNKNOWN">
  1473. <summary>
  1474. Unknown type
  1475. </summary>
  1476. </member>
  1477. <member name="F:ComPDFKit.PDFAnnotation.C_LINE_TYPE.LINETYPE_NONE">
  1478. <summary>
  1479. Line(no arrow type)
  1480. </summary>
  1481. </member>
  1482. <member name="F:ComPDFKit.PDFAnnotation.C_LINE_TYPE.LINETYPE_ARROW">
  1483. <summary>
  1484. Hollow arrow type
  1485. </summary>
  1486. </member>
  1487. <member name="F:ComPDFKit.PDFAnnotation.C_LINE_TYPE.LINETYPE_CLOSEDARROW">
  1488. <summary>
  1489. Solid arrow type
  1490. </summary>
  1491. </member>
  1492. <member name="F:ComPDFKit.PDFAnnotation.C_LINE_TYPE.LINETYPE_SQUARE">
  1493. <summary>
  1494. Square type
  1495. </summary>
  1496. </member>
  1497. <member name="F:ComPDFKit.PDFAnnotation.C_LINE_TYPE.LINETYPE_CIRCLE">
  1498. <summary>
  1499. Circle type
  1500. </summary>
  1501. </member>
  1502. <member name="F:ComPDFKit.PDFAnnotation.C_LINE_TYPE.LINETYPE_DIAMOND">
  1503. <summary>
  1504. Diamond type
  1505. </summary>
  1506. </member>
  1507. <member name="F:ComPDFKit.PDFAnnotation.C_LINE_TYPE.LINETYPE_BUTT">
  1508. <summary>
  1509. Butt type
  1510. </summary>
  1511. </member>
  1512. <member name="F:ComPDFKit.PDFAnnotation.C_LINE_TYPE.LINETYPE_ROPENARROW">
  1513. <summary>
  1514. Reverse hollow arrow type
  1515. </summary>
  1516. </member>
  1517. <member name="F:ComPDFKit.PDFAnnotation.C_LINE_TYPE.LINETYPE_RCLOSEDARROW">
  1518. <summary>
  1519. Reverse solid arrow type
  1520. </summary>
  1521. </member>
  1522. <member name="F:ComPDFKit.PDFAnnotation.C_LINE_TYPE.LINETYPE_SLASH">
  1523. <summary>
  1524. Slash type
  1525. </summary>
  1526. </member>
  1527. <member name="T:ComPDFKit.PDFAnnotation.CPDFLineAnnotation">
  1528. <summary>
  1529. A CPDFLineAnnotation object displays a single line on a page.
  1530. </summary>
  1531. </member>
  1532. <member name="P:ComPDFKit.PDFAnnotation.CPDFLineAnnotation.HeadLineType">
  1533. <summary>
  1534. Line style for the starting point of the line, more:<see cref="T:ComPDFKit.PDFAnnotation.C_LINE_TYPE"/>
  1535. </summary>
  1536. </member>
  1537. <member name="P:ComPDFKit.PDFAnnotation.CPDFLineAnnotation.TailLineType">
  1538. <summary>
  1539. Line style for the ending point of the line, more: <see cref="T:ComPDFKit.PDFAnnotation.C_LINE_TYPE"/>
  1540. </summary>
  1541. </member>
  1542. <member name="P:ComPDFKit.PDFAnnotation.CPDFLineAnnotation.LineColor">
  1543. <summary>
  1544. Gets line color.
  1545. </summary>
  1546. </member>
  1547. <member name="P:ComPDFKit.PDFAnnotation.CPDFLineAnnotation.Transparency">
  1548. <summary>
  1549. Gets line opacity.
  1550. </summary>
  1551. </member>
  1552. <member name="P:ComPDFKit.PDFAnnotation.CPDFLineAnnotation.LineWidth">
  1553. <summary>
  1554. Gets line width.
  1555. </summary>
  1556. </member>
  1557. <member name="P:ComPDFKit.PDFAnnotation.CPDFLineAnnotation.Points">
  1558. <summary>
  1559. Gets start point and end point of the line.
  1560. </summary>
  1561. </member>
  1562. <member name="P:ComPDFKit.PDFAnnotation.CPDFLineAnnotation.BorderStyle">
  1563. <summary>
  1564. Gets border style.
  1565. </summary>
  1566. </member>
  1567. <member name="P:ComPDFKit.PDFAnnotation.CPDFLineAnnotation.Dash">
  1568. <summary>
  1569. Gets the line dash array.
  1570. </summary>
  1571. </member>
  1572. <member name="M:ComPDFKit.PDFAnnotation.CPDFLineAnnotation.SetLinePoints(ComPDFKit.Import.CPoint,ComPDFKit.Import.CPoint)">
  1573. <summary>
  1574. Sets start point and end point of the line.
  1575. </summary>
  1576. <param name="startPoint">Start point</param>
  1577. <param name="endPoint">End point</param>
  1578. <returns>Returns true on success, false on failure</returns>
  1579. </member>
  1580. <member name="M:ComPDFKit.PDFAnnotation.CPDFLineAnnotation.SetLineType(ComPDFKit.PDFAnnotation.C_LINE_TYPE,ComPDFKit.PDFAnnotation.C_LINE_TYPE)">
  1581. <summary>
  1582. Sets the line style for the starting point and ending point of the line, more:<see cref="T:ComPDFKit.PDFAnnotation.C_LINE_TYPE"/>
  1583. </summary>
  1584. <param name="startType">Start point type</param>
  1585. <param name="endType">End point type</param>
  1586. <returns>Returns true on success, false on failure</returns>
  1587. </member>
  1588. <member name="M:ComPDFKit.PDFAnnotation.CPDFLineAnnotation.SetLineColor(System.Byte[])">
  1589. <summary>
  1590. Sets line color.
  1591. </summary>
  1592. <param name="lineColor">RGB color value, range0-255</param>
  1593. <returns>Returns true on success, false on failure</returns>
  1594. </member>
  1595. <member name="M:ComPDFKit.PDFAnnotation.CPDFLineAnnotation.SetTransparency(System.Byte)">
  1596. <summary>
  1597. Sets color opacity.
  1598. </summary>
  1599. <param name="transparency">Color opacity, range0-255</param>
  1600. <returns>Returns true on success, false on failure</returns>
  1601. </member>
  1602. <member name="M:ComPDFKit.PDFAnnotation.CPDFLineAnnotation.SetLineWidth(System.Single)">
  1603. <summary>
  1604. Sets line width.
  1605. </summary>
  1606. <param name="lineWidth">Line width</param>
  1607. <returns>Returns true on success, false on failure</returns>
  1608. </member>
  1609. <member name="M:ComPDFKit.PDFAnnotation.CPDFLineAnnotation.SetBorderStyle(ComPDFKit.PDFAnnotation.C_BORDER_STYLE,System.Single[])">
  1610. <summary>
  1611. Sets border style.
  1612. </summary>
  1613. <param name="bs">Line style</param>
  1614. <param name="dash">Sets the line dash array</param>
  1615. <returns>Returns true on success, false on failure</returns>
  1616. </member>
  1617. <member name="T:ComPDFKit.PDFAnnotation.CPDFLinkAnnotation">
  1618. <summary>
  1619. A link annotation represents an action to be performed.
  1620. </summary>
  1621. </member>
  1622. <member name="M:ComPDFKit.PDFAnnotation.CPDFLinkAnnotation.SetLinkAction(ComPDFKit.PDFDocument.Action.CPDFAction)">
  1623. <summary>
  1624. Sets the response action of the link annotation. There are multiple subtypes of the action, and different actions are determined according to<see cref="T:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE"/>, the action type can be obtained through <see cref="P:ComPDFKit.PDFDocument.Action.CPDFAction.ActionType"/>, more:<see cref="T:ComPDFKit.PDFDocument.Action.CPDFAction"/>
  1625. </summary>
  1626. <param name="action">Response action of link annotation</param>
  1627. <returns>Returns true on success, false on failure</returns>
  1628. </member>
  1629. <member name="M:ComPDFKit.PDFAnnotation.CPDFLinkAnnotation.GetLinkAction">
  1630. <summary>
  1631. Gets the response action of the link annotation. There are multiple subtypes of the action, and different actions are determined according to<see cref="T:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE"/>, the action type can be obtained through<see cref="P:ComPDFKit.PDFDocument.Action.CPDFAction.ActionType"/> ,more:<see cref="T:ComPDFKit.PDFDocument.Action.CPDFAction"/>
  1632. </summary>
  1633. <returns>Returns the response action of link annotatiion, more:<see cref="T:ComPDFKit.PDFDocument.Action.CPDFAction"/></returns>
  1634. </member>
  1635. <member name="M:ComPDFKit.PDFAnnotation.CPDFLinkAnnotation.GetDestination(ComPDFKit.PDFDocument.CPDFDocument)">
  1636. <summary>
  1637. Gets link information of document, more:<see cref="T:ComPDFKit.PDFDocument.CPDFDestination"/>
  1638. </summary>
  1639. <param name="document">This class is about CPDFDocument, one CPDFDocument class for one document</param>
  1640. <returns>Returns link information of document.</returns>
  1641. </member>
  1642. <member name="M:ComPDFKit.PDFAnnotation.CPDFLinkAnnotation.SetDestination(ComPDFKit.PDFDocument.CPDFDocument,ComPDFKit.PDFDocument.CPDFDestination)">
  1643. <summary>
  1644. Sets link information of document, more:<see cref="T:ComPDFKit.PDFDocument.CPDFDestination"/>
  1645. </summary>
  1646. <param name="document">This class is about CPDFDocument, one CPDFDocument class for one document.</param>
  1647. <param name="dest">Returns detailed imformation of destination page</param>
  1648. <returns>Returns true on success, false on failure</returns>
  1649. </member>
  1650. <member name="M:ComPDFKit.PDFAnnotation.CPDFLinkAnnotation.ReleaseAnnot">
  1651. <summary>
  1652. When the annotation is no longer in use, call this function to release resources.
  1653. </summary>
  1654. </member>
  1655. <member name="T:ComPDFKit.PDFAnnotation.CPDFMarkupAnnotation">
  1656. <summary>
  1657. Markup annotations are used primarily to mark up PDF documents. These annotations have text that appears as part of the annotation and may be displayed in other ways by a viewer application, such as in a Comments pane. Markup base class includes sub class: highlight, underline, strikeout, squiggly.
  1658. </summary>
  1659. </member>
  1660. <member name="P:ComPDFKit.PDFAnnotation.CPDFMarkupAnnotation.Color">
  1661. <summary>
  1662. Gets color.
  1663. </summary>
  1664. </member>
  1665. <member name="P:ComPDFKit.PDFAnnotation.CPDFMarkupAnnotation.Transparency">
  1666. <summary>
  1667. Gets opacity.
  1668. </summary>
  1669. </member>
  1670. <member name="P:ComPDFKit.PDFAnnotation.CPDFMarkupAnnotation.QuardRects">
  1671. <summary>
  1672. Gets the array of quadrilateral points defining the bounds of the markup.
  1673. </summary>
  1674. </member>
  1675. <member name="P:ComPDFKit.PDFAnnotation.CPDFMarkupAnnotation.Rect">
  1676. <summary>
  1677. Gets the rectangle of the annotation on the page.
  1678. </summary>
  1679. </member>
  1680. <member name="M:ComPDFKit.PDFAnnotation.CPDFMarkupAnnotation.SetQuardRects(System.Collections.Generic.List{ComPDFKit.Import.CRect})">
  1681. <summary>
  1682. Sets the array of quadrilateral points defining the bounds of the markup.
  1683. </summary>
  1684. <param name="rects">Page area list </param>
  1685. <returns>Returns true on success, false on failure</returns>
  1686. </member>
  1687. <member name="M:ComPDFKit.PDFAnnotation.CPDFMarkupAnnotation.SetColor(System.Byte[])">
  1688. <summary>
  1689. Sets color.
  1690. </summary>
  1691. <param name="color">RGB color value,range0-255</param>
  1692. <returns>Returns true on success, false on failure</returns>
  1693. </member>
  1694. <member name="M:ComPDFKit.PDFAnnotation.CPDFMarkupAnnotation.SetTransparency(System.Byte)">
  1695. <summary>
  1696. Sets opacity.
  1697. </summary>
  1698. <param name="transparency">Color opacity,range0-255</param>
  1699. <returns>Returns true on success, false on failure</returns>
  1700. </member>
  1701. <member name="T:ComPDFKit.PDFAnnotation.C_MEDIASOURCE_TYPE">
  1702. <summary>
  1703. </summary>
  1704. </member>
  1705. <member name="F:ComPDFKit.PDFAnnotation.C_MEDIASOURCE_TYPE.MEDIA_SRC_TYPE_UNKNOWN">
  1706. <summary>
  1707. </summary>
  1708. </member>
  1709. <member name="F:ComPDFKit.PDFAnnotation.C_MEDIASOURCE_TYPE.MEDIA_SRC_TYPE_URL">
  1710. <summary>
  1711. </summary>
  1712. </member>
  1713. <member name="F:ComPDFKit.PDFAnnotation.C_MEDIASOURCE_TYPE.MEDIA_SRC_TYPE_STREAM">
  1714. <summary>
  1715. </summary>
  1716. </member>
  1717. <member name="T:ComPDFKit.PDFAnnotation.CPDFMovieAnnotation">
  1718. <summary>
  1719. A CPDFMovieAnnotation object contains animated graphics and sound
  1720. to be presented on the computer screen and through the speakers.
  1721. </summary>
  1722. </member>
  1723. <member name="M:ComPDFKit.PDFAnnotation.CPDFMovieAnnotation.GetMediaSrcType">
  1724. <summary>
  1725. </summary>
  1726. <returns></returns>
  1727. </member>
  1728. <member name="M:ComPDFKit.PDFAnnotation.CPDFMovieAnnotation.LoadRichMediaSource(System.String,System.String)">
  1729. <summary>
  1730. </summary>
  1731. <param name="richmediaFilePath"></param>
  1732. <param name="richmediaName"></param>
  1733. <returns></returns>
  1734. </member>
  1735. <member name="M:ComPDFKit.PDFAnnotation.CPDFMovieAnnotation.GetRichMediaUrl">
  1736. <summary>
  1737. </summary>
  1738. <returns></returns>
  1739. </member>
  1740. <member name="T:ComPDFKit.PDFAnnotation.CPDFSoundAnnotation">
  1741. <summary>
  1742. Represents an audio file added to a page. Sound annotations can be created from recording audio
  1743. using the device's microphone or by importing an existing audio file. Sound annotations are stored
  1744. inside the PDF file itself. On a page, CPDFSoundAnnotation are represented by an icon, similar to CPDFTextAnnotation.
  1745. </summary>
  1746. </member>
  1747. <member name="M:ComPDFKit.PDFAnnotation.CPDFSoundAnnotation.HasSoundSource">
  1748. <summary>
  1749. Whether to contain audio resources.
  1750. </summary>
  1751. <returns>Returns true if contains, false otherwise.</returns>
  1752. </member>
  1753. <member name="M:ComPDFKit.PDFAnnotation.CPDFSoundAnnotation.SetSoundPath(System.String)">
  1754. <summary>
  1755. Sets audio resource.
  1756. </summary>
  1757. <param name="srcPath">Audio resource path.</param>
  1758. <returns>Returns whether to successfully set audio resource.</returns>
  1759. </member>
  1760. <member name="M:ComPDFKit.PDFAnnotation.CPDFSoundAnnotation.LoadSoundSource(System.String,System.String)">
  1761. <summary>
  1762. Gets audio resource.
  1763. </summary>
  1764. <param name="soundFilePath">Saved file folder path.</param>
  1765. <param name="soundFileName">Saved file folder name.</param>
  1766. <returns>Returns absolute path of audio resouce file.</returns>
  1767. </member>
  1768. <member name="T:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation">
  1769. <summary>
  1770. Square annotation is a rectangle on the page. Despite the name "square", a square annotation can represent either a square or a rectangle, which means the width and height of the annotation rectangle need not be equal.
  1771. </summary>
  1772. </member>
  1773. <member name="P:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.LineColor">
  1774. <summary>
  1775. Gets border color.
  1776. </summary>
  1777. </member>
  1778. <member name="P:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.BgColor">
  1779. <summary>
  1780. Gets background color.
  1781. </summary>
  1782. </member>
  1783. <member name="P:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.Transparency">
  1784. <summary>
  1785. Gets border opacity.
  1786. </summary>
  1787. </member>
  1788. <member name="P:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.HasBgColor">
  1789. <summary>
  1790. Whether the background color exists.
  1791. </summary>
  1792. </member>
  1793. <member name="P:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.LineWidth">
  1794. <summary>
  1795. Gets border width.
  1796. </summary>
  1797. </member>
  1798. <member name="P:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.Rect">
  1799. <summary>
  1800. Gets the rectangle of the square on the page.
  1801. </summary>
  1802. </member>
  1803. <member name="P:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.BorderStyle">
  1804. <summary>
  1805. Gets border style.
  1806. </summary>
  1807. </member>
  1808. <member name="P:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.Dash">
  1809. <summary>
  1810. Gets the line dash array.
  1811. </summary>
  1812. </member>
  1813. <member name="M:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.SetLineColor(System.Byte[])">
  1814. <summary>
  1815. Sets border color.
  1816. </summary>
  1817. <param name="lineColor">RGB color value, range0-255</param>
  1818. <returns>Returns true on success, false on failure</returns>
  1819. </member>
  1820. <member name="M:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.SetBgColor(System.Byte[])">
  1821. <summary>
  1822. Sets background color.
  1823. </summary>
  1824. <param name="bgColor">RGB color value, range0-255</param>
  1825. <returns>Returns true on success, false on failure</returns>
  1826. </member>
  1827. <member name="M:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.SetTransparency(System.Byte)">
  1828. <summary>
  1829. Sets border opacity.
  1830. </summary>
  1831. <param name="transparency">Color opacity, range0-255</param>
  1832. <returns>Returns true on success, false on failure</returns>
  1833. </member>
  1834. <member name="M:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.ClearBgColor">
  1835. <summary>
  1836. Clears background color.
  1837. </summary>
  1838. <returns>Returns true on success, false on failure</returns>
  1839. </member>
  1840. <member name="M:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.SetLineWidth(System.Single)">
  1841. <summary>
  1842. Sets border width.
  1843. </summary>
  1844. <param name="lineWidth">Border width</param>
  1845. <returns>Returns true on success, false on failure</returns>
  1846. </member>
  1847. <member name="M:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.SetRect(ComPDFKit.Import.CRect)">
  1848. <summary>
  1849. Sets the rectangle of rectangle on the page.
  1850. </summary>
  1851. <param name="rect">Rectangle on the page</param>
  1852. <returns>Returns true on success, false on failure</returns>
  1853. </member>
  1854. <member name="M:ComPDFKit.PDFAnnotation.CPDFSquareAnnotation.SetBorderStyle(ComPDFKit.PDFAnnotation.C_BORDER_STYLE,System.Single[])">
  1855. <summary>
  1856. Sets border style.
  1857. </summary>
  1858. <param name="bs">Border style</param>
  1859. <param name="dash">Dahed line density, valid if border style is dashed line, such as[2,5]</param>
  1860. <returns>Returns true on success, false on failure</returns>
  1861. </member>
  1862. <member name="T:ComPDFKit.PDFAnnotation.CPDFSquigglyAnnotation">
  1863. <summary>
  1864. A squiggly text underline on the page.
  1865. </summary>
  1866. </member>
  1867. <member name="T:ComPDFKit.PDFAnnotation.C_TEXTSTAMP_SHAPE">
  1868. <summary>
  1869. Border style enumeration of text stamp.
  1870. </summary>
  1871. </member>
  1872. <member name="F:ComPDFKit.PDFAnnotation.C_TEXTSTAMP_SHAPE.TEXTSTAMP_RECT">
  1873. <summary>
  1874. Square
  1875. </summary>
  1876. </member>
  1877. <member name="F:ComPDFKit.PDFAnnotation.C_TEXTSTAMP_SHAPE.TEXTSTAMP_LEFT_TRIANGLE">
  1878. <summary>
  1879. Left arrow
  1880. </summary>
  1881. </member>
  1882. <member name="F:ComPDFKit.PDFAnnotation.C_TEXTSTAMP_SHAPE.TEXTSTAMP_RIGHT_TRIANGLE">
  1883. <summary>
  1884. Right arrow
  1885. </summary>
  1886. </member>
  1887. <member name="F:ComPDFKit.PDFAnnotation.C_TEXTSTAMP_SHAPE.TEXTSTAMP_NONE">
  1888. <summary>
  1889. None
  1890. </summary>
  1891. </member>
  1892. <member name="T:ComPDFKit.PDFAnnotation.C_TEXTSTAMP_COLOR">
  1893. <summary>
  1894. Color enumeration of text stamp.
  1895. </summary>
  1896. </member>
  1897. <member name="F:ComPDFKit.PDFAnnotation.C_TEXTSTAMP_COLOR.TEXTSTAMP_WHITE">
  1898. <summary>
  1899. Opacity
  1900. </summary>
  1901. </member>
  1902. <member name="F:ComPDFKit.PDFAnnotation.C_TEXTSTAMP_COLOR.TEXTSTAMP_RED">
  1903. <summary>
  1904. Red
  1905. </summary>
  1906. </member>
  1907. <member name="F:ComPDFKit.PDFAnnotation.C_TEXTSTAMP_COLOR.TEXTSTAMP_GREEN">
  1908. <summary>
  1909. Green
  1910. </summary>
  1911. </member>
  1912. <member name="F:ComPDFKit.PDFAnnotation.C_TEXTSTAMP_COLOR.TEXTSTAMP_BLUE">
  1913. <summary>
  1914. Blue
  1915. </summary>
  1916. </member>
  1917. <member name="T:ComPDFKit.PDFAnnotation.C_STAMP_TYPE">
  1918. <summary>
  1919. Stamp type.
  1920. </summary>
  1921. </member>
  1922. <member name="F:ComPDFKit.PDFAnnotation.C_STAMP_TYPE.UNKNOWN_STAMP">
  1923. <summary>
  1924. Unknown type
  1925. </summary>
  1926. </member>
  1927. <member name="F:ComPDFKit.PDFAnnotation.C_STAMP_TYPE.STANDARD_STAMP">
  1928. <summary>
  1929. Standard stamp
  1930. </summary>
  1931. </member>
  1932. <member name="F:ComPDFKit.PDFAnnotation.C_STAMP_TYPE.IMAGE_STAMP">
  1933. <summary>
  1934. Image stamp
  1935. </summary>
  1936. </member>
  1937. <member name="F:ComPDFKit.PDFAnnotation.C_STAMP_TYPE.TEXT_STAMP">
  1938. <summary>
  1939. Text stamp
  1940. </summary>
  1941. </member>
  1942. <member name="T:ComPDFKit.PDFAnnotation.CPDFStampAnnotation">
  1943. <summary>
  1944. A stamp annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp.
  1945. A stamp annotation's appearance can be with an icon or a bitmap.
  1946. </summary>
  1947. </member>
  1948. <member name="M:ComPDFKit.PDFAnnotation.CPDFStampAnnotation.SetStandardStamp(System.String,System.Int32)">
  1949. <summary>
  1950. Sets standard stamp type.
  1951. </summary>
  1952. <param name="content">Text content</param>
  1953. <param name="rotation">Rotation angle</param>
  1954. <returns>Returns true on success, false on failure</returns>
  1955. </member>
  1956. <member name="M:ComPDFKit.PDFAnnotation.CPDFStampAnnotation.GetStandardStamp">
  1957. <summary>
  1958. Gets standard stamp type.
  1959. </summary>
  1960. <returns>Returns standard stamp type.</returns>
  1961. </member>
  1962. <member name="M:ComPDFKit.PDFAnnotation.CPDFStampAnnotation.SetTextStamp(System.String,System.String,ComPDFKit.PDFAnnotation.C_TEXTSTAMP_SHAPE,ComPDFKit.PDFAnnotation.C_TEXTSTAMP_COLOR,System.Int32)">
  1963. <summary>
  1964. Sets attribute of text stamp.
  1965. </summary>
  1966. <param name="content">Text content</param>
  1967. <param name="date">Date</param>
  1968. <param name="shape">Shape</param>
  1969. <param name="color">Color</param>
  1970. <param name="rotation">Rotation angle</param>
  1971. <returns>Returns true on success, false on failure</returns>
  1972. </member>
  1973. <member name="M:ComPDFKit.PDFAnnotation.CPDFStampAnnotation.GetTextStamp(System.String@,System.String@,ComPDFKit.PDFAnnotation.C_TEXTSTAMP_SHAPE@,ComPDFKit.PDFAnnotation.C_TEXTSTAMP_COLOR@)">
  1974. <summary>
  1975. Gets attribute of text stamp.
  1976. </summary>
  1977. <param name="content">Text content</param>
  1978. <param name="date">Date</param>
  1979. <param name="shape">Shape</param>
  1980. <param name="color">Color</param>
  1981. <returns>Returns true on success, false on failure</returns>
  1982. </member>
  1983. <member name="M:ComPDFKit.PDFAnnotation.CPDFStampAnnotation.SetImageStamp(System.Byte[],System.Int32,System.Int32,System.Int32)">
  1984. <summary>
  1985. Sets resources of image stamp.
  1986. </summary>
  1987. <param name="imageData">Image data</param>
  1988. <param name="imageWidth">Image width</param>
  1989. <param name="imageHeight">Image height</param>
  1990. <param name="rotation">Rotation angle</param>
  1991. <returns>Returns true on success, false on failure</returns>
  1992. </member>
  1993. <member name="M:ComPDFKit.PDFAnnotation.CPDFStampAnnotation.GetStampType">
  1994. <summary>
  1995. Gets stamp type.
  1996. </summary>
  1997. <returns>Stamp type, more<see cref="T:ComPDFKit.PDFAnnotation.C_STAMP_TYPE"/></returns>
  1998. </member>
  1999. <member name="M:ComPDFKit.PDFAnnotation.CPDFStampAnnotation.SetStampSignature(System.Boolean)">
  2000. <summary>
  2001. 设置图章为伪签名注释,签署之后不能随意修改。
  2002. </summary>
  2003. <param name="isStampSignature">是否为伪签名注释</param>
  2004. <returns>成功返回true,失败返回false</returns>
  2005. </member>
  2006. <member name="M:ComPDFKit.PDFAnnotation.CPDFStampAnnotation.IsStampSignature">
  2007. <summary>
  2008. 判断图章是否为伪签名图章
  2009. </summary>
  2010. <returns>是否为伪签名注释</returns>
  2011. </member>
  2012. <member name="M:ComPDFKit.PDFAnnotation.CPDFStampAnnotation.GetTempTextStampImage(System.String,System.String,ComPDFKit.PDFAnnotation.C_TEXTSTAMP_SHAPE,ComPDFKit.PDFAnnotation.C_TEXTSTAMP_COLOR,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32)">
  2013. <summary>
  2014. Gets image for the appearance stream of the text stamp.
  2015. </summary>
  2016. <param name="stampText">Text</param>
  2017. <param name="date">Date</param>
  2018. <param name="shape">Shape</param>
  2019. <param name="color">Color</param>
  2020. <param name="stampWidth">Width of stamp</param>
  2021. <param name="stampHeight">Height of stamp</param>
  2022. <param name="imageWidth">Width of image</param>
  2023. <param name="imageHeight">Height of image</param>
  2024. <param name="rotation">Rotation angle</param>
  2025. <returns>Image data</returns>
  2026. </member>
  2027. <member name="T:ComPDFKit.PDFAnnotation.CPDFStrikeoutAnnotation">
  2028. <summary>
  2029. A strike-out text on the page.
  2030. </summary>
  2031. </member>
  2032. <member name="T:ComPDFKit.PDFAnnotation.CPDFTextAnnotation">
  2033. <summary>
  2034. A note (shown as an icon) on the page.
  2035. </summary>
  2036. </member>
  2037. <member name="P:ComPDFKit.PDFAnnotation.CPDFTextAnnotation.Color">
  2038. <summary>
  2039. Gets note color.
  2040. </summary>
  2041. </member>
  2042. <member name="P:ComPDFKit.PDFAnnotation.CPDFTextAnnotation.Transparency">
  2043. <summary>
  2044. Gets note opacity.
  2045. </summary>
  2046. </member>
  2047. <member name="M:ComPDFKit.PDFAnnotation.CPDFTextAnnotation.SetColor(System.Byte[])">
  2048. <summary>
  2049. Sets note color.
  2050. </summary>
  2051. <param name="color">RGB color value</param>
  2052. <returns>Returns true on success, false on failure</returns>
  2053. </member>
  2054. <member name="M:ComPDFKit.PDFAnnotation.CPDFTextAnnotation.SetTransparency(System.Byte)">
  2055. <summary>
  2056. Sets note opacity.
  2057. </summary>
  2058. <param name="transparency">Opacity</param>
  2059. <returns>Returns true on success, false on failure</returns>
  2060. </member>
  2061. <member name="T:ComPDFKit.PDFAnnotation.CPDFUnderlineAnnotation">
  2062. <summary>
  2063. Underline annotation is a kind of text markup annotation, which is shown as a underline under the text in a PDF document.
  2064. </summary>
  2065. </member>
  2066. <member name="T:ComPDFKit.PDFAnnotation.CTextAttribute">
  2067. <summary>
  2068. Text attribute helper.
  2069. </summary>
  2070. </member>
  2071. <member name="P:ComPDFKit.PDFAnnotation.CTextAttribute.FontName">
  2072. <summary>
  2073. Gets font name.
  2074. </summary>
  2075. </member>
  2076. <member name="P:ComPDFKit.PDFAnnotation.CTextAttribute.FontSize">
  2077. <summary>
  2078. Gets font size.
  2079. </summary>
  2080. </member>
  2081. <member name="P:ComPDFKit.PDFAnnotation.CTextAttribute.FontColor">
  2082. <summary>
  2083. Font color.
  2084. </summary>
  2085. </member>
  2086. <member name="M:ComPDFKit.PDFAnnotation.CTextAttribute.#ctor">
  2087. <summary>
  2088. Constructor function.
  2089. </summary>
  2090. </member>
  2091. <member name="M:ComPDFKit.PDFAnnotation.CTextAttribute.Clone">
  2092. <summary>
  2093. Clones current object.
  2094. </summary>
  2095. <returns>Returns the copy of current object.</returns>
  2096. </member>
  2097. <member name="T:ComPDFKit.PDFAnnotation.CTextAttribute.CFontNameHelper">
  2098. <summary>
  2099. Three font types supported
  2100. </summary>
  2101. </member>
  2102. <member name="T:ComPDFKit.PDFAnnotation.CTextAttribute.CFontNameHelper.FontType">
  2103. <summary>
  2104. Three font types supported.
  2105. </summary>
  2106. </member>
  2107. <member name="F:ComPDFKit.PDFAnnotation.CTextAttribute.CFontNameHelper.FontType.Unknown">
  2108. <summary>
  2109. Unknown type
  2110. </summary>
  2111. </member>
  2112. <member name="F:ComPDFKit.PDFAnnotation.CTextAttribute.CFontNameHelper.FontType.Courier">
  2113. <summary>
  2114. Courier font
  2115. </summary>
  2116. </member>
  2117. <member name="F:ComPDFKit.PDFAnnotation.CTextAttribute.CFontNameHelper.FontType.Helvetica">
  2118. <summary>
  2119. Helvetica font
  2120. </summary>
  2121. </member>
  2122. <member name="F:ComPDFKit.PDFAnnotation.CTextAttribute.CFontNameHelper.FontType.Times_Roman">
  2123. <summary>
  2124. Times_Roman font
  2125. </summary>
  2126. </member>
  2127. <member name="M:ComPDFKit.PDFAnnotation.CTextAttribute.CFontNameHelper.ObtainFontName(ComPDFKit.PDFAnnotation.CTextAttribute.CFontNameHelper.FontType,System.Boolean,System.Boolean)">
  2128. <summary>
  2129. Gets font name according to fontType, isBold, isItalic, more:<see cref="T:ComPDFKit.PDFAnnotation.CTextAttribute.CFontNameHelper.FontType"/>
  2130. </summary>
  2131. <param name="fontType">Standard font type</param>
  2132. <param name="isBold">Whether it is bold</param>
  2133. <param name="isItalic">Whether it is iatlic</param>
  2134. <returns>Returns font name</returns>
  2135. </member>
  2136. <member name="M:ComPDFKit.PDFAnnotation.CTextAttribute.CFontNameHelper.GetFontType(System.String)">
  2137. <summary>
  2138. Gets standard font enumeration according to font name, more: <see cref="T:ComPDFKit.PDFAnnotation.CTextAttribute.CFontNameHelper.FontType"/>
  2139. </summary>
  2140. <param name="fontName">Font name</param>
  2141. <returns>Returns standard font enumeration</returns>
  2142. </member>
  2143. <member name="M:ComPDFKit.PDFAnnotation.CTextAttribute.CFontNameHelper.IsBold(System.String)">
  2144. <summary>
  2145. Whether it is bold according to font name.
  2146. </summary>
  2147. <param name="fontName">Font name</param>
  2148. <returns>Whether it is bold</returns>
  2149. </member>
  2150. <member name="M:ComPDFKit.PDFAnnotation.CTextAttribute.CFontNameHelper.IsItalic(System.String)">
  2151. <summary>
  2152. Whether it is italic according to font name.
  2153. </summary>
  2154. <param name="fontName">Font name</param>
  2155. <returns>Whether it is italic</returns>
  2156. </member>
  2157. <member name="T:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE">
  2158. <summary>
  2159. Enumeration value of action type, type based on the Adobe PDF Specification (1.7), Table 8.48: Event types.
  2160. </summary>
  2161. </member>
  2162. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_UNKNOWN">
  2163. <summary>
  2164. Unknown type.
  2165. </summary>
  2166. </member>
  2167. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_GOTO">
  2168. <summary>
  2169. Go to a destination in the current document.
  2170. </summary>
  2171. </member>
  2172. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_GOTOR">
  2173. <summary>
  2174. (“Go-to remote”) Go to a destination in another document.
  2175. </summary>
  2176. </member>
  2177. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_GOTOE">
  2178. <summary>
  2179. (“Go-to embedded”; PDF 1.6) Go to a destination in an embedded file.
  2180. </summary>
  2181. </member>
  2182. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_LAUNCH">
  2183. <summary>
  2184. Launch an application, usually to open a file.
  2185. </summary>
  2186. </member>
  2187. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_THREAD">
  2188. <summary>
  2189. Begin reading an article thread.
  2190. </summary>
  2191. </member>
  2192. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_URI">
  2193. <summary>
  2194. Resolve a uniform resource identifier.
  2195. </summary>
  2196. </member>
  2197. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_SOUND">
  2198. <summary>
  2199. (PDF 1.2) Play a sound.
  2200. </summary>
  2201. </member>
  2202. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_MOVIE">
  2203. <summary>
  2204. (PDF 1.2) Play a movie.
  2205. </summary>
  2206. </member>
  2207. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_HIDE">
  2208. <summary>
  2209. (PDF 1.2) Set an annotation’s Hidden flag.
  2210. </summary>
  2211. </member>
  2212. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_NAMED">
  2213. <summary>
  2214. (PDF1.2) Execute an event predefined by the conforming reader.
  2215. </summary>
  2216. </member>
  2217. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_SUBMITFORM">
  2218. <summary>
  2219. (PDF 1.2) Send data to a uniform resource locator.
  2220. </summary>
  2221. </member>
  2222. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_RESETFORM">
  2223. <summary>
  2224. (PDF 1.2) Set fields to their default values.
  2225. </summary>
  2226. </member>
  2227. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_IMPORTDATA">
  2228. <summary>
  2229. (PDF 1.2) Import field values from a file.
  2230. </summary>
  2231. </member>
  2232. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_JAVASCRIPT">
  2233. <summary>
  2234. (PDF 1.3) Execute a JavaScript script.
  2235. </summary>
  2236. </member>
  2237. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_SETOCGSTATE">
  2238. <summary>
  2239. (PDF 1.5) Set the states of optional content groups.
  2240. </summary>
  2241. </member>
  2242. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_RENDITION">
  2243. <summary>
  2244. (PDF 1.5) Controls the playing of multimedia content.
  2245. </summary>
  2246. </member>
  2247. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_TRANS">
  2248. <summary>
  2249. (PDF 1.5) Updates the display of a document, using a transition dictionary.
  2250. </summary>
  2251. </member>
  2252. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_GOTO3DVIEW">
  2253. <summary>
  2254. (PDF 1.6) Set the current view of a 3D annotation
  2255. </summary>
  2256. </member>
  2257. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_UOP">
  2258. <summary>
  2259. Unlock uop.
  2260. </summary>
  2261. </member>
  2262. <member name="F:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE.ACTION_TYPE_ERROR">
  2263. <summary>
  2264. Error type.
  2265. </summary>
  2266. </member>
  2267. <member name="T:ComPDFKit.PDFDocument.Action.CPDFAction">
  2268. <summary>
  2269. A PDF action may have sub-actions. When this action is triggered, its sub-actions should also be triggered in turn.
  2270. </summary>
  2271. </member>
  2272. <member name="P:ComPDFKit.PDFDocument.Action.CPDFAction.ActionPtr">
  2273. <summary>
  2274. Action handle.
  2275. </summary>
  2276. </member>
  2277. <member name="P:ComPDFKit.PDFDocument.Action.CPDFAction.ActionType">
  2278. <summary>
  2279. Get action type, more:<see cref="T:ComPDFKit.PDFDocument.Action.C_ACTION_TYPE"/>
  2280. </summary>
  2281. </member>
  2282. <member name="M:ComPDFKit.PDFDocument.Action.CPDFAction.#ctor(ComPDFKit.PDFDocument.Action.C_ACTION_TYPE,System.IntPtr)">
  2283. <summary>
  2284. Constructor function, used for initialization action.
  2285. </summary>
  2286. <param name="actionType">Event type</param>
  2287. <param name="actionPtr">Event handle</param>
  2288. </member>
  2289. <member name="M:ComPDFKit.PDFDocument.Action.CPDFAction.#ctor(ComPDFKit.PDFDocument.Action.C_ACTION_TYPE)">
  2290. <summary>
  2291. Constructor function, used for creating action.
  2292. </summary>
  2293. <param name="actionType">Event type</param>
  2294. </member>
  2295. <member name="M:ComPDFKit.PDFDocument.Action.CPDFAction.IsValid">
  2296. <summary>
  2297. Whether the object is valid.
  2298. </summary>
  2299. <returns> Returns true if valid, otherwise false</returns>
  2300. </member>
  2301. <member name="M:ComPDFKit.PDFDocument.Action.CPDFAction.Release">
  2302. <summary>
  2303. Releases resources of the object.
  2304. </summary>
  2305. </member>
  2306. <member name="T:ComPDFKit.PDFDocument.Action.CPDFGoToAction">
  2307. <summary>
  2308. PDF action representing a change to another page.
  2309. </summary>
  2310. </member>
  2311. <member name="M:ComPDFKit.PDFDocument.Action.CPDFGoToAction.#ctor(System.IntPtr)">
  2312. <summary>
  2313. Constructor function, used for initializing GoTo event.
  2314. </summary>
  2315. <param name="actionPtr">Action handle</param>
  2316. </member>
  2317. <member name="M:ComPDFKit.PDFDocument.Action.CPDFGoToAction.#ctor">
  2318. <summary>
  2319. Constructor function, used for creating GoTo event.
  2320. </summary>
  2321. </member>
  2322. <member name="M:ComPDFKit.PDFDocument.Action.CPDFGoToAction.GetDestination(ComPDFKit.PDFDocument.CPDFDocument)">
  2323. <summary>
  2324. Gets the destination associated with the action, more: <see cref="T:ComPDFKit.PDFDocument.CPDFDestination"/>
  2325. </summary>
  2326. <param name="document">CPDFDocument object</param>
  2327. <returns>Destination</returns>
  2328. </member>
  2329. <member name="M:ComPDFKit.PDFDocument.Action.CPDFGoToAction.SetDestination(ComPDFKit.PDFDocument.CPDFDocument,ComPDFKit.PDFDocument.CPDFDestination)">
  2330. <summary>
  2331. Sets the destination associated with the action, more:<see cref="T:ComPDFKit.PDFDocument.CPDFDestination"/>
  2332. </summary>
  2333. <param name="document">CPDFDocument object</param>
  2334. <param name="dest">Target position</param>
  2335. <returns>Returns true on success, false on failure</returns>
  2336. </member>
  2337. <member name="T:ComPDFKit.PDFDocument.Action.CPDFGoToRAction">
  2338. <summary>
  2339. A remote go-to action is similar to an ordinary go-to event but jumps to a destination in another PDF file instead of the current file.
  2340. </summary>
  2341. </member>
  2342. <member name="M:ComPDFKit.PDFDocument.Action.CPDFGoToRAction.#ctor(System.IntPtr)">
  2343. <summary>
  2344. Constructor function, used for initializing GoToR action.
  2345. </summary>
  2346. <param name="actionPtr">Action handle</param>
  2347. </member>
  2348. <member name="M:ComPDFKit.PDFDocument.Action.CPDFGoToRAction.#ctor">
  2349. <summary>
  2350. Constructor function, used for creating GoToR action.
  2351. </summary>
  2352. </member>
  2353. <member name="M:ComPDFKit.PDFDocument.Action.CPDFGoToRAction.GetFileSpec">
  2354. <summary>
  2355. Gets the file in which the destination shall be located.
  2356. </summary>
  2357. <returns>File path</returns>
  2358. </member>
  2359. <member name="M:ComPDFKit.PDFDocument.Action.CPDFGoToRAction.SetFileSpec(System.String)">
  2360. <summary>
  2361. Sets the specified file path of GoToR action.
  2362. </summary>
  2363. <param name="fileSpec">File path</param>
  2364. <returns>Returns true on success, false on failure.</returns>
  2365. </member>
  2366. <member name="M:ComPDFKit.PDFDocument.Action.CPDFGoToRAction.GetDestination(ComPDFKit.PDFDocument.CPDFDocument)">
  2367. <summary>
  2368. Gets the destination associated with the action, more:<see cref="T:ComPDFKit.PDFDocument.CPDFDestination"/>
  2369. </summary>
  2370. <param name="document">CPDFDocument object.</param>
  2371. <returns>Destination</returns>
  2372. </member>
  2373. <member name="M:ComPDFKit.PDFDocument.Action.CPDFGoToRAction.SetDestination(ComPDFKit.PDFDocument.CPDFDocument,ComPDFKit.PDFDocument.CPDFDestination)">
  2374. <summary>
  2375. Sets the target position of GotoR action, more:<see cref="T:ComPDFKit.PDFDocument.CPDFDestination"/>
  2376. </summary>
  2377. <param name="document">CPDFDocument object.</param>
  2378. <param name="dest">Target position.</param>
  2379. <returns>Returns true on success, false on failure.</returns>
  2380. </member>
  2381. <member name="T:ComPDFKit.PDFDocument.Action.CPDFJSAction">
  2382. <summary>
  2383. JavaScript事件
  2384. </summary>
  2385. </member>
  2386. <member name="M:ComPDFKit.PDFDocument.Action.CPDFJSAction.GetJavaScript">
  2387. <summary>
  2388. 获取JS内容
  2389. </summary>
  2390. <returns>JS内容</returns>
  2391. </member>
  2392. <member name="T:ComPDFKit.PDFDocument.Action.CPDFLaunchAction">
  2393. <summary>
  2394. Launcher事件
  2395. </summary>
  2396. </member>
  2397. <member name="M:ComPDFKit.PDFDocument.Action.CPDFLaunchAction.GetFileSpec">
  2398. <summary>
  2399. 获取指定文件路径
  2400. </summary>
  2401. <returns>文件路径</returns>
  2402. </member>
  2403. <member name="M:ComPDFKit.PDFDocument.Action.CPDFLaunchAction.SetFileSpec(System.String)">
  2404. <summary>
  2405. 设置指定文件路径
  2406. </summary>
  2407. <param name="fileSpec">文件路径</param>
  2408. <returns></returns>
  2409. </member>
  2410. <member name="T:ComPDFKit.PDFDocument.Action.CPDFNamedAction">
  2411. <summary>
  2412. Named action is an action that executes an event predefined by the viewer application.
  2413. A CPDFNamedAction object represents an action with a defined name.
  2414. </summary>
  2415. </member>
  2416. <member name="M:ComPDFKit.PDFDocument.Action.CPDFNamedAction.#ctor(System.IntPtr)">
  2417. <summary>
  2418. Constructor function, used for initializing Named action.
  2419. </summary>
  2420. <param name="actionPtr">Action handle</param>
  2421. </member>
  2422. <member name="M:ComPDFKit.PDFDocument.Action.CPDFNamedAction.#ctor">
  2423. <summary>
  2424. Constructor function, used for creating Named action.
  2425. </summary>
  2426. </member>
  2427. <member name="M:ComPDFKit.PDFDocument.Action.CPDFNamedAction.GetName">
  2428. <summary>
  2429. Gets action name.
  2430. </summary>
  2431. <returns>Name value.</returns>
  2432. </member>
  2433. <member name="M:ComPDFKit.PDFDocument.Action.CPDFNamedAction.SetName(System.String)">
  2434. <summary>
  2435. Sets action name.
  2436. </summary>
  2437. <param name="name"></param>
  2438. <returns></returns>
  2439. </member>
  2440. <member name="T:ComPDFKit.PDFDocument.Action.CPDFResetFormAction">
  2441. <summary>
  2442. 重置表单事件,暂未实现
  2443. </summary>
  2444. </member>
  2445. <member name="T:ComPDFKit.PDFDocument.Action.CPDFSubmitFormAction">
  2446. <summary>
  2447. 提交事件,暂未实现
  2448. </summary>
  2449. </member>
  2450. <member name="T:ComPDFKit.PDFDocument.Action.CPDFUriAction">
  2451. <summary>
  2452. Action of link annotation which includes accessing to website and sending mail.
  2453. </summary>
  2454. </member>
  2455. <member name="M:ComPDFKit.PDFDocument.Action.CPDFUriAction.#ctor(System.IntPtr)">
  2456. <summary>
  2457. Constructor function, used for initializing Uri action.
  2458. </summary>
  2459. <param name="actionPtr">Event handle</param>
  2460. </member>
  2461. <member name="M:ComPDFKit.PDFDocument.Action.CPDFUriAction.#ctor">
  2462. <summary>
  2463. Constructor function, used for creating Uri action.
  2464. </summary>
  2465. </member>
  2466. <member name="M:ComPDFKit.PDFDocument.Action.CPDFUriAction.GetUri">
  2467. <summary>
  2468. Gets URI.
  2469. </summary>
  2470. <returns>URI value.</returns>
  2471. </member>
  2472. <member name="M:ComPDFKit.PDFDocument.Action.CPDFUriAction.SetUri(System.String)">
  2473. <summary>
  2474. Sets URI.
  2475. </summary>
  2476. <param name="uri">Uri value.</param>
  2477. <returns>Returns true on success, false on failure.</returns>
  2478. </member>
  2479. <member name="T:ComPDFKit.PDFDocument.CPDFBates">
  2480. <summary>
  2481. Adds and removes the bates numbers.
  2482. </summary>
  2483. </member>
  2484. <member name="M:ComPDFKit.PDFDocument.CPDFBates.Update">
  2485. <summary>
  2486. Updates the bates numbers.
  2487. </summary>
  2488. <returns>Returns true on success, false on failure.</returns>
  2489. </member>
  2490. <member name="M:ComPDFKit.PDFDocument.CPDFBates.Clear">
  2491. <summary>
  2492. Removes the bates numbers.
  2493. </summary>
  2494. <returns>Returns true on success, false on failure.</returns>
  2495. </member>
  2496. <member name="M:ComPDFKit.PDFDocument.CPDFBates.Release">
  2497. <summary>
  2498. Releases CPDFBates object resource.
  2499. </summary>
  2500. </member>
  2501. <member name="T:ComPDFKit.PDFDocument.CPDFHeaderFooter">
  2502. <summary>
  2503. Adds and removes the header &amp; footer.
  2504. </summary>
  2505. </member>
  2506. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.IsValid">
  2507. <summary>
  2508. Whether object is valid, false means the object resource is released, you cannot use the object to call any method.
  2509. </summary>
  2510. <returns>Whether object is valid, false means the object resource is released, you cannot use the object to call any method.</returns>
  2511. </member>
  2512. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.GetText(System.Int32)">
  2513. <summary>
  2514. Gets the text of the header &amp; footer at the specified index.
  2515. </summary>
  2516. <param name="index">the specified index</param>
  2517. <returns> the text of the header &amp; footer</returns>
  2518. </member>
  2519. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.SetText(System.Int32,System.String)">
  2520. <summary>
  2521. Sets the text of the header &amp; footer at the specified index.
  2522. </summary>
  2523. <param name="index">the specified index</param>
  2524. <param name="text">the text of the header &amp; footer</param>
  2525. <returns>Returns true on success, false on failure.</returns>
  2526. </member>
  2527. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.GetFontName(System.Int32)">
  2528. <summary>
  2529. Gets the font name of the header &amp; footer at the specified index.
  2530. </summary>
  2531. <param name="index">the specified index</param>
  2532. <returns>the font name</returns>
  2533. </member>
  2534. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.SetFontName(System.Int32,System.String)">
  2535. <summary>
  2536. Sets the font name of the header &amp; footer at the specified index.
  2537. </summary>
  2538. <param name="index">the specified index</param>
  2539. <param name="fontName"></param>
  2540. <returns>Returns true on success, false on failure.</returns>
  2541. </member>
  2542. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.GetFontSize(System.Int32)">
  2543. <summary>
  2544. Gets the font size of the header &amp; footer at the specified index.
  2545. </summary>
  2546. <param name="index">the specified index</param>
  2547. <returns>the font size</returns>
  2548. </member>
  2549. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.SetFontSize(System.Int32,System.Single)">
  2550. <summary>
  2551. Sets the font size of the header &amp; footer at the specified index.
  2552. </summary>
  2553. <param name="index">the specified index</param>
  2554. <param name="fontSize">the font size</param>
  2555. <returns>Returns true on success, false on failure.</returns>
  2556. </member>
  2557. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.GetTextColor(System.Int32)">
  2558. <summary>
  2559. Gets the font color of the header &amp; footer at the specified index.
  2560. </summary>
  2561. <param name="index">the specified index</param>
  2562. <returns>the font color</returns>
  2563. </member>
  2564. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.SetTextColor(System.Int32,System.Byte[])">
  2565. <summary>
  2566. Sets the font color of the header &amp; footer at the specified index.
  2567. </summary>
  2568. <param name="index">the specified index</param>
  2569. <param name="textColor">the font color</param>
  2570. <returns>Returns true on success, false on failure.</returns>
  2571. </member>
  2572. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.GetMargin">
  2573. <summary>
  2574. Gets the margins of the header &amp; footer.
  2575. </summary>
  2576. <returns>the margins</returns>
  2577. </member>
  2578. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.SetMargin(System.Single[])">
  2579. <summary>
  2580. Sets the margins of the header &amp; footer.
  2581. </summary>
  2582. <param name="margins">the margins</param>
  2583. <returns>Returns true on success, false on failure.</returns>
  2584. </member>
  2585. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.GetPageOffset">
  2586. <summary>
  2587. Gets the start page number of the header &amp; footer.
  2588. </summary>
  2589. <returns>the start page number</returns>
  2590. </member>
  2591. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.SetPageOffset(System.Int32)">
  2592. <summary>
  2593. Sets the start page number of the header &amp; footer.
  2594. </summary>
  2595. <param name="pageOffect">the start page number</param>
  2596. <returns>Returns true on success, false on failure.</returns>
  2597. </member>
  2598. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.GetPages">
  2599. <summary>
  2600. Gets the page range of the header &amp; footer by string, such as "0,3,5-7".
  2601. </summary>
  2602. <returns>the page range</returns>
  2603. </member>
  2604. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.SetPages(System.String)">
  2605. <summary>
  2606. Gets the page range of the header &amp; footer by string, such as "0,3,5-7".
  2607. </summary>
  2608. <param name="pages">the page range</param>
  2609. <returns>Returns true on success, false on failure.</returns>
  2610. </member>
  2611. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.Update">
  2612. <summary>
  2613. Updates the header &amp; footer.
  2614. </summary>
  2615. <returns>Returns true on success, false on failure.</returns>
  2616. </member>
  2617. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.Clear">
  2618. <summary>
  2619. Removes the header &amp; footer.
  2620. </summary>
  2621. <returns>Returns true on success, false on failure.</returns>
  2622. </member>
  2623. <member name="M:ComPDFKit.PDFDocument.CPDFHeaderFooter.Release">
  2624. <summary>
  2625. Releases header &amp; footer object resource.
  2626. </summary>
  2627. </member>
  2628. <member name="T:ComPDFKit.PDFDocument.CPDFPermissionsInfo">
  2629. <summary>
  2630. File permission related class includes whether to allow printing, modifying and so on.
  2631. </summary>
  2632. </member>
  2633. <member name="P:ComPDFKit.PDFDocument.CPDFPermissionsInfo.AllowsPrinting">
  2634. <summary>
  2635. Whether to allow printing.
  2636. </summary>
  2637. </member>
  2638. <member name="P:ComPDFKit.PDFDocument.CPDFPermissionsInfo.AllowsHighQualityPrinting">
  2639. <summary>
  2640. Whether to allow high-quality printing.
  2641. </summary>
  2642. </member>
  2643. <member name="P:ComPDFKit.PDFDocument.CPDFPermissionsInfo.AllowsCopying">
  2644. <summary>
  2645. Whether to allow copying of content to the Pasteboard, such as: text, image, etc.
  2646. </summary>
  2647. </member>
  2648. <member name="P:ComPDFKit.PDFDocument.CPDFPermissionsInfo.AllowsDocumentChanges">
  2649. <summary>
  2650. Whether to allow document changes.
  2651. </summary>
  2652. </member>
  2653. <member name="P:ComPDFKit.PDFDocument.CPDFPermissionsInfo.AllowsDocumentAssembly">
  2654. <summary>
  2655. Whether to allow to manage a document by inserting, deleting, and rotating pages.
  2656. </summary>
  2657. </member>
  2658. <member name="P:ComPDFKit.PDFDocument.CPDFPermissionsInfo.AllowsCommenting">
  2659. <summary>
  2660. Whether to allow creating or modifying document annotations, including form field entries.
  2661. </summary>
  2662. </member>
  2663. <member name="P:ComPDFKit.PDFDocument.CPDFPermissionsInfo.AllowsFormFieldEntry">
  2664. <summary>
  2665. Whether to allow modifying form field entries even if you can't edit document annotations.
  2666. </summary>
  2667. </member>
  2668. <member name="T:ComPDFKit.PDFDocument.CPDFBookmark">
  2669. <summary>
  2670. Bookmark.
  2671. </summary>
  2672. </member>
  2673. <member name="P:ComPDFKit.PDFDocument.CPDFBookmark.PageIndex">
  2674. <summary>
  2675. The page index that the bookmark refers to.
  2676. </summary>
  2677. </member>
  2678. <member name="P:ComPDFKit.PDFDocument.CPDFBookmark.Title">
  2679. <summary>
  2680. Bookmark title.
  2681. </summary>
  2682. </member>
  2683. <member name="P:ComPDFKit.PDFDocument.CPDFBookmark.Date">
  2684. <summary>
  2685. Creation date of bookmark.
  2686. </summary>
  2687. </member>
  2688. <member name="T:ComPDFKit.PDFDocument.CPDFDestination">
  2689. <summary>
  2690. A CPDFDestination object describes a point on a PDF page.
  2691. </summary>
  2692. </member>
  2693. <member name="P:ComPDFKit.PDFDocument.CPDFDestination.PageIndex">
  2694. <summary>
  2695. Destination page index.
  2696. </summary>
  2697. </member>
  2698. <member name="P:ComPDFKit.PDFDocument.CPDFDestination.Position_X">
  2699. <summary>
  2700. The x coordinate of the specified page.
  2701. </summary>
  2702. </member>
  2703. <member name="P:ComPDFKit.PDFDocument.CPDFDestination.Position_Y">
  2704. <summary>
  2705. The y coordinate of the specified page.
  2706. </summary>
  2707. </member>
  2708. <member name="P:ComPDFKit.PDFDocument.CPDFDestination.Zoom">
  2709. <summary>
  2710. The page zoom ratio.
  2711. </summary>
  2712. </member>
  2713. <member name="T:ComPDFKit.PDFDocument.CPDFDocumentError">
  2714. <summary>
  2715. Error type enumeration of loading document
  2716. </summary>
  2717. </member>
  2718. <member name="F:ComPDFKit.PDFDocument.CPDFDocumentError.CPDFDocumentErrorSuccess">
  2719. <summary>
  2720. Success.
  2721. </summary>
  2722. </member>
  2723. <member name="F:ComPDFKit.PDFDocument.CPDFDocumentError.CPDFDocumentUnknownError">
  2724. <summary>
  2725. Unknown error.
  2726. </summary>
  2727. </member>
  2728. <member name="F:ComPDFKit.PDFDocument.CPDFDocumentError.CPDFDocumentFileError">
  2729. <summary>
  2730. File not found or could not be opened.
  2731. </summary>
  2732. </member>
  2733. <member name="F:ComPDFKit.PDFDocument.CPDFDocumentError.CPDFDocumentFormatError">
  2734. <summary>
  2735. File not in PDF format or corrupted.
  2736. </summary>
  2737. </member>
  2738. <member name="F:ComPDFKit.PDFDocument.CPDFDocumentError.CPDFDocumentPasswordError">
  2739. <summary>
  2740. Password required or incorrect password.
  2741. </summary>
  2742. </member>
  2743. <member name="F:ComPDFKit.PDFDocument.CPDFDocumentError.CPDFDocumentSecurityError">
  2744. <summary>
  2745. Unsupported security scheme.
  2746. </summary>
  2747. </member>
  2748. <member name="F:ComPDFKit.PDFDocument.CPDFDocumentError.CPDFDocumentPageError">
  2749. <summary>
  2750. Error page.
  2751. </summary>
  2752. </member>
  2753. <member name="T:ComPDFKit.PDFDocument.CPDFType">
  2754. <summary>
  2755. PDF/A conformance levels.
  2756. </summary>
  2757. </member>
  2758. <member name="T:ComPDFKit.PDFDocument.CPDFDocument">
  2759. <summary>
  2760. Document instance. One CPDFDocument object for one document. This class is used to represent a specified directory, which contains PDF files and user wants to search among these PDF files.
  2761. </summary>"
  2762. </member>
  2763. <member name="P:ComPDFKit.PDFDocument.CPDFDocument.IsEncrypted">
  2764. <summary>
  2765. Whether document is encrypted.
  2766. </summary>
  2767. </member>
  2768. <member name="P:ComPDFKit.PDFDocument.CPDFDocument.IsLocked">
  2769. <summary>
  2770. Whether the document is locked.
  2771. </summary>
  2772. </member>
  2773. <member name="P:ComPDFKit.PDFDocument.CPDFDocument.PageCount">
  2774. <summary>
  2775. The total count of document pages.
  2776. </summary>
  2777. </member>
  2778. <member name="P:ComPDFKit.PDFDocument.CPDFDocument.HasRepaired">
  2779. <summary>
  2780. Whether document is repaired.
  2781. </summary>
  2782. </member>
  2783. <member name="P:ComPDFKit.PDFDocument.CPDFDocument.ErrorType">
  2784. <summary>
  2785. Error message for the document loading.
  2786. To determine the error type, use the code to obtain error of type CPDFDocumentError.
  2787. Except for the CPDFDocumentPasswordError error, other errors cannot open the document.
  2788. If CPDFDocumentPasswordError, reading the document requires a password.
  2789. </summary>
  2790. </member>
  2791. <member name="P:ComPDFKit.PDFDocument.CPDFDocument.FilePath">
  2792. <summary>
  2793. The path for the document
  2794. </summary>
  2795. </member>
  2796. <member name="P:ComPDFKit.PDFDocument.CPDFDocument.FileName">
  2797. <summary>
  2798. Gets document name.
  2799. </summary>
  2800. </member>
  2801. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.InitWithFilePath(System.String)">
  2802. <summary>
  2803. Initializes a CPDFDocument object with the contents at the specified URL.
  2804. </summary>
  2805. <param name="filePath">Path of document</param>
  2806. <returns>CPDFDocument object.</returns>
  2807. </member>
  2808. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.CreateDocument">
  2809. <summary>
  2810. Initializes a CPDFDocument object with new PDF.
  2811. </summary>
  2812. <returns>CPDFDocument object</returns>
  2813. </member>
  2814. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.UnlockWithPassword(System.String)">
  2815. <summary>
  2816. Attempts to unlock an encrypted document.
  2817. If the password is correct, this method returns true, else returns false. Once unlocked, you cannot use this function to relock the document.
  2818. </summary>
  2819. <param name="password">The password to unlock an encrypted document (you cannot lock an unlocked PDF document by using an incorrect password).</param>
  2820. <returns>If the password is correct, this method returns true, else returns false.</returns>
  2821. </member>
  2822. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.WriteToLoadedPath">
  2823. <summary>
  2824. Writes the document to the original path.
  2825. </summary>
  2826. <returns>Returns true on success, false on failure.</returns>
  2827. </member>
  2828. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.WriteToFilePath(System.String)">
  2829. <summary>
  2830. Writes the document to a location specified by the passed-in URL.
  2831. </summary>
  2832. <param name="filePath"></param>
  2833. <returns>Returns true on success, false on failure.</returns>
  2834. </member>
  2835. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.WriteFlattenToFilePath(System.String)">
  2836. <summary>
  2837. Writes the document to the specified URL after flattening.
  2838. </summary>
  2839. <param name="filePath">Path of the flattened document.</param>
  2840. <returns>Returns true on success, false on failure.</returns>
  2841. </member>
  2842. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.GetInfo">
  2843. <summary>
  2844. Gets document information.
  2845. </summary>
  2846. <returns>Document information.</returns>
  2847. </member>
  2848. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.SetInfo(ComPDFKit.PDFDocument.CPDFInfo)">
  2849. <summary>
  2850. Sets document information.
  2851. </summary>
  2852. <param name="info">Document information.</param>
  2853. <returns>Returns true on success, false on failure.</returns>
  2854. </member>
  2855. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.GetPermissionsInfo">
  2856. <summary>
  2857. Gets permission information of document.
  2858. </summary>
  2859. <returns>Permission information.</returns>
  2860. </member>
  2861. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.GetPageSize(System.Int32)">
  2862. <summary>
  2863. Gets page size
  2864. </summary>
  2865. <param name="pageIndex">Page number</param>
  2866. <returns>Page size</returns>
  2867. </member>
  2868. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.GetOutlineList">
  2869. <summary>
  2870. Gets outline list of document.
  2871. </summary>
  2872. <returns>Outline list</returns>
  2873. </member>
  2874. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.ReleaseOutlineList">
  2875. <summary>
  2876. Releases resources of the object.
  2877. </summary>
  2878. </member>
  2879. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.GetOutlineRoot">
  2880. <summary>
  2881. Gets outline root of document.
  2882. </summary>
  2883. <returns>Outline root</returns>
  2884. </member>
  2885. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.GetBookmarkList">
  2886. <summary>
  2887. Gets bookmark list of document.
  2888. </summary>
  2889. <returns>Bookmark list</returns>
  2890. </member>
  2891. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.AddBookmark(ComPDFKit.PDFDocument.CPDFBookmark)">
  2892. <summary>
  2893. Adds bookmark
  2894. </summary>
  2895. <param name="bookmark">Bookmark object</param>
  2896. <returns>Returns true on success, false on failure</returns>
  2897. </member>
  2898. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.EditBookmark(System.Int32,System.String)">
  2899. <summary>
  2900. Edits bookmark title at the specified page index.
  2901. </summary>
  2902. <param name="pageIndex">Page number where bookmark is</param>
  2903. <param name="title">Bookmark title</param>
  2904. <returns>Returns true on success, false on failure</returns>
  2905. </member>
  2906. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.RemoveBookmark(System.Int32)">
  2907. <summary>
  2908. Removes the bookmark at the specified index.
  2909. </summary>
  2910. <param name="pageIndex">The specified index.</param>
  2911. <returns>Returns true on success, false on failure.</returns>
  2912. </member>
  2913. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.BookmarkForPageIndex(System.Int32)">
  2914. <summary>
  2915. Returns the bookmark at the specified index.
  2916. Indexes are zero based. This method will return null if index is out of bounds.
  2917. </summary>
  2918. <param name="pageIndex">The specified index.</param>
  2919. <returns>The bookmark object.</returns>
  2920. </member>
  2921. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.InsertPage(System.Int32,System.Double,System.Double,System.String)">
  2922. <summary>
  2923. Inserts a blank page with image at the specified index point.
  2924. Indexes are zero based. The index must lie within bounds, or be equal to the length of bounds.
  2925. </summary>
  2926. <param name="pageIndex">The specified index point.</param>
  2927. <param name="width">The page width.</param>
  2928. <param name="height">The page height.</param>
  2929. <param name="imagePath">Image path, if empty create a blank page.</param>
  2930. <returns>Returns true on success, false on failure.</returns>
  2931. </member>
  2932. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.RemovePages(System.Int32[])">
  2933. <summary>
  2934. Remove page(s).
  2935. </summary>
  2936. <param name="pageIndexs">The specified index array.</param>
  2937. <returns>Returns true on success, false on failure.</returns>
  2938. </member>
  2939. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.ImportPages(ComPDFKit.PDFDocument.CPDFDocument,System.String)">
  2940. <summary>
  2941. Imports page(s) from another document at the end of the document.
  2942. </summary>
  2943. <param name="otherDocument">Document that need to be imported.</param>
  2944. <param name="pageRange">The page range of the imported document, for example :1,3,5; 6-10;</param>
  2945. <returns>Returns true on success, false on failure.</returns>
  2946. </member>
  2947. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.ImportPagesAtIndex(ComPDFKit.PDFDocument.CPDFDocument,System.String,System.Int32)">
  2948. <summary>
  2949. Imports page(s) from another document at the specified index point.
  2950. </summary>
  2951. <param name="otherDocument">Document that need to be imported.</param>
  2952. <param name="pageRange">The page range of the imported document, for example :1,3,5; 6-10;</param>
  2953. <param name="pageIndex">The specified index point.</param>
  2954. <returns>Returns true on success, false on failure.</returns>
  2955. </member>
  2956. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.MovePage(System.Int32,System.Int32)">
  2957. <summary>
  2958. Moves one page to another.
  2959. This method will return false if either index value is out of bounds.
  2960. </summary>
  2961. <param name="startIndex">The start index number.</param>
  2962. <param name="endIndex">The end index number.</param>
  2963. <returns>Returns true on success, false on failure.</returns>
  2964. </member>
  2965. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.ExchangePage(System.Int32,System.Int32)">
  2966. <summary>
  2967. Exchanges one page with another.
  2968. This method will return false if either index value is out of bounds.
  2969. </summary>
  2970. <param name="firstIndex">The first exchange index number</param>
  2971. <param name="secondIndex">The second exchange index number</param>
  2972. <returns>Returns true on success, false on failure.</returns>
  2973. </member>
  2974. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.RotatePage(System.Int32,System.Int32)">
  2975. <summary>
  2976. Rotates page at the specified index number.
  2977. </summary>
  2978. <param name="pageIndex">The specified index number.</param>
  2979. <param name="rotation">Rotation Angle value; Value is: -3,-2,-1,0,1,2,3</param>
  2980. <returns>Returns true on success, false on failure.</returns>
  2981. </member>
  2982. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.PageAtIndex(System.Int32,System.Boolean)">
  2983. <summary>
  2984. Returns a CPDFPage object representing the page at index.
  2985. Indexes are zero based. This method will return null if index is out of bounds.
  2986. </summary>
  2987. <param name="pageIndex">The page index</param>
  2988. <param name="isNeedParse">Whether to parse.</param>
  2989. <returns>CPDFPage object.</returns>
  2990. </member>
  2991. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.ReleasePageList">
  2992. <summary>
  2993. Release page list.
  2994. </summary>
  2995. </member>
  2996. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.Encrypt(System.String,System.String,ComPDFKit.PDFDocument.CPDFPermissionsInfo)">
  2997. <summary>
  2998. Encrypts document.
  2999. </summary>
  3000. <param name="userPassword">User password</param>
  3001. <param name="ownerPassword">Permission password</param>
  3002. <param name="permission">Permission</param>
  3003. </member>
  3004. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.Descrypt(System.String)">
  3005. <summary>
  3006. Decrypts document.
  3007. </summary>
  3008. <param name="filePath">The position to save the document after decryption</param>
  3009. <returns>Returns true on success, false on failure</returns>
  3010. </member>
  3011. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.ExportAnnotationToXFDFPath(System.String,System.String)">
  3012. <summary>
  3013. Exports annotations to XFDF document.
  3014. </summary>
  3015. <param name="exportPath">The export path.</param>
  3016. <param name="tempPath">Temporary path.</param>
  3017. <returns>Returns true on success, false on failure.</returns>
  3018. </member>
  3019. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.ImportAnnotationFromXFDFPath(System.String,System.String)">
  3020. <summary>
  3021. Imports annotations from XFDF document.
  3022. </summary>
  3023. <param name="importPath">The import path.</param>
  3024. <param name="tempPath">Temporary path.</param>
  3025. <returns>Returns true on success, false on failure.</returns>
  3026. </member>
  3027. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.InitWatermark(ComPDFKit.PDFWatermark.C_Watermark_Type)">
  3028. <summary>
  3029. Creates watermark.
  3030. </summary>
  3031. <param name="type">Watermark type.</param>
  3032. <returns>Watermark object.</returns>
  3033. </member>
  3034. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.DeleteWatermarks">
  3035. <summary>
  3036. Removes all watermarks in the document.
  3037. </summary>
  3038. </member>
  3039. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.PdfToImage(System.String,System.String)">
  3040. <summary>
  3041. Converts the specified page(s) to image.
  3042. </summary>
  3043. <param name="pageRange">Page range, such as:1,3,5;6-10;</param>
  3044. <param name="filePath">Save path.</param>
  3045. <returns>Returns true on success, false on failure.</returns>
  3046. </member>
  3047. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.PdfToText(System.String,System.String)">
  3048. <summary>
  3049. Converts the specified page(s) to text.
  3050. </summary>
  3051. <param name="pageRange">Page range, such as:1,3,5;6-10;</param>
  3052. <param name="filePath">Save path.</param>
  3053. <returns>Returns true on success, false on failure.</returns>
  3054. </member>
  3055. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.ExtractImage(System.String,System.String)">
  3056. <summary>
  3057. Exports all the images on the page.
  3058. </summary>
  3059. <param name="pageRange">Page range, such as:1,3,5;6-10;</param>
  3060. <param name="filePath">Save path.</param>
  3061. <returns>Returns true on success, false on failure.</returns>
  3062. </member>
  3063. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.AddHeaderFooter(ComPDFKit.Import.C_CTTextData[],System.Single[],System.String,System.Int32)">
  3064. <summary>
  3065. 添加页眉页脚
  3066. </summary>
  3067. <param name="textData">文字数据</param>
  3068. <param name="margin">间距</param>
  3069. <param name="pagesRange">页面范围</param>
  3070. <param name="startPage">起始页码</param>
  3071. </member>
  3072. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.DeleteHeaderFooter">
  3073. <summary>
  3074. 删除页眉页脚
  3075. </summary>
  3076. </member>
  3077. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.AddBates(ComPDFKit.Import.C_CTTextData[],System.Single[],System.String)">
  3078. <summary>
  3079. 添加贝茨码
  3080. </summary>
  3081. <param name="textData">文字数据</param>
  3082. <param name="margin">间距</param>
  3083. <param name="pagesRange">页面范围</param>
  3084. </member>
  3085. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.DeleteBates">
  3086. <summary>
  3087. 删除贝茨码
  3088. </summary>
  3089. </member>
  3090. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.GetHeaderFooter">
  3091. <summary>
  3092. Gets the document’s header &amp; footer.
  3093. </summary>
  3094. <returns>the document’s header &amp; footer</returns>
  3095. </member>
  3096. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.GetBates">
  3097. <summary>
  3098. Gets the document’s bates.
  3099. </summary>
  3100. <returns>the document’s bates</returns>
  3101. </member>
  3102. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.GetBackground">
  3103. <summary>
  3104. Gets the document’s background.
  3105. </summary>
  3106. <returns>the document’s background</returns>
  3107. </member>
  3108. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.CompressFile_Init(System.Single,ComPDFKit.PDFDocument.CPDFDocument.GetPageIndexDelegate)">
  3109. <summary>
  3110. 压缩初始化
  3111. </summary>
  3112. <param name="imageQuality">图片质量</param>
  3113. <param name="getPageIndexDelegate">页码回调委托</param>
  3114. <returns>用于压缩的句柄</returns>
  3115. </member>
  3116. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.CompressFile_Start(System.IntPtr,System.String)">
  3117. <summary>
  3118. 压缩开始
  3119. </summary>
  3120. <param name="compressOptPtr">压缩句柄</param>
  3121. <param name="savePath">保存路径</param>
  3122. <returns>成功返回true,失败返回false</returns>
  3123. </member>
  3124. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.CompressFile_Cancel(System.IntPtr)">
  3125. <summary>
  3126. 压缩取消
  3127. </summary>
  3128. <param name="compressOptPtr">压缩句柄</param>
  3129. </member>
  3130. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.GetPDFType">
  3131. <summary>
  3132. Gets PDF/A conformance levels.
  3133. </summary>
  3134. <returns>PDF/A conformance levels.</returns>
  3135. </member>
  3136. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.WritePDFAToFilePath(ComPDFKit.PDFDocument.CPDFType,System.String)">
  3137. <summary>
  3138. Converts existing PDF files to PDF/A compliant documents, including PDF/A-1a and PDF/A-1b only.
  3139. The conversion option analyzes the content of existing PDF files and performs a sequence of modifications in order to produce a PDF/A compliant document.
  3140. Features that are not suitable for long-term archiving(such as encryption, obsolete compression schemes, missing fonts, or device-dependent color) are
  3141. replaced with their PDF/A compliant equivalents.Because the conversion process applies only necessary changes to the source file, the information loss is minimal.
  3142. </summary>
  3143. <param name="type">PDF/A conformance levels.</param>
  3144. <param name="filePath">Path of the converted document.</param>
  3145. <returns>Returns whether to convert successfully.</returns>
  3146. </member>
  3147. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.ApplyRedaction">
  3148. <summary>
  3149. Applies redaction annotations in current documentation.
  3150. </summary>
  3151. <returns>Returns true on success, false on failure.</returns>
  3152. </member>
  3153. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.Release">
  3154. <summary>
  3155. Releases resource of the object.
  3156. </summary>
  3157. </member>
  3158. <member name="M:ComPDFKit.PDFDocument.CPDFDocument.ReleasePages(System.Int32)">
  3159. <summary>
  3160. Releases resources of the specified page or release resources of all page objects if pageIndex is -1
  3161. </summary>
  3162. <param name="pageIndex">Page index</param>
  3163. </member>
  3164. <member name="T:ComPDFKit.PDFDocument.CPDFInfo">
  3165. <summary>
  3166. Basic information of PDF document.
  3167. </summary>
  3168. </member>
  3169. <member name="P:ComPDFKit.PDFDocument.CPDFInfo.Title">
  3170. <summary>
  3171. PDF title.
  3172. </summary>
  3173. </member>
  3174. <member name="P:ComPDFKit.PDFDocument.CPDFInfo.Author">
  3175. <summary>
  3176. PDF author.
  3177. </summary>
  3178. </member>
  3179. <member name="P:ComPDFKit.PDFDocument.CPDFInfo.Subject">
  3180. <summary>
  3181. PDF subject.
  3182. </summary>
  3183. </member>
  3184. <member name="P:ComPDFKit.PDFDocument.CPDFInfo.Creator">
  3185. <summary>
  3186. PDF creator.
  3187. </summary>
  3188. </member>
  3189. <member name="P:ComPDFKit.PDFDocument.CPDFInfo.Producer">
  3190. <summary>
  3191. PDF producer.
  3192. </summary>
  3193. </member>
  3194. <member name="P:ComPDFKit.PDFDocument.CPDFInfo.CreationDate">
  3195. <summary>
  3196. Creation date of PDF.
  3197. </summary>
  3198. </member>
  3199. <member name="P:ComPDFKit.PDFDocument.CPDFInfo.ModificationDate">
  3200. <summary>
  3201. Recent modification date of PDF.
  3202. </summary>
  3203. </member>
  3204. <member name="P:ComPDFKit.PDFDocument.CPDFInfo.Keywords">
  3205. <summary>
  3206. PDF keywords.
  3207. </summary>
  3208. </member>
  3209. <member name="P:ComPDFKit.PDFDocument.CPDFInfo.Version">
  3210. <summary>
  3211. PDF version string.
  3212. </summary>
  3213. </member>
  3214. <member name="T:ComPDFKit.PDFDocument.CPDFOutline">
  3215. <summary>
  3216. A document outline (or "table of contents entry"), usually the header of a chapter. Outline objects can be retrieved via ChildList(). They can carry an Action and thus allow quick navigation to document pages, or even external resources.
  3217. </summary>
  3218. </member>
  3219. <member name="P:ComPDFKit.PDFDocument.CPDFOutline.Level">
  3220. <summary>
  3221. Outline level
  3222. </summary>
  3223. </member>
  3224. <member name="P:ComPDFKit.PDFDocument.CPDFOutline.Title">
  3225. <summary>
  3226. Outline title
  3227. </summary>
  3228. </member>
  3229. <member name="P:ComPDFKit.PDFDocument.CPDFOutline.ChildList">
  3230. <summary>
  3231. Gets all the items within an outline hierarchy.
  3232. </summary>
  3233. </member>
  3234. <member name="M:ComPDFKit.PDFDocument.CPDFOutline.IsValid">
  3235. <summary>
  3236. Whether the object is valid.
  3237. </summary>
  3238. <returns>Valid ruturns true, otherwise false</returns>
  3239. </member>
  3240. <member name="M:ComPDFKit.PDFDocument.CPDFOutline.SetTitle(System.String)">
  3241. <summary>
  3242. Sets outline title
  3243. </summary>
  3244. <param name="title">Outline title</param>
  3245. <returns>Returns true on success, false on failure.</returns>
  3246. </member>
  3247. <member name="M:ComPDFKit.PDFDocument.CPDFOutline.SetAction(ComPDFKit.PDFDocument.Action.CPDFAction)">
  3248. <summary>
  3249. Sets the action performed when users click the outline, more:<see cref="T:ComPDFKit.PDFDocument.Action.CPDFAction"/>
  3250. </summary>
  3251. <param name="action">The action performed when users click the outline</param>
  3252. <returns>Returns true on success, false on failure.</returns>
  3253. </member>
  3254. <member name="M:ComPDFKit.PDFDocument.CPDFOutline.GetAction">
  3255. <summary>
  3256. Gets the action performed when users click the outline, more: <see cref="T:ComPDFKit.PDFDocument.Action.CPDFAction"/>
  3257. </summary>
  3258. <returns>The action performed when users click the outline.</returns>
  3259. </member>
  3260. <member name="M:ComPDFKit.PDFDocument.CPDFOutline.GetDestination(ComPDFKit.PDFDocument.CPDFDocument)">
  3261. <summary>
  3262. Gets the destination associated with the outline, more:<see cref="T:ComPDFKit.PDFDocument.CPDFDestination"/>
  3263. </summary>
  3264. <param name="document">CPDFDocument object.</param>
  3265. <returns>The destination associated with the outline.</returns>
  3266. </member>
  3267. <member name="M:ComPDFKit.PDFDocument.CPDFOutline.SetDestination(ComPDFKit.PDFDocument.CPDFDocument,ComPDFKit.PDFDocument.CPDFDestination)">
  3268. <summary>
  3269. Sets the destination associated with the outline, more:<see cref="T:ComPDFKit.PDFDocument.CPDFDestination"/>
  3270. </summary>
  3271. <param name="document">CPDFDocument object.</param>
  3272. <param name="dest">The destination associated with the outline.</param>
  3273. <returns>Returns true on success, false on failure.</returns>
  3274. </member>
  3275. <member name="M:ComPDFKit.PDFDocument.CPDFOutline.GetParent">
  3276. <summary>
  3277. Gets the parent outline object of the outline.
  3278. </summary>
  3279. <returns>Returns the parent outline object of the outline.</returns>
  3280. </member>
  3281. <member name="M:ComPDFKit.PDFDocument.CPDFOutline.InsertChildAtIndex(ComPDFKit.PDFDocument.CPDFDocument,System.Int32,ComPDFKit.PDFDocument.CPDFOutline@)">
  3282. <summary>
  3283. Creates an outline object and inserts the outline object at the specified index.
  3284. </summary>
  3285. <param name="document">CPDFDocument object.</param>
  3286. <param name="index">Child item index of outline.</param>
  3287. <param name="outline">The new index object.</param>
  3288. <returns>Returns true on success, false on failure.</returns>
  3289. </member>
  3290. <member name="M:ComPDFKit.PDFDocument.CPDFOutline.MoveChildAtIndex(ComPDFKit.PDFDocument.CPDFDocument,ComPDFKit.PDFDocument.CPDFOutline,System.Int32)">
  3291. <summary>
  3292. Moves child outline to specified index.
  3293. </summary>
  3294. <param name="document">CPDFDocument object.</param>
  3295. <param name="child">Child outline.</param>
  3296. <param name="index">Specified index.</param>
  3297. <returns>Returns true on success, false on failure.</returns>
  3298. </member>
  3299. <member name="M:ComPDFKit.PDFDocument.CPDFOutline.RemoveFromParent(ComPDFKit.PDFDocument.CPDFDocument)">
  3300. <summary>
  3301. Removes the outline object from its parent.
  3302. </summary>
  3303. <param name="document">CPDFDocument object.</param>
  3304. <returns>Returns true on success, false on failure.</returns>
  3305. </member>
  3306. <member name="T:ComPDFKit.PDFDocument.C_Background_Type">
  3307. <summary>
  3308. Background type.
  3309. </summary>
  3310. </member>
  3311. <member name="F:ComPDFKit.PDFDocument.C_Background_Type.BG_TYPE_UNKNOWN">
  3312. <summary>
  3313. Unknown type
  3314. </summary>
  3315. </member>
  3316. <member name="F:ComPDFKit.PDFDocument.C_Background_Type.BG_TYPE_COLOR">
  3317. <summary>
  3318. Text background
  3319. </summary>
  3320. </member>
  3321. <member name="F:ComPDFKit.PDFDocument.C_Background_Type.BG_TYPE_IMAGE">
  3322. <summary>
  3323. Image background
  3324. </summary>
  3325. </member>
  3326. <member name="T:ComPDFKit.PDFDocument.C_Background_Horizalign">
  3327. <summary>
  3328. Vertical alignment.
  3329. </summary>
  3330. </member>
  3331. <member name="F:ComPDFKit.PDFDocument.C_Background_Horizalign.BG_HORIZALIGN_UNKNOWN">
  3332. <summary>
  3333. Unknown type
  3334. </summary>
  3335. </member>
  3336. <member name="F:ComPDFKit.PDFDocument.C_Background_Horizalign.BG_HORIZALIGN_LEFT">
  3337. <summary>
  3338. Align horizontally to left
  3339. </summary>
  3340. </member>
  3341. <member name="F:ComPDFKit.PDFDocument.C_Background_Horizalign.BG_HORIZALIGN_CENTER">
  3342. <summary>
  3343. Align horizontally centered
  3344. </summary>
  3345. </member>
  3346. <member name="F:ComPDFKit.PDFDocument.C_Background_Horizalign.BG_HORIZALIGN_RIGHT">
  3347. <summary>
  3348. Align horizontally to right
  3349. </summary>
  3350. </member>
  3351. <member name="T:ComPDFKit.PDFDocument.C_Background_Vertalign">
  3352. <summary>
  3353. Vertical alignment.
  3354. </summary>
  3355. </member>
  3356. <member name="F:ComPDFKit.PDFDocument.C_Background_Vertalign.BG_VERTALIGN_UNKNOWN">
  3357. <summary>
  3358. Unknown type
  3359. </summary>
  3360. </member>
  3361. <member name="F:ComPDFKit.PDFDocument.C_Background_Vertalign.BG_VERTALIGN_TOP">
  3362. <summary>
  3363. Align Vertically to the top
  3364. </summary>
  3365. </member>
  3366. <member name="F:ComPDFKit.PDFDocument.C_Background_Vertalign.BG_VERTALIGN_CENTER">
  3367. <summary>
  3368. Align Vertically centered
  3369. </summary>
  3370. </member>
  3371. <member name="F:ComPDFKit.PDFDocument.C_Background_Vertalign.BG_VERTALIGN_BOTTOM">
  3372. <summary>
  3373. Align Vertically to the bottom
  3374. </summary>
  3375. </member>
  3376. <member name="T:ComPDFKit.PDFDocument.CPDFBackground">
  3377. <summary>
  3378. Adds and removes the background.
  3379. </summary>
  3380. </member>
  3381. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.IsValid">
  3382. <summary>
  3383. Whether object is valid, false means the object resource is released, you cannot use the object to call any method.
  3384. </summary>
  3385. <returns>Whether object is valid, false means the object resource is released, you cannot use the object to call any method.</returns>
  3386. </member>
  3387. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.Release">
  3388. <summary>
  3389. Releases Background object resource.
  3390. </summary>
  3391. </member>
  3392. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.GetBackgroundType">
  3393. <summary>
  3394. Gets the type of the background.
  3395. </summary>
  3396. <returns>the type of the background</returns>
  3397. </member>
  3398. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.SetBackgroundType(ComPDFKit.PDFDocument.C_Background_Type)">
  3399. <summary>
  3400. Sets the type of the background.
  3401. </summary>
  3402. <param name="type">the type of the background</param>
  3403. <returns>Returns true on success, false on failure.</returns>
  3404. </member>
  3405. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.GetOpacity">
  3406. <summary>
  3407. Gets the opacity of the background.
  3408. </summary>
  3409. <returns>the opacity of the background</returns>
  3410. </member>
  3411. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.SetOpacity(System.Byte)">
  3412. <summary>
  3413. Sets the opacity of the background.
  3414. </summary>
  3415. <param name="opacity">the opacity of the background</param>
  3416. <returns>Returns true on success, false on failure.</returns>
  3417. </member>
  3418. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.GetScale">
  3419. <summary>
  3420. Gets the scale of the background.
  3421. </summary>
  3422. <returns>the scale of the background</returns>
  3423. </member>
  3424. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.SetScale(System.Single)">
  3425. <summary>
  3426. Sets the scale of the background.
  3427. </summary>
  3428. <param name="scale">the scale of the background</param>
  3429. <returns>Returns true on success, false on failure.</returns>
  3430. </member>
  3431. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.GetRotation">
  3432. <summary>
  3433. Gets the rotation angle of the background.
  3434. </summary>
  3435. <returns>the rotation angle of the background</returns>
  3436. </member>
  3437. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.SetRotation(System.Single)">
  3438. <summary>
  3439. Sets the rotation angle of the background.
  3440. </summary>
  3441. <param name="rotation">the rotation angle of the background</param>
  3442. <returns>Returns true on success, false on failure.</returns>
  3443. </member>
  3444. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.GetHorizalign">
  3445. <summary>
  3446. Gets the horizontal alignment of the background.
  3447. </summary>
  3448. <returns>the horizontal alignment</returns>
  3449. </member>
  3450. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.SetHorizalign(ComPDFKit.PDFDocument.C_Background_Horizalign)">
  3451. <summary>
  3452. Sets the horizontal alignment of the background.
  3453. </summary>
  3454. <param name="horizalign">the horizontal alignment</param>
  3455. <returns>Returns true on success, false on failure.</returns>
  3456. </member>
  3457. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.GetVertalign">
  3458. <summary>
  3459. Gets the vertical alignment of the background.
  3460. </summary>
  3461. <returns>the vertical alignment</returns>
  3462. </member>
  3463. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.SetVertalign(ComPDFKit.PDFDocument.C_Background_Vertalign)">
  3464. <summary>
  3465. Sets the vertical alignment of the background.
  3466. </summary>
  3467. <param name="vertalign">the vertical alignment</param>
  3468. <returns>Returns true on success, false on failure.</returns>
  3469. </member>
  3470. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.GetXOffset">
  3471. <summary>
  3472. Gets the horizontal offset of the background.
  3473. </summary>
  3474. <returns>the horizontal offset</returns>
  3475. </member>
  3476. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.SetXOffset(System.Single)">
  3477. <summary>
  3478. Sets the horizontal offset of the background.
  3479. </summary>
  3480. <param name="xOffect">the horizontal offset</param>
  3481. <returns>Returns true on success, false on failure.</returns>
  3482. </member>
  3483. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.GetYOffset">
  3484. <summary>
  3485. Gets the vertical offset of the background.
  3486. </summary>
  3487. <returns>the vertical offset</returns>
  3488. </member>
  3489. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.SetYOffset(System.Single)">
  3490. <summary>
  3491. Sets the vertical offset of the background.
  3492. </summary>
  3493. <param name="yOffect">the vertical offset</param>
  3494. <returns>Returns true on success, false on failure.</returns>
  3495. </member>
  3496. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.IsAllowsView">
  3497. <summary>
  3498. Gets whether to support the background to be displayed.
  3499. </summary>
  3500. <returns>whether to support the background to be displayed</returns>
  3501. </member>
  3502. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.SetAllowsView(System.Boolean)">
  3503. <summary>
  3504. Sets whether to support the background to be displayed.
  3505. </summary>
  3506. <param name="allowsView">whether to support the background to be displayed</param>
  3507. <returns>Returns true on success, false on failure.</returns>
  3508. </member>
  3509. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.IsAllowsPrint">
  3510. <summary>
  3511. Gets whether to support the background to be printed.
  3512. </summary>
  3513. <returns>whether to support the background to be printed</returns>
  3514. </member>
  3515. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.SetAllowsPrint(System.Boolean)">
  3516. <summary>
  3517. Sets whether to support the background to be printed.
  3518. </summary>
  3519. <param name="allowsPrint">whether to support the background to be printed</param>
  3520. <returns>Returns true on success, false on failure.</returns>
  3521. </member>
  3522. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.GetPages">
  3523. <summary>
  3524. Gets the page range of the background by string, such as "0,3,5-7".
  3525. </summary>
  3526. <returns>the page range for the background</returns>
  3527. </member>
  3528. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.SetPages(System.String)">
  3529. <summary>
  3530. Sets the page range of the background by string, such as "0,3,5-7".
  3531. </summary>
  3532. <param name="pages">the page range of the background</param>
  3533. <returns>Returns true on success, false on failure.</returns>
  3534. </member>
  3535. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.GetImage">
  3536. <summary>
  3537. Gets the image of the background.
  3538. </summary>
  3539. <returns>the image of the background</returns>
  3540. </member>
  3541. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.SetImage(System.Byte[],System.Int32,System.Int32,ComPDFKit.Import.C_Scale_Type)">
  3542. <summary>
  3543. Gets the image of the background.
  3544. </summary>
  3545. <param name="imageData">Image resource.</param>
  3546. <param name="imageWidth">Image width.</param>
  3547. <param name="imageHeight">Image height.</param>
  3548. <param name="scaleType">The zoom rule for filling the image into the background</param>
  3549. <returns>Returns true on success, false on failure.</returns>
  3550. </member>
  3551. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.GetColor">
  3552. <summary>
  3553. Gets the color of the background.
  3554. </summary>
  3555. <returns>the color of the background</returns>
  3556. </member>
  3557. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.SetColor(System.Byte[])">
  3558. <summary>
  3559. Sets the color of the background.
  3560. </summary>
  3561. <param name="color">the color of the background</param>
  3562. <returns>Returns true on success, false on failure.</returns>
  3563. </member>
  3564. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.Update">
  3565. <summary>
  3566. Updates the background.
  3567. </summary>
  3568. <returns>Returns true on success, false on failure.</returns>
  3569. </member>
  3570. <member name="M:ComPDFKit.PDFDocument.CPDFBackground.Clear">
  3571. <summary>
  3572. Removes the background.
  3573. </summary>
  3574. <returns>Returns true on success, false on failure.</returns>
  3575. </member>
  3576. <member name="T:ComPDFKit.Compare.CPDFCompareContent">
  3577. <summary>
  3578. Quickly pinpoint changes by comparing two versions of a PDF file.
  3579. </summary>
  3580. </member>
  3581. <member name="M:ComPDFKit.Compare.CPDFCompareContent.#ctor(ComPDFKit.PDFDocument.CPDFDocument,ComPDFKit.PDFDocument.CPDFDocument)">
  3582. <summary>
  3583. Initialize it with the given two versions of a document.
  3584. By default, it will generate a comparison document according to the order of pages, starting from the first page of both versions of the document.
  3585. </summary>
  3586. <param name="oldDocument">The old version of document.</param>
  3587. <param name="newDocument">The new version of document.</param>
  3588. </member>
  3589. <member name="M:ComPDFKit.Compare.CPDFCompareContent.Compare(System.Int32,System.Int32,ComPDFKit.Compare.CPDFCompareType,System.Boolean)">
  3590. <summary>
  3591. Specifies pages and types to compare.
  3592. </summary>
  3593. <param name="oldPageIndex"></param>
  3594. <param name="newPageIndex"></param>
  3595. <param name="compareType"></param>
  3596. <param name="drawHighlight"></param>
  3597. <returns></returns>
  3598. </member>
  3599. <member name="M:ComPDFKit.Compare.CPDFCompareContent.SetReplaceColor(System.Byte[])">
  3600. <summary>
  3601. Sets to replace the highlight color.
  3602. </summary>
  3603. <param name="color"></param>
  3604. </member>
  3605. <member name="M:ComPDFKit.Compare.CPDFCompareContent.SetInsertColor(System.Byte[])">
  3606. <summary>
  3607. Sets to insert the highlight color.
  3608. </summary>
  3609. <param name="color"></param>
  3610. </member>
  3611. <member name="M:ComPDFKit.Compare.CPDFCompareContent.SetDeleteColor(System.Byte[])">
  3612. <summary>
  3613. Sets to remove the highlight color.
  3614. </summary>
  3615. <param name="color"></param>
  3616. </member>
  3617. <member name="M:ComPDFKit.Compare.CPDFCompareContent.SetReplaceTransparency(System.Byte)">
  3618. <summary>
  3619. </summary>
  3620. <param name="transparency"></param>
  3621. </member>
  3622. <member name="M:ComPDFKit.Compare.CPDFCompareContent.SetInsertTransparency(System.Byte)">
  3623. <summary>
  3624. </summary>
  3625. <param name="transparency"></param>
  3626. </member>
  3627. <member name="M:ComPDFKit.Compare.CPDFCompareContent.SetDeleteTransparency(System.Byte)">
  3628. <summary>
  3629. </summary>
  3630. <param name="transparency"></param>
  3631. </member>
  3632. <member name="M:ComPDFKit.Compare.CPDFCompareContent.SaveAsComparisonDocument(System.String)">
  3633. <summary>
  3634. Saves the comparison document.
  3635. </summary>
  3636. <param name="savePath"></param>
  3637. <returns></returns>
  3638. </member>
  3639. <member name="M:ComPDFKit.Compare.CPDFCompareContent.Release">
  3640. <summary>
  3641. Releases CPDFCompareContent object resource.
  3642. </summary>
  3643. </member>
  3644. <member name="T:ComPDFKit.Compare.CPDFCompareOverlay">
  3645. <summary>
  3646. Overlay Comparison is used to visually compare pages of different documents.
  3647. It’s helpful for things such as construction plans and detailed drawings,
  3648. as well as other content that requires precise placement.
  3649. </summary>
  3650. </member>
  3651. <member name="M:ComPDFKit.Compare.CPDFCompareOverlay.#ctor(ComPDFKit.PDFDocument.CPDFDocument,System.String,ComPDFKit.PDFDocument.CPDFDocument,System.String)">
  3652. <summary>
  3653. Initialize it with the given two versions of a document.
  3654. and indices of the pages on which the points should be selected in both versions of a document.
  3655. </summary>
  3656. <param name="oldDocument">The old version of a document.</param>
  3657. <param name="oldPageRange">The page range of the old document, for example: 1,3,5,6-10.</param>
  3658. <param name="newDocument">The new version of a document.</param>
  3659. <param name="newPageRange">The page range of the new document, for example: 1,3,5,6-10.</param>
  3660. </member>
  3661. <member name="M:ComPDFKit.Compare.CPDFCompareOverlay.#ctor(ComPDFKit.PDFDocument.CPDFDocument,ComPDFKit.PDFDocument.CPDFDocument)">
  3662. <summary>
  3663. Initialize it with the given two versions of a document.
  3664. By default, it will generate a comparison document according to the order of pages, starting from the first page of both versions of the document.
  3665. </summary>
  3666. <param name="oldDocument">The old version of document.</param>
  3667. <param name="newDocument">The new version of document.</param>
  3668. </member>
  3669. <member name="M:ComPDFKit.Compare.CPDFCompareOverlay.Compare">
  3670. <summary>
  3671. Compares the document.
  3672. </summary>
  3673. </member>
  3674. <member name="M:ComPDFKit.Compare.CPDFCompareOverlay.SetOldDocumentStrokeColor(System.Byte[])">
  3675. <summary>
  3676. Sets the color that will be used to replace all strokes in the old version of a document.
  3677. </summary>
  3678. <param name="strokeColor">RGB color value, range 0-255.</param>
  3679. <returns>Returns true on success, false on failure.</returns>
  3680. </member>
  3681. <member name="M:ComPDFKit.Compare.CPDFCompareOverlay.SetNewDocumentStrokeColor(System.Byte[])">
  3682. <summary>
  3683. Sets the color that will be used to replace all strokes in the new version of a document.
  3684. </summary>
  3685. <param name="strokeColor">RGB color value, range 0-255.</param>
  3686. <returns>Returns true on success, false on failure.</returns>
  3687. </member>
  3688. <member name="M:ComPDFKit.Compare.CPDFCompareOverlay.SetOldDocumentStrokeAlpha(System.Single)">
  3689. <summary>
  3690. Sets the opacity that will be used to replace all strokes in the old version of a document.
  3691. </summary>
  3692. <param name="strokeAlpha">Opacity value, range 0-1.</param>
  3693. <returns>Returns true on success, false on failure.</returns>
  3694. </member>
  3695. <member name="M:ComPDFKit.Compare.CPDFCompareOverlay.SetNewDocumentStrokeAlpha(System.Single)">
  3696. <summary>
  3697. Sets the opacity that will be used to replace all strokes in the new version of a document.
  3698. </summary>
  3699. <param name="strokeAlpha">Opacity value, range 0-1.</param>
  3700. <returns>Returns true on success, false on failure.</returns>
  3701. </member>
  3702. <member name="M:ComPDFKit.Compare.CPDFCompareOverlay.SetOldDocumentFillAlpha(System.Single)">
  3703. <summary>
  3704. Sets the fill opacity that will be used to replace all strokes in the old version of a document.
  3705. </summary>
  3706. <param name="fillAlpha">Opacity value, range 0-1.</param>
  3707. <returns>Returns true on success, false on failure.</returns>
  3708. </member>
  3709. <member name="M:ComPDFKit.Compare.CPDFCompareOverlay.SetNewDocumentFillAlpha(System.Single)">
  3710. <summary>
  3711. Sets the fill opacity that will be used to replace all strokes in the new version of a document.
  3712. </summary>
  3713. <param name="fillAlpha">Opacity value, range 0-1.</param>
  3714. <returns>Returns true on success, false on failure.</returns>
  3715. </member>
  3716. <member name="M:ComPDFKit.Compare.CPDFCompareOverlay.SetNoFill(System.Boolean)">
  3717. <summary>
  3718. Sets whether the path is filled with white.
  3719. </summary>
  3720. <param name="noFill"></param>
  3721. <returns>Returns true on success, false on failure</returns>
  3722. </member>
  3723. <member name="M:ComPDFKit.Compare.CPDFCompareOverlay.SetBlendMode(ComPDFKit.Compare.CPDFBlendMode)">
  3724. <summary>
  3725. Sets the blend mode that will be used when overlaying the new version of a document onto the old version.
  3726. </summary>
  3727. <param name="bm">Blend mode.</param>
  3728. <returns>Returns true on success, false on failure.</returns>
  3729. </member>
  3730. <member name="M:ComPDFKit.Compare.CPDFCompareOverlay.ComparisonDocument">
  3731. <summary>
  3732. Gets the generated comparison document once the user compares both versions of a document.
  3733. </summary>
  3734. <returns>The generated document.</returns>
  3735. </member>
  3736. <member name="M:ComPDFKit.Compare.CPDFCompareOverlay.Release">
  3737. <summary>
  3738. Releases CPDFCompareOverlay object resource.
  3739. </summary>
  3740. </member>
  3741. <member name="T:ComPDFKit.Compare.CPDFCompareResult">
  3742. <summary>
  3743. This class is about the information about a result of comparing content.
  3744. </summary>
  3745. </member>
  3746. <member name="F:ComPDFKit.Compare.CPDFCompareResult.Type">
  3747. <summary>
  3748. Gets the type of a result of comparing content.
  3749. </summary>
  3750. </member>
  3751. <member name="F:ComPDFKit.Compare.CPDFCompareResult.OldPageIndex">
  3752. <summary>
  3753. Gets the old version page index of a result of comparing content.
  3754. </summary>
  3755. </member>
  3756. <member name="F:ComPDFKit.Compare.CPDFCompareResult.NewPageIndex">
  3757. <summary>
  3758. Gets the new version page index of a result of comparing content.
  3759. </summary>
  3760. </member>
  3761. <member name="F:ComPDFKit.Compare.CPDFCompareResult.OldRect">
  3762. <summary>
  3763. Gets the old version page range of a result of comparing content.
  3764. </summary>
  3765. </member>
  3766. <member name="F:ComPDFKit.Compare.CPDFCompareResult.NewRect">
  3767. <summary>
  3768. Gets the new version page range of a result of comparing content.
  3769. </summary>
  3770. </member>
  3771. <member name="T:ComPDFKit.Compare.CPDFCompareResults">
  3772. <summary>
  3773. This class is about the results of comparing content.
  3774. </summary>
  3775. </member>
  3776. <member name="P:ComPDFKit.Compare.CPDFCompareResults.TextResults">
  3777. <summary>
  3778. Gets the array of the results of comparing text.
  3779. </summary>
  3780. </member>
  3781. <member name="P:ComPDFKit.Compare.CPDFCompareResults.ImageResults">
  3782. <summary>
  3783. Gets the array of the results of comparing image.
  3784. </summary>
  3785. </member>
  3786. <member name="P:ComPDFKit.Compare.CPDFCompareResults.DeleteCount">
  3787. <summary>
  3788. Gets the count of removal.
  3789. </summary>
  3790. </member>
  3791. <member name="P:ComPDFKit.Compare.CPDFCompareResults.InsertCount">
  3792. <summary>
  3793. Gets the count of insert.
  3794. </summary>
  3795. </member>
  3796. <member name="P:ComPDFKit.Compare.CPDFCompareResults.ReplaceCount">
  3797. <summary>
  3798. Gets the count of replacement.
  3799. </summary>
  3800. </member>
  3801. <member name="T:ComPDFKit.PDFPage.CPDFEditType">
  3802. <summary>
  3803. Edit Type.
  3804. </summary>
  3805. </member>
  3806. <member name="F:ComPDFKit.PDFPage.CPDFEditType.None">
  3807. <summary>
  3808. None.
  3809. </summary>
  3810. </member>
  3811. <member name="F:ComPDFKit.PDFPage.CPDFEditType.EditText">
  3812. <summary>
  3813. Text.
  3814. </summary>
  3815. </member>
  3816. <member name="F:ComPDFKit.PDFPage.CPDFEditType.EditImage">
  3817. <summary>
  3818. Image.
  3819. </summary>
  3820. </member>
  3821. <member name="T:ComPDFKit.PDFPage.CPDFEditPage">
  3822. <summary>
  3823. This class is about PDF contents editing.
  3824. </summary>
  3825. </member>
  3826. <member name="M:ComPDFKit.PDFPage.CPDFEditPage.GetEditAreaList(System.Boolean)">
  3827. <summary>
  3828. Gets a list of editing areas of the page.
  3829. </summary>
  3830. <param name="regain">Whether to obtain it again.</param>
  3831. <returns>A list of editing areas.</returns>
  3832. </member>
  3833. <member name="M:ComPDFKit.PDFPage.CPDFEditPage.IsValid">
  3834. <summary>
  3835. Whether the text editing page object is valid.
  3836. </summary>
  3837. <returns>Returns true for valid, false for invalid.</returns>
  3838. </member>
  3839. <member name="M:ComPDFKit.PDFPage.CPDFEditPage.Release">
  3840. <summary>
  3841. Releases the text editing page object.
  3842. </summary>
  3843. </member>
  3844. <member name="M:ComPDFKit.PDFPage.CPDFEditPage.BeginEdit(ComPDFKit.PDFPage.CPDFEditType)">
  3845. <summary>
  3846. Begins editing PDF contents.
  3847. </summary>
  3848. <param name="type">Edit type.</param>
  3849. </member>
  3850. <member name="M:ComPDFKit.PDFPage.CPDFEditPage.EndEdit">
  3851. <summary>
  3852. Ends editing PDF contents.
  3853. </summary>
  3854. </member>
  3855. <member name="M:ComPDFKit.PDFPage.CPDFEditPage.CanRedo">
  3856. <summary>
  3857. Whether it can be redone.
  3858. </summary>
  3859. <returns>Returns true if can, false otherwise.</returns>
  3860. </member>
  3861. <member name="M:ComPDFKit.PDFPage.CPDFEditPage.CanUndo">
  3862. <summary>
  3863. Whether it can be undone.
  3864. </summary>
  3865. <returns>Returns true if can, false otherwise.</returns>
  3866. </member>
  3867. <member name="M:ComPDFKit.PDFPage.CPDFEditPage.Redo">
  3868. <summary>
  3869. Redo.
  3870. </summary>
  3871. <returns>Position of text cursor.</returns>
  3872. </member>
  3873. <member name="M:ComPDFKit.PDFPage.CPDFEditPage.Undo">
  3874. <summary>
  3875. Undo.
  3876. </summary>
  3877. <returns>Position of text cursor.</returns>
  3878. </member>
  3879. <member name="M:ComPDFKit.PDFPage.CPDFEditPage.CreateNewTextArea(System.Windows.Rect,System.String,System.Single,System.Byte[])">
  3880. <summary>
  3881. Creates a new text area.
  3882. </summary>
  3883. <param name="rect">Rectangle on the page.</param>
  3884. <param name="fontName">Font name.</param>
  3885. <param name="fontSize">Font size.</param>
  3886. <param name="fontColor">Font color.</param>
  3887. <returns>Text area.</returns>
  3888. </member>
  3889. <member name="M:ComPDFKit.PDFPage.CPDFEditPage.CreateNewImageArea(System.Windows.Rect,System.Byte[],System.Int32,System.Int32)">
  3890. <summary>
  3891. Creates a new image area.
  3892. </summary>
  3893. <param name="rect">Rectangle on the page.</param>
  3894. <param name="imageData">Image resource.</param>
  3895. <param name="imageWidth">Image width.</param>
  3896. <param name="imageHeight">Image height.</param>
  3897. <returns>Image area.</returns>
  3898. </member>
  3899. <member name="M:ComPDFKit.PDFPage.CPDFEditPage.RemoveEditArea(System.Int32)">
  3900. <summary>
  3901. Removes the editing area.
  3902. </summary>
  3903. <param name="index">Editing area index.</param>
  3904. </member>
  3905. <member name="T:ComPDFKit.PDFPage.CPDFPage">
  3906. <summary>
  3907. CPDFPage defines methods used to render PDF pages and work with annotations, text, selections and so on.
  3908. </summary>
  3909. </member>
  3910. <member name="P:ComPDFKit.PDFPage.CPDFPage.Rotation">
  3911. <summary>
  3912. Gets the rotation angle for the page in degrees:0,1,2,3
  3913. </summary>
  3914. </member>
  3915. <member name="P:ComPDFKit.PDFPage.CPDFPage.PageIndex">
  3916. <summary>
  3917. Gets page index.
  3918. </summary>
  3919. </member>
  3920. <member name="P:ComPDFKit.PDFPage.CPDFPage.PageSize">
  3921. <summary>
  3922. Gets page size.
  3923. </summary>
  3924. </member>
  3925. <member name="M:ComPDFKit.PDFPage.CPDFPage.#ctor(ComPDFKit.PDFDocument.CPDFDocument,System.Int32,System.Boolean)">
  3926. <summary>
  3927. Constructor function
  3928. </summary>
  3929. <param name="document">CPDFDocument object</param>
  3930. <param name="pageIndex">Page number</param>
  3931. <param name="isNeedParse">Whether it needs to be parsed</param>
  3932. </member>
  3933. <member name="M:ComPDFKit.PDFPage.CPDFPage.IsValid">
  3934. <summary>
  3935. Whether the object is valid.
  3936. </summary>
  3937. <returns>Returns true if valid, otherwise false</returns>
  3938. </member>
  3939. <member name="M:ComPDFKit.PDFPage.CPDFPage.GetAnnotCount">
  3940. <summary>
  3941. Gets the count of annotations on the page.
  3942. </summary>
  3943. <returns>Count of annotations</returns>
  3944. </member>
  3945. <member name="M:ComPDFKit.PDFPage.CPDFPage.ReleaseAllAnnotations">
  3946. <summary>
  3947. Releases all annotation resources on the page.
  3948. </summary>
  3949. </member>
  3950. <member name="M:ComPDFKit.PDFPage.CPDFPage.GetAnnotations">
  3951. <summary>
  3952. Gets all the annotation collections on the page.
  3953. </summary>
  3954. <returns>List of all annotations</returns>
  3955. </member>
  3956. <member name="M:ComPDFKit.PDFPage.CPDFPage.GetString">
  3957. <summary>
  3958. </summary>
  3959. <returns></returns>
  3960. </member>
  3961. <member name="M:ComPDFKit.PDFPage.CPDFPage.RenderPageBitmapWithMatrix(System.Single,System.Windows.Rect,System.UInt32,System.Byte[],System.Int32,System.Boolean)">
  3962. <summary>
  3963. Render contents of a page to a device independent bitmap.
  3964. </summary>
  3965. <param name="ZoomFactor">Zoom level</param>
  3966. <param name="RenderRect">Render range</param>
  3967. <param name="bgColor">Background color</param>
  3968. <param name="bmp_data">Image data</param>
  3969. <param name="flag">Render flag, set 1 if annotation are to be rendered, 0 for normal display</param>
  3970. <param name="form">Whether to render form widgets</param>
  3971. </member>
  3972. <member name="M:ComPDFKit.PDFPage.CPDFPage.RenderPageBitmap(System.Int32,System.Int32,System.Int32,System.Int32,System.UInt32,System.Byte[],System.Int32,System.Boolean)">
  3973. <summary>
  3974. Render contents of the page to image data.
  3975. </summary>
  3976. <param name="x">X coordinate in the upper left corner</param>
  3977. <param name="y">Y coordinate in the upper left corner</param>
  3978. <param name="width">Horizontal size (in pixels) for displaying the page.</param>
  3979. <param name="height">Vertical size (in pixels) for displaying the page.</param>
  3980. <param name="bgColor">Background color</param>
  3981. <param name="bmp_data">Image data</param>
  3982. <param name="flag">Render flag, set 1 if annotation are to be rendered, 0 for normal display</param>
  3983. <param name="form">Whether to render form widgets</param>
  3984. </member>
  3985. <member name="M:ComPDFKit.PDFPage.CPDFPage.RenderPageBitmapWithMatrix(System.Single,System.Windows.Rect,System.UInt32,System.IntPtr,System.Int32,System.Boolean)">
  3986. <summary>
  3987. Render contents of the page at the specified rectangle to image data handle.
  3988. </summary>
  3989. <param name="ZoomFactor">Zoom level</param>
  3990. <param name="RenderRect">Render area</param>
  3991. <param name="bgColor">Background color</param>
  3992. <param name="bmp_data">Image data handle</param>
  3993. <param name="flag">Render flag, set 1 if annotation are to be rendered, 0 for normal display</param>
  3994. <param name="form">Whether to render form widgets</param>
  3995. </member>
  3996. <member name="M:ComPDFKit.PDFPage.CPDFPage.RenderPageBitmap(System.Int32,System.Int32,System.Int32,System.Int32,System.UInt32,System.IntPtr,System.Int32,System.Boolean)">
  3997. <summary>
  3998. Render contents of the page to image data handle.
  3999. </summary>
  4000. <param name="x">X coordinate in the upper left corner</param>
  4001. <param name="y">Y coordinate in the upper left corner</param>
  4002. <param name="width">Horizontal size (in pixels) for displaying the page</param>
  4003. <param name="height">Vertical size (in pixels) for displaying the page.</param>
  4004. <param name="bgColor">Background color</param>
  4005. <param name="bmp_data">Image data handle</param>
  4006. <param name="flag">Render flag, set 1 if annotation are to be rendered, 0 for normal display</param>
  4007. <param name="form">Whether to render form widgets</param>
  4008. </member>
  4009. <member name="M:ComPDFKit.PDFPage.CPDFPage.GetTextPage">
  4010. <summary>
  4011. Gets TextPage, this class is for text related functions, more:<see cref="T:ComPDFKit.PDFPage.CPDFTextPage"/>
  4012. </summary>
  4013. <returns>Text page object.</returns>
  4014. </member>
  4015. <member name="M:ComPDFKit.PDFPage.CPDFPage.GetEditPage">
  4016. <summary>
  4017. Gets EditPage, this class is for text related functions, more:<see cref="T:ComPDFKit.PDFPage.CPDFEditPage"/>
  4018. </summary>
  4019. <returns>Edit page object.</returns>
  4020. </member>
  4021. <member name="M:ComPDFKit.PDFPage.CPDFPage.GetImgSelection">
  4022. <summary>
  4023. </summary>
  4024. <returns></returns>
  4025. </member>
  4026. <member name="M:ComPDFKit.PDFPage.CPDFPage.CropPage(ComPDFKit.PDFPage.CPDFDisplayBox,System.Windows.Rect)">
  4027. <summary>
  4028. </summary>
  4029. <param name="cropBox"></param>
  4030. <param name="cropRect"></param>
  4031. </member>
  4032. <member name="M:ComPDFKit.PDFPage.CPDFPage.GetBoundsForBox(ComPDFKit.PDFPage.CPDFDisplayBox)">
  4033. <summary>
  4034. </summary>
  4035. <param name="displayBox"></param>
  4036. <returns></returns>
  4037. </member>
  4038. <member name="M:ComPDFKit.PDFPage.CPDFPage.GetCropBounds">
  4039. <summary>
  4040. Gets crop rectangle.
  4041. </summary>
  4042. <returns>Returns crop rectangle.</returns>
  4043. </member>
  4044. <member name="M:ComPDFKit.PDFPage.CPDFPage.ReleasePage">
  4045. <summary>
  4046. Releases resources of the page object.
  4047. </summary>
  4048. </member>
  4049. <member name="M:ComPDFKit.PDFPage.CPDFPage.CreateAnnot(ComPDFKit.PDFAnnotation.C_ANNOTATION_TYPE)">
  4050. <summary>
  4051. Adds annotations on page according to the type of annotation.
  4052. </summary>
  4053. <param name="annotType">Annotation type</param>
  4054. <returns>Annotation object</returns>
  4055. </member>
  4056. <member name="M:ComPDFKit.PDFPage.CPDFPage.CreateWidget(ComPDFKit.PDFAnnotation.Form.C_WIDGET_TYPE)">
  4057. <summary>
  4058. Creates form widgets on the page according to the type of form widgets.
  4059. </summary>
  4060. <param name="widgetType">Form widget type</param>
  4061. <returns>Form widget object</returns>
  4062. </member>
  4063. <member name="M:ComPDFKit.PDFPage.CPDFPage.GetTextContentRect(System.Single,System.String,System.String)">
  4064. <summary>
  4065. </summary>
  4066. <param name="fontSize"></param>
  4067. <param name="fontName"></param>
  4068. <param name="textContent"></param>
  4069. <returns></returns>
  4070. </member>
  4071. <member name="M:ComPDFKit.PDFPage.CPDFPage.ApplyRedaction">
  4072. <summary>
  4073. Applies redaction annotations in current page.
  4074. </summary>
  4075. <returns>Returns true on success, false on failure.</returns>
  4076. </member>
  4077. <member name="T:ComPDFKit.PDFPage.CPDFTextPage">
  4078. <summary>
  4079. This class is about PDF page text content.
  4080. </summary>
  4081. </member>
  4082. <member name="M:ComPDFKit.PDFPage.CPDFTextPage.IsValid">
  4083. <summary>
  4084. Whether the object is valid.
  4085. </summary>
  4086. <returns>Returns true if valid, otherwise false.</returns>
  4087. </member>
  4088. <member name="M:ComPDFKit.PDFPage.CPDFTextPage.Release">
  4089. <summary>
  4090. Releases resource of the object.
  4091. </summary>
  4092. </member>
  4093. <member name="M:ComPDFKit.PDFPage.CPDFTextPage.GetCharsRectAtPos(System.Windows.Point,System.Windows.Point,System.Windows.Point)">
  4094. <summary>
  4095. Gets a range representing text in specified area.
  4096. </summary>
  4097. <param name="startPoint">Start point coordinate</param>
  4098. <param name="endPoint">End point coordinate</param>
  4099. <param name="tolerance">Tolerance range</param>
  4100. <returns>Rectangle list</returns>
  4101. </member>
  4102. <member name="M:ComPDFKit.PDFPage.CPDFTextPage.GetSelectText(System.Windows.Point,System.Windows.Point)">
  4103. <summary>
  4104. Gets the text enclosed within the specified range.
  4105. </summary>
  4106. <param name="startPoint">Start point coordinate</param>
  4107. <param name="endPoint">End point coordinate</param>
  4108. <returns>Text</returns>
  4109. </member>
  4110. <member name="M:ComPDFKit.PDFPage.CPDFTextPage.GetCharIndexAtPos(System.Windows.Point,System.Windows.Point)">
  4111. <summary>
  4112. Gets index of the character at or nearby a certain position on the page.
  4113. </summary>
  4114. <param name="point">Coordinate</param>
  4115. <param name="tolerance">Tolerance</param>
  4116. <returns>Text index</returns>
  4117. </member>
  4118. <member name="M:ComPDFKit.PDFPage.CPDFTextPage.GetSelectionForWordAtPos(System.Windows.Point,System.Windows.Point,System.Windows.Rect@)">
  4119. <summary>
  4120. Given a point in page-space, gets a selection representing a whole word at that point.
  4121. </summary>
  4122. <param name="point">Coordinate</param>
  4123. <param name="tolerance">Tolerance range</param>
  4124. <param name="wordRect">Corresponding rectangle of the word</param>
  4125. <returns>Word string</returns>
  4126. </member>
  4127. <member name="T:ComPDFKit.PDFPage.C_Search_Options">
  4128. <summary>
  4129. Enumeration value of text search option.
  4130. </summary>
  4131. </member>
  4132. <member name="F:ComPDFKit.PDFPage.C_Search_Options.Search_Case_Insensitive">
  4133. <summary>
  4134. Case insensitive
  4135. </summary>
  4136. </member>
  4137. <member name="F:ComPDFKit.PDFPage.C_Search_Options.Search_Case_Sensitive">
  4138. <summary>
  4139. Case sensitive
  4140. </summary>
  4141. </member>
  4142. <member name="F:ComPDFKit.PDFPage.C_Search_Options.Search_Match_Whole_Word">
  4143. <summary>
  4144. Match whole word
  4145. </summary>
  4146. </member>
  4147. <member name="F:ComPDFKit.PDFPage.C_Search_Options.Search_Consecutive">
  4148. <summary>
  4149. not in use currently
  4150. </summary>
  4151. </member>
  4152. <member name="T:ComPDFKit.PDFPage.CPDFTextSearcher">
  4153. <summary>
  4154. This class is about text search.
  4155. </summary>
  4156. </member>
  4157. <member name="M:ComPDFKit.PDFPage.CPDFTextSearcher.#ctor">
  4158. <summary>
  4159. Constructor function.
  4160. </summary>
  4161. </member>
  4162. <member name="M:ComPDFKit.PDFPage.CPDFTextSearcher.IsValid">
  4163. <summary>
  4164. Whether the object is valid.
  4165. </summary>
  4166. <returns>Valid returns true, otherwise false</returns>
  4167. </member>
  4168. <member name="M:ComPDFKit.PDFPage.CPDFTextSearcher.FindStart(ComPDFKit.PDFPage.CPDFTextPage,System.String,ComPDFKit.PDFPage.C_Search_Options,System.Int32)">
  4169. <summary>
  4170. Starts searching text.
  4171. </summary>
  4172. <param name="textPage">Text page object, more:<see cref="T:ComPDFKit.PDFPage.CPDFTextPage"/></param>
  4173. <param name="keyword">Keyword</param>
  4174. <param name="searchOption">Search option, more:<see cref="T:ComPDFKit.PDFPage.C_Search_Options"/></param>
  4175. <param name="startIndex">Searches keyword from the specified index on the page.</param>
  4176. <returns>Returns true on success, false on failure</returns>
  4177. </member>
  4178. <member name="M:ComPDFKit.PDFPage.CPDFTextSearcher.FindNext(ComPDFKit.PDFPage.CPDFPage,ComPDFKit.PDFPage.CPDFTextPage,ComPDFKit.Import.CRect@,System.String@,System.Int32@)">
  4179. <summary>
  4180. Search for next matched pattern.
  4181. </summary>
  4182. <param name="page">Page object, more:<see cref="T:ComPDFKit.PDFPage.CPDFPage"/></param>
  4183. <param name="textPage">Text page object, more:<see cref="T:ComPDFKit.PDFPage.CPDFTextPage"/></param>
  4184. <param name="rect">Text rectangle</param>
  4185. <param name="content">Content</param>
  4186. <param name="startIndex">Start page index</param>
  4187. <returns>Returns true on success, false on failure.</returns>
  4188. </member>
  4189. <member name="M:ComPDFKit.PDFPage.CPDFTextSearcher.FindClose">
  4190. <summary>
  4191. Stops searching.
  4192. </summary>
  4193. </member>
  4194. <member name="T:ComPDFKit.PDFPage.Edit.CPDFEditArea">
  4195. <summary>
  4196. The base class is about editing area.
  4197. </summary>
  4198. </member>
  4199. <member name="P:ComPDFKit.PDFPage.Edit.CPDFEditArea.Type">
  4200. <summary>
  4201. Editing type.
  4202. </summary>
  4203. </member>
  4204. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditArea.IsValid">
  4205. <summary>
  4206. Whether the object is valid.
  4207. </summary>
  4208. <returns>Returns true if valid, otherwise false.</returns>
  4209. </member>
  4210. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditArea.GetFrame">
  4211. <summary>
  4212. Gets rectangle of editing area on the page.
  4213. </summary>
  4214. <returns>Rectangle on the page.</returns>
  4215. </member>
  4216. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditArea.SetFrame(System.Windows.Rect)">
  4217. <summary>
  4218. Sets rectangle of editing area on the page.
  4219. </summary>
  4220. <param name="frame">Rectangle on the page.</param>
  4221. <returns>Returns true on success, false on failure.</returns>
  4222. </member>
  4223. <member name="T:ComPDFKit.PDFPage.Edit.CPDFEditImageArea">
  4224. <summary>
  4225. This class is about image editing.
  4226. </summary>
  4227. </member>
  4228. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditImageArea.GetRotation">
  4229. <summary>
  4230. Gets the rotation angle of image.
  4231. </summary>
  4232. <returns>Rotation angle, range -180 - 180.</returns>
  4233. </member>
  4234. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditImageArea.Rotate(System.Single)">
  4235. <summary>
  4236. Rotates the image.
  4237. </summary>
  4238. <param name="angle">Rotation angle,range -180 - 180.</param>
  4239. <returns>Returns true on success, false on failure.</returns>
  4240. </member>
  4241. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditImageArea.HorizontalMirror">
  4242. <summary>
  4243. Mirrors the image horizontally.
  4244. </summary>
  4245. <returns>Returns true on success, false on failure.</returns>
  4246. </member>
  4247. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditImageArea.VerticalMirror">
  4248. <summary>
  4249. Mirrors the image vertically.
  4250. </summary>
  4251. <returns>Returns true on success, false on failure.</returns>
  4252. </member>
  4253. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditImageArea.CutWithRect(System.Windows.Rect)">
  4254. <summary>
  4255. Crops the image with rectangle.
  4256. </summary>
  4257. <param name="rect">Rectangle on the image.</param>
  4258. <returns>Returns true on success, false on failure.</returns>
  4259. </member>
  4260. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditImageArea.GetClipRect">
  4261. <summary>
  4262. Gets the clipping rectangle.
  4263. </summary>
  4264. <returns>Rectangle on the image.</returns>
  4265. </member>
  4266. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditImageArea.GetBitmapImage">
  4267. <summary>
  4268. Gets the bitmap of image.
  4269. </summary>
  4270. <returns>The bitmap of image.</returns>
  4271. </member>
  4272. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditImageArea.ExtractImage(System.String)">
  4273. <summary>
  4274. Extracts the image to the specified file path.
  4275. </summary>
  4276. <param name="filePath">The specified file path.</param>
  4277. <returns>Returns true on success, false on failure.</returns>
  4278. </member>
  4279. <member name="T:ComPDFKit.PDFPage.Edit.TextAlignType">
  4280. <summary>
  4281. Text alignment.
  4282. </summary>
  4283. </member>
  4284. <member name="F:ComPDFKit.PDFPage.Edit.TextAlignType.AlignNone">
  4285. <summary>
  4286. None.
  4287. </summary>
  4288. </member>
  4289. <member name="F:ComPDFKit.PDFPage.Edit.TextAlignType.AlignLeft">
  4290. <summary>
  4291. Left alignment.
  4292. </summary>
  4293. </member>
  4294. <member name="F:ComPDFKit.PDFPage.Edit.TextAlignType.AlignRight">
  4295. <summary>
  4296. Right alignment.
  4297. </summary>
  4298. </member>
  4299. <member name="F:ComPDFKit.PDFPage.Edit.TextAlignType.AlignJustify">
  4300. <summary>
  4301. Justify alignment.
  4302. </summary>
  4303. </member>
  4304. <member name="F:ComPDFKit.PDFPage.Edit.TextAlignType.AlignMiddle">
  4305. <summary>
  4306. Middle alignment.
  4307. </summary>
  4308. </member>
  4309. <member name="T:ComPDFKit.PDFPage.Edit.CPDFEditTextArea">
  4310. <summary>
  4311. This class is about text editing.
  4312. </summary>
  4313. </member>
  4314. <member name="P:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.SelectLineRects">
  4315. <summary>
  4316. Gets a list of the area of selected lines on the page.
  4317. </summary>
  4318. </member>
  4319. <member name="P:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.SelectText">
  4320. <summary>
  4321. Gets the selected text content.
  4322. </summary>
  4323. </member>
  4324. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.GetPrevCharPlace">
  4325. <summary>
  4326. Gets the position of text cursor when pressing Prev.
  4327. </summary>
  4328. <returns>Position of text cursor.</returns>
  4329. </member>
  4330. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.GetNextCharPlace">
  4331. <summary>
  4332. Gets the position of text cursor when pressing Next.
  4333. </summary>
  4334. <returns>Position of text cursor.</returns>
  4335. </member>
  4336. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.GetUpCharPlace">
  4337. <summary>
  4338. Gets the position of text cursor when pressing Up.
  4339. </summary>
  4340. <returns>Position of text cursor.</returns>
  4341. </member>
  4342. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.GetDownCharPlace">
  4343. <summary>
  4344. Gets the position of text cursor when pressing Down.
  4345. </summary>
  4346. <returns>Position of text cursor.</returns>
  4347. </member>
  4348. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.SelectCharItemAtPos(System.Windows.Point)">
  4349. <summary>
  4350. Gets the position of text cursor in specified position.
  4351. </summary>
  4352. <param name="point">Cursor in specified position.</param>
  4353. <returns>Position of text cursor.</returns>
  4354. </member>
  4355. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.GetSelectChars(System.Windows.Point,System.Windows.Point)">
  4356. <summary>
  4357. Gets the page area of each selected line in specified area.
  4358. </summary>
  4359. <param name="startPoint">Start point.</param>
  4360. <param name="endPoint">End point.</param>
  4361. </member>
  4362. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.GetLastSelectChars">
  4363. <summary>
  4364. Gets the last selected text content.
  4365. </summary>
  4366. </member>
  4367. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.SelectAllChars">
  4368. <summary>
  4369. Selects all text in the text block.
  4370. </summary>
  4371. </member>
  4372. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.ClearSelectChars">
  4373. <summary>
  4374. Clears the selected text.
  4375. </summary>
  4376. </member>
  4377. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.BackSpaceChar">
  4378. <summary>
  4379. Deletes character behind the text cursor and returns position of text cursor.
  4380. </summary>
  4381. <returns>Position of text cursor.</returns>
  4382. </member>
  4383. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.DeleteChar">
  4384. <summary>
  4385. Deletes character before the text cursor and returns position of text cursor.
  4386. </summary>
  4387. <returns>Position of text cursor.</returns>
  4388. </member>
  4389. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.DeleteChars">
  4390. <summary>
  4391. Deletes all selected text in page area and returns position of text cursor.
  4392. </summary>
  4393. <returns>Position of text cursor.</returns>
  4394. </member>
  4395. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.SetCharsFontSize(System.Single)">
  4396. <summary>
  4397. Sets the font size of selected text.
  4398. </summary>
  4399. <param name="fontSize">Font size.</param>
  4400. </member>
  4401. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.SetCharsFontColor(System.Byte,System.Byte,System.Byte)">
  4402. <summary>
  4403. Sets the font color of selected text.
  4404. </summary>
  4405. <param name="r">Red.</param>
  4406. <param name="g">Green.</param>
  4407. <param name="b">Blue.</param>
  4408. </member>
  4409. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.InsertText(System.String)">
  4410. <summary>
  4411. Inserts new text content behind the text cursor and returns position of text cursor.
  4412. </summary>
  4413. <param name="text">Text content that needs to be inserted.</param>
  4414. <returns>Position of text cursor.</returns>
  4415. </member>
  4416. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.GetRectForWordAtPos(System.Windows.Point)">
  4417. <summary>
  4418. Gets the page area of the word in specified position.
  4419. </summary>
  4420. <param name="point">Specified position.</param>
  4421. <returns>Page area of the word.</returns>
  4422. </member>
  4423. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.GetRectForLineAtPos(System.Windows.Point)">
  4424. <summary>
  4425. Gets the page area of the whole line in specified position.
  4426. </summary>
  4427. <param name="point">Specified position</param>
  4428. <returns>Page area of the whole line.</returns>
  4429. </member>
  4430. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.GetSectionAtPos(System.Windows.Point)">
  4431. <summary>
  4432. Gets the text content of the current paragraph based on coordinates.
  4433. </summary>
  4434. <param name="point">The specified coordinates.</param>
  4435. <returns>Returns true on success, false on failure.</returns>
  4436. </member>
  4437. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.GetTextStyle(System.Single@,System.Byte[]@)">
  4438. <summary>
  4439. Get the text style of the current position of text cursor.
  4440. </summary>
  4441. <param name="fontSize">Font size.</param>
  4442. <param name="fontColor">Font color.</param>
  4443. </member>
  4444. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.GetTextCursorPoints(System.Windows.Point@,System.Windows.Point@)">
  4445. <summary>
  4446. Gets the coordinates of the top and bottom of the text cursor.
  4447. </summary>
  4448. <param name="lowPoint">The coordinates of the bottom of the text cursor.</param>
  4449. <param name="highPoint">The coordinates of the top of the text cursor.</param>
  4450. <returns>Returns true on success, false on failure</returns>
  4451. </member>
  4452. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.SetTextAreaAlign(ComPDFKit.PDFPage.Edit.TextAlignType)">
  4453. <summary>
  4454. Sets the alignment of text in a text area.
  4455. </summary>
  4456. <param name="alignType">The alignment of text.</param>
  4457. <returns>Returns true on success, false on failure.</returns>
  4458. </member>
  4459. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.SetTextSectionAlign(ComPDFKit.PDFPage.Edit.TextAlignType)">
  4460. <summary>
  4461. Sets the text alignment of the current paragraph.
  4462. </summary>
  4463. <param name="alignType">The text alignment.</param>
  4464. <returns>Returns true on success, false on failure.</returns>
  4465. </member>
  4466. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.SetTextRangeAlign(ComPDFKit.PDFPage.Edit.TextAlignType)">
  4467. <summary>
  4468. Sets the text alignment of selected text.
  4469. </summary>
  4470. <param name="alignType">The text alignment.</param>
  4471. <returns>Returns true on success, false on failure.</returns>
  4472. </member>
  4473. <member name="M:ComPDFKit.PDFPage.Edit.CPDFEditTextArea.GetTextSectionAlign">
  4474. <summary>
  4475. Gets the text alignment of the current paragraph.
  4476. </summary>
  4477. <returns>The text alignment.</returns>
  4478. </member>
  4479. <member name="T:ComPDFKit.PDFWatermark.CPDFImageWatermark">
  4480. <summary>
  4481. Image watermark.
  4482. </summary>
  4483. </member>
  4484. <member name="T:ComPDFKit.PDFWatermark.CPDFTextWatermark">
  4485. <summary>
  4486. Text watermark.
  4487. </summary>
  4488. </member>
  4489. <member name="T:ComPDFKit.PDFWatermark.C_Watermark_Type">
  4490. <summary>
  4491. Watermark type.
  4492. </summary>
  4493. </member>
  4494. <member name="F:ComPDFKit.PDFWatermark.C_Watermark_Type.WATERMARK_TYPE_UNKWON">
  4495. <summary>
  4496. Unknown type
  4497. </summary>
  4498. </member>
  4499. <member name="F:ComPDFKit.PDFWatermark.C_Watermark_Type.WATERMARK_TYPE_TEXT">
  4500. <summary>
  4501. Text watermark
  4502. </summary>
  4503. </member>
  4504. <member name="F:ComPDFKit.PDFWatermark.C_Watermark_Type.WATERMARK_TYPE_IMG">
  4505. <summary>
  4506. Image watermark
  4507. </summary>
  4508. </member>
  4509. <member name="T:ComPDFKit.PDFWatermark.C_Watermark_Vertalign">
  4510. <summary>
  4511. Vertical alignment.
  4512. </summary>
  4513. </member>
  4514. <member name="F:ComPDFKit.PDFWatermark.C_Watermark_Vertalign.WATERMARK_VERTALIGN_UNKOWN">
  4515. <summary>
  4516. Unknown type
  4517. </summary>
  4518. </member>
  4519. <member name="F:ComPDFKit.PDFWatermark.C_Watermark_Vertalign.WATERMARK_VERTALIGN_TOP">
  4520. <summary>
  4521. Align Vertically to the top
  4522. </summary>
  4523. </member>
  4524. <member name="F:ComPDFKit.PDFWatermark.C_Watermark_Vertalign.WATERMARK_VERTALIGN_CENTER">
  4525. <summary>
  4526. Align Vertically centered
  4527. </summary>
  4528. </member>
  4529. <member name="F:ComPDFKit.PDFWatermark.C_Watermark_Vertalign.WATERMARK_VERTALIGN_BOTTOM">
  4530. <summary>
  4531. Align Vertically to the bottom
  4532. </summary>
  4533. </member>
  4534. <member name="T:ComPDFKit.PDFWatermark.C_Watermark_Horizalign">
  4535. <summary>
  4536. Horizontal alignment.
  4537. </summary>
  4538. </member>
  4539. <member name="F:ComPDFKit.PDFWatermark.C_Watermark_Horizalign.WATERMARK_HORIZALIGN_UNKOWN">
  4540. <summary>
  4541. Unknown type
  4542. </summary>
  4543. </member>
  4544. <member name="F:ComPDFKit.PDFWatermark.C_Watermark_Horizalign.WATERMARK_HORIZALIGN_LEFT">
  4545. <summary>
  4546. Align horizontally to left
  4547. </summary>
  4548. </member>
  4549. <member name="F:ComPDFKit.PDFWatermark.C_Watermark_Horizalign.WATERMARK_HORIZALIGN_CENTER">
  4550. <summary>
  4551. Align horizontally centered
  4552. </summary>
  4553. </member>
  4554. <member name="F:ComPDFKit.PDFWatermark.C_Watermark_Horizalign.WATERMARK_HORIZALIGN_RIGHT">
  4555. <summary>
  4556. Align horizontally to right
  4557. </summary>
  4558. </member>
  4559. <member name="T:ComPDFKit.PDFWatermark.CPDFWatermark">
  4560. <summary>
  4561. This class is mainly used to construct a watermark with specified parameters, and then insert it to PDF page.
  4562. The watermark object can be constructed from text, bitmap or image, and PDF page.
  4563. </summary>
  4564. </member>
  4565. <member name="P:ComPDFKit.PDFWatermark.CPDFWatermark.Type">
  4566. <summary>
  4567. Gets watermark type,more:<see cref="T:ComPDFKit.PDFWatermark.C_Watermark_Type"/>
  4568. </summary>
  4569. </member>
  4570. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.IsValid">
  4571. <summary>
  4572. Whether object is valid, false means the object resource is released, you cannot use the object to call any method.
  4573. </summary>
  4574. <returns>Whether object is valid, false means the object resource is released, you cannot use the object to call any method.</returns>
  4575. </member>
  4576. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetScale(System.Single)">
  4577. <summary>
  4578. Sets zoom level.
  4579. </summary>
  4580. <param name="scale">Zoom level.</param>
  4581. <returns>Returns whether to successfully set zoom level.</returns>
  4582. </member>
  4583. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetRotation(System.Single)">
  4584. <summary>
  4585. Sets rotation angle.
  4586. </summary>
  4587. <param name="rotation">Rotation angle.</param>
  4588. <returns>Returns whether to successfully set rotation angle.</returns>
  4589. </member>
  4590. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetOpacity(System.Byte)">
  4591. <summary>
  4592. Sets opacity.
  4593. </summary>
  4594. <param name="opacity">Opacity.</param>
  4595. <returns>Returns whether to successfully set opacity.</returns>
  4596. </member>
  4597. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetVertalign(ComPDFKit.PDFWatermark.C_Watermark_Vertalign)">
  4598. <summary>
  4599. Sets vertical alignment,more:<see cref="T:ComPDFKit.PDFWatermark.C_Watermark_Vertalign"/>
  4600. </summary>
  4601. <param name="vertalign">Vertical alignment.</param>
  4602. <returns>Returns whether to successfully set vertical alignment.</returns>
  4603. </member>
  4604. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetHorizalign(ComPDFKit.PDFWatermark.C_Watermark_Horizalign)">
  4605. <summary>
  4606. Sets horizontal alignment,more:<see cref="T:ComPDFKit.PDFWatermark.C_Watermark_Horizalign"/>
  4607. </summary>
  4608. <param name="horizalign">Horizontal alignment.</param>
  4609. <returns>Returns whether to successfully set horizontal alignment.</returns>
  4610. </member>
  4611. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetVertOffset(System.Single)">
  4612. <summary>
  4613. Sets vertical deviation.
  4614. </summary>
  4615. <param name="vertOffset">Vertical deviation.</param>
  4616. <returns>Returns whether to successfully set vertical deviation.</returns>
  4617. </member>
  4618. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetHorizOffset(System.Single)">
  4619. <summary>
  4620. Sets horizontal deviation.
  4621. </summary>
  4622. <param name="horizOffset">Horizontal deviation.</param>
  4623. <returns>Returns whether to successfully set horizontal deviation.</returns>
  4624. </member>
  4625. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetPages(System.String)">
  4626. <summary>
  4627. Sets page range of watermark. Page range, such as:1,2,3 or 1-3
  4628. </summary>
  4629. <param name="pages">Page range,such as:1,2,3 or 1-3</param>
  4630. <returns>Returns whether to successfully set page range of watermark.</returns>
  4631. </member>
  4632. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetFront(System.Boolean)">
  4633. <summary>
  4634. Sets watermark layer. True means watermark is in front of text, false means behind text.
  4635. </summary>
  4636. <param name="isFront">Whether it is in front of text.</param>
  4637. <returns>Returns whether to successfully set watermark layer.</returns>
  4638. </member>
  4639. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetFullScreen(System.Boolean)">
  4640. <summary>
  4641. Sets tiled watermark.
  4642. </summary>
  4643. <param name="isFullScreen">Whether it is tiled watermark.</param>
  4644. <returns>Returns whether to successfully set tiled watermark.</returns>
  4645. </member>
  4646. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetHorizontalSpacing(System.Single)">
  4647. <summary>
  4648. Sets the horizontal spacing for the tiled watermark.
  4649. </summary>
  4650. <param name="horizontalSpacing">Horizontal spacing for the tiled watermark.</param>
  4651. <returns>Returns whether to successfully set the horizontal spacing for the tiled watermark.</returns>
  4652. </member>
  4653. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetVerticalSpacing(System.Single)">
  4654. <summary>
  4655. Sets vertical spacing for the tiled watermark.
  4656. </summary>
  4657. <param name="verticalSpacing">Vertical spacing for the tiled watermark.</param>
  4658. <returns>Returns whether to successfully set vertical spacing for the tiled watermark.</returns>
  4659. </member>
  4660. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetText(System.String)">
  4661. <summary>
  4662. Sets content of text watermark.
  4663. </summary>
  4664. <param name="text">Content of text watermark.</param>
  4665. <returns>Returns whether to successfully se content of text watermark.</returns>
  4666. </member>
  4667. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetFontName(System.String)">
  4668. <summary>
  4669. Sets font of text watermark.
  4670. </summary>
  4671. <param name="fontName">Font of text watermark.</param>
  4672. <returns>Returns whether to successfully set font of text watermark.</returns>
  4673. </member>
  4674. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetFontSize(System.Single)">
  4675. <summary>
  4676. Sets font size of text watermark.
  4677. </summary>
  4678. <param name="fontSize">Font size of text watermark</param>
  4679. <returns>Returns whether to successfully set font size of text watermark.</returns>
  4680. </member>
  4681. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetTextRGBColor(System.Byte[])">
  4682. <summary>
  4683. Sets font color of text watermark.
  4684. </summary>
  4685. <param name="color">Font color of text watermark.</param>
  4686. <returns>Returns whether to successfully set font color of text watermark.</returns>
  4687. </member>
  4688. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.SetImage(System.Byte[],System.Int32,System.Int32)">
  4689. <summary>
  4690. Sets image watermark with Bitmap by pixel.
  4691. </summary>
  4692. <param name="imageData">Image resource.</param>
  4693. <param name="imageWidth">Image width.</param>
  4694. <param name="imageHeight">Image height.</param>
  4695. <returns>Whether to successfully set image watermark with Bitmap by pixel.</returns>
  4696. </member>
  4697. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.CreateWatermark">
  4698. <summary>
  4699. Creates watermark.
  4700. </summary>
  4701. <returns>Whether to successfully create watermark.</returns>
  4702. </member>
  4703. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.ClearWatermark">
  4704. <summary>
  4705. Removes watermark.
  4706. </summary>
  4707. <returns>Whether to successfully remove watermark.</returns>
  4708. </member>
  4709. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.UpdateWatermark">
  4710. <summary>
  4711. Updates watermark.
  4712. </summary>
  4713. <returns>Whether to successfully update watermark.</returns>
  4714. </member>
  4715. <member name="M:ComPDFKit.PDFWatermark.CPDFWatermark.Release">
  4716. <summary>
  4717. Releases Watermark object resource.
  4718. </summary>
  4719. </member>
  4720. </members>
  4721. </doc>