Bez popisu
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

NPOI.OpenXml4Net.xml 160KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NPOI.OpenXml4Net</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NPOI.OpenXml4Net.OPC.CertificateEmbeddingOption">
  8. Specifies the location where the X.509 certificate that is used in signing is stored.
  9. @author Julien Chable
  10. </member>
  11. <member name="F:NPOI.OpenXml4Net.OPC.CertificateEmbeddingOption.IN_CERTIFICATE_PART">
  12. The certificate is embedded in its own PackagePart.
  13. </member>
  14. <member name="F:NPOI.OpenXml4Net.OPC.CertificateEmbeddingOption.IN_SIGNATURE_PART">
  15. The certificate is embedded in the SignaturePart that is created for the signature being added.
  16. </member>
  17. <member name="F:NPOI.OpenXml4Net.OPC.CertificateEmbeddingOption.NOT_EMBEDDED">
  18. The certificate in not embedded in the package.
  19. </member>
  20. <member name="T:NPOI.OpenXml4Net.OPC.ContentTypes">
  21. Open Packaging Convention content types (see Annex F : Standard Namespaces
  22. and Content Types).
  23. @author CDubettier define some constants, Julien Chable
  24. </member>
  25. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.CORE_PROPERTIES_PART">
  26. Core Properties part.
  27. </member>
  28. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.DIGITAL_SIGNATURE_CERTIFICATE_PART">
  29. Digital Signature Certificate part.
  30. </member>
  31. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.DIGITAL_SIGNATURE_ORIGIN_PART">
  32. Digital Signature Origin part.
  33. </member>
  34. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.DIGITAL_SIGNATURE_XML_SIGNATURE_PART">
  35. Digital Signature XML Signature part.
  36. </member>
  37. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.RELATIONSHIPS_PART">
  38. Relationships part.
  39. </member>
  40. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.CUSTOM_XML_PART">
  41. Custom XML part.
  42. </member>
  43. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.PLAIN_OLD_XML">
  44. Plain old xml. Note - OOXML uses application/xml, and not text/xml!
  45. </member>
  46. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.IMAGE_TIFF">
  47. TIFF image format.
  48. @see <a href="http://partners.adobe.com/public/developer/tiff/index.html#spec">
  49. http://partners.adobe.com/public/developer/tiff/index.html#spec</a>
  50. </member>
  51. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.IMAGE_PICT">
  52. Pict image format.
  53. @see <a href="http://developer.apple.com/documentation/mac/QuickDraw/QuickDraw-2.html">
  54. http://developer.apple.com/documentation/mac/QuickDraw/QuickDraw-2.html</a>
  55. </member>
  56. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.XML">
  57. XML file.
  58. </member>
  59. <member name="T:NPOI.OpenXml4Net.OPC.EncryptionOption">
  60. Specifies the encryption option for parts in a Package.
  61. @author Julien Chable
  62. @version 0.1
  63. </member>
  64. <member name="F:NPOI.OpenXml4Net.OPC.EncryptionOption.NONE">
  65. No encryption.
  66. </member>
  67. <!-- Badly formed XML comment ignored for member "T:NPOI.OpenXml4Net.OPC.Internal.ContentType" -->
  68. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentType.type">
  69. Type in Type/Subtype.
  70. </member>
  71. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentType.subType">
  72. Subtype
  73. </member>
  74. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentType.parameters">
  75. Parameters
  76. </member>
  77. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentType.patternTypeSubType">
  78. Media type compiled pattern for parameters.
  79. </member>
  80. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentType.patternTypeSubTypeParams">
  81. Media type compiled pattern, with parameters.
  82. </member>
  83. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentType.patternParams">
  84. Pattern to match on just the parameters part, to work
  85. around the Java Regexp group capture behaviour
  86. </member>
  87. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentType.#ctor(System.String)">
  88. Constructor. Check the input with the RFC 2616 grammar.
  89. @param contentType
  90. The content type to store.
  91. @throws InvalidFormatException
  92. If the specified content type is not valid with RFC 2616.
  93. </member>
  94. <member name="P:NPOI.OpenXml4Net.OPC.Internal.ContentType.SubType">
  95. Get the subtype.
  96. @return The subtype of this content type.
  97. </member>
  98. <member name="P:NPOI.OpenXml4Net.OPC.Internal.ContentType.Type">
  99. Get the type.
  100. @return The type of this content type.
  101. </member>
  102. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentType.HasParameters">
  103. Does this content type have any parameters associated with it?
  104. </member>
  105. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentType.GetParameterKeys">
  106. Return the parameter keys
  107. </member>
  108. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentType.GetParameter(System.String)">
  109. Gets the value associated to the specified key.
  110. @param key
  111. The key of the key/value pair.
  112. @return The value associated to the specified key.
  113. </member>
  114. <member name="T:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager">
  115. Manage package content types ([Content_Types].xml part).
  116. @author Julien Chable
  117. @version 1.0
  118. </member>
  119. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.CONTENT_TYPES_PART_NAME">
  120. Content type part name.
  121. </member>
  122. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.TYPES_NAMESPACE_URI">
  123. Content type namespace
  124. </member>
  125. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.container">
  126. Reference to the package using this content type manager.
  127. </member>
  128. <!-- Badly formed XML comment ignored for member "F:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.defaultContentType" -->
  129. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.overrideContentType">
  130. Override content type tree.
  131. </member>
  132. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.#ctor(System.IO.Stream,NPOI.OpenXml4Net.OPC.OPCPackage)">
  133. Constructor. Parses the content of the specified input stream.
  134. @param in
  135. If different of <i>null</i> then the content types part is
  136. retrieve and parse.
  137. @throws InvalidFormatException
  138. If the content types part content is not valid.
  139. </member>
  140. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.AddContentType(NPOI.OpenXml4Net.OPC.PackagePartName,System.String)">
  141. Build association extention-> content type (will be stored in
  142. [Content_Types].xml) for example ContentType="image/png" Extension="png"
  143. <p>
  144. [M2.8]: When adding a new part to a package, the package implementer
  145. shall ensure that a content type for that part is specified in the
  146. Content Types stream; the package implementer shall perform the steps
  147. described in &#167;9.1.2.3:
  148. </p><p>
  149. 1. Get the extension from the part name by taking the substring to the
  150. right of the rightmost occurrence of the dot character (.) from the
  151. rightmost segment.
  152. </p><p>
  153. 2. If a part name has no extension, a corresponding Override element
  154. shall be added to the Content Types stream.
  155. </p><p>
  156. 3. Compare the resulting extension with the values specified for the
  157. Extension attributes of the Default elements in the Content Types stream.
  158. The comparison shall be case-insensitive ASCII.
  159. </p><p>
  160. 4. If there is a Default element with a matching Extension attribute,
  161. then the content type of the new part shall be compared with the value of
  162. the ContentType attribute. The comparison might be case-sensitive and
  163. include every character regardless of the role it plays in the
  164. content-type grammar of RFC 2616, or it might follow the grammar of RFC
  165. 2616.
  166. </p><p>
  167. a. If the content types match, no further action is required.
  168. </p><p>
  169. b. If the content types do not match, a new Override element shall be
  170. added to the Content Types stream. .
  171. </p><p>
  172. 5. If there is no Default element with a matching Extension attribute, a
  173. new Default element or Override element shall be added to the Content
  174. Types stream.
  175. </p>
  176. </member>
  177. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.AddOverrideContentType(NPOI.OpenXml4Net.OPC.PackagePartName,System.String)">
  178. Add an override content type for a specific part.
  179. @param partName
  180. Name of the part.
  181. @param contentType
  182. Content type of the part.
  183. </member>
  184. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.AddDefaultContentType(System.String,System.String)">
  185. Add a content type associated with the specified extension.
  186. @param extension
  187. The part name extension to bind to a content type.
  188. @param contentType
  189. The content type associated with the specified extension.
  190. </member>
  191. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.RemoveContentType(NPOI.OpenXml4Net.OPC.PackagePartName)">
  192. <p>
  193. Delete a content type based on the specified part name. If the specified
  194. part name is register with an override content type, then this content
  195. type is remove, else the content type is remove in the default content
  196. type list if it exists and if no part is associated with it yet.
  197. </p><p>
  198. Check rule M2.4: The package implementer shall require that the Content
  199. Types stream contain one of the following for every part in the package:
  200. One matching Default element One matching Override element Both a
  201. matching Default element and a matching Override element, in which case
  202. the Override element takes precedence.
  203. </p>
  204. @param partName
  205. The part URI associated with the override content type to
  206. delete.
  207. @exception InvalidOperationException
  208. Throws if
  209. </member>
  210. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.IsContentTypeRegister(System.String)">
  211. Check if the specified content type is already register.
  212. @param contentType
  213. The content type to check.
  214. @return <code>true</code> if the specified content type is already
  215. register, then <code>false</code>.
  216. </member>
  217. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.GetContentType(NPOI.OpenXml4Net.OPC.PackagePartName)">
  218. Get the content type for the specified part, if any.
  219. <p>
  220. Rule [M2.9]: To get the content type of a part, the package implementer
  221. shall perform the steps described in &#167;9.1.2.4:
  222. </p><p>
  223. 1. Compare the part name with the values specified for the PartName
  224. attribute of the Override elements. The comparison shall be
  225. case-insensitive ASCII.
  226. </p><p>
  227. 2. If there is an Override element with a matching PartName attribute,
  228. return the value of its ContentType attribute. No further action is
  229. required.
  230. </p><p>
  231. 3. If there is no Override element with a matching PartName attribute,
  232. then a. Get the extension from the part name by taking the substring to
  233. the right of the rightmost occurrence of the dot character (.) from the
  234. rightmost segment. b. Check the Default elements of the Content Types
  235. stream, comparing the extension with the value of the Extension
  236. attribute. The comparison shall be case-insensitive ASCII.
  237. </p><p>
  238. 4. If there is a Default element with a matching Extension attribute,
  239. return the value of its ContentType attribute. No further action is
  240. required.
  241. </p><p>
  242. 5. If neither Override nor Default elements with matching attributes are
  243. found for the specified part name, the implementation shall not map this
  244. part name to a part.
  245. </p>
  246. @param partName
  247. The URI part to check.
  248. @return The content type associated with the URI (in case of an override
  249. content type) or the extension (in case of default content type),
  250. else <code>null</code>.
  251. @exception OpenXml4NetRuntimeException
  252. Throws if the content type manager is not able to find the
  253. content from an existing part.
  254. </member>
  255. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.ClearAll">
  256. Clear all content types.
  257. </member>
  258. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.ClearOverrideContentTypes">
  259. Clear all override content types.
  260. </member>
  261. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.ParseContentTypesFile(System.IO.Stream)">
  262. Parse the content types part.
  263. @throws InvalidFormatException
  264. Throws if the content type doesn't exist or the XML format is
  265. invalid.
  266. </member>
  267. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.Save(System.IO.Stream)">
  268. Save the contents type part.
  269. @param outStream
  270. The output stream use to save the XML content of the content
  271. types part.
  272. @return <b>true</b> if the operation success, else <b>false</b>.
  273. </member>
  274. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.AppendSpecificTypes(System.Xml.XmlDocument,System.Xml.XmlElement,System.Collections.Generic.KeyValuePair{NPOI.OpenXml4Net.OPC.PackagePartName,System.String})">
  275. Use to Append specific type XML elements, use by the save() method.
  276. @param root
  277. XML parent element use to Append this override type element.
  278. @param entry
  279. The values to Append.
  280. @see #save(java.io.OutputStream)
  281. </member>
  282. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.AppendDefaultType(System.Xml.XmlDocument,System.Xml.XmlElement,System.Collections.Generic.KeyValuePair{System.String,System.String})">
  283. Use to Append default types XML elements, use by the save() metid.
  284. @param root
  285. XML parent element use to Append this default type element.
  286. @param entry
  287. The values to Append.
  288. @see #save(java.io.OutputStream)
  289. </member>
  290. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.SaveImpl(System.Xml.XmlDocument,System.IO.Stream)">
  291. Specific implementation of the save method. Call by the save() method,
  292. call before exiting.
  293. @param out
  294. The output stream use to write the content type XML.
  295. </member>
  296. <member name="T:NPOI.OpenXml4Net.OPC.Internal.FileHelper">
  297. Provide useful method to manage file.
  298. @author Julien Chable
  299. @version 0.1
  300. </member>
  301. <member name="M:NPOI.OpenXml4Net.OPC.Internal.FileHelper.GetDirectory(System.String)">
  302. Get the directory part of the specified file path.
  303. @param f
  304. File to process.
  305. @return The directory path from the specified
  306. </member>
  307. <member name="M:NPOI.OpenXml4Net.OPC.Internal.FileHelper.CopyFile(System.String,System.String)">
  308. Copy a file.
  309. @param in
  310. The source file.
  311. @param out
  312. The target location.
  313. @throws IOException
  314. If an I/O error occur.
  315. </member>
  316. <member name="M:NPOI.OpenXml4Net.OPC.Internal.FileHelper.GetFilename(System.String)">
  317. Get file name from the specified File object.
  318. </member>
  319. <member name="T:NPOI.OpenXml4Net.OPC.Internal.Marshallers.DefaultMarshaller">
  320. Default marshaller that specified that the part is responsible to marshall its content.
  321. @author Julien Chable
  322. @version 1.0
  323. @see PartMarshaller
  324. </member>
  325. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.DefaultMarshaller.Marshall(NPOI.OpenXml4Net.OPC.PackagePart,System.IO.Stream)">
  326. Save part in the output stream by using the save() method of the part.
  327. @throws OpenXml4NetException
  328. If any error occur.
  329. </member>
  330. <member name="T:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller">
  331. Package properties marshaller.
  332. @author CDubet, Julien Chable
  333. </member>
  334. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.Marshall(NPOI.OpenXml4Net.OPC.PackagePart,System.IO.Stream)">
  335. Marshall package core properties to an XML document. Always return
  336. <code>true</code>.
  337. </member>
  338. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddCategory">
  339. Add category property element if needed.
  340. </member>
  341. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddContentStatus">
  342. Add content status property element if needed.
  343. </member>
  344. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddContentType">
  345. Add content type property element if needed.
  346. </member>
  347. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddCreated">
  348. Add created property element if needed.
  349. </member>
  350. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddCreator">
  351. Add creator property element if needed.
  352. </member>
  353. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddDescription">
  354. Add description property element if needed.
  355. </member>
  356. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddIdentifier">
  357. Add identifier property element if needed.
  358. </member>
  359. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddKeywords">
  360. Add keywords property element if needed.
  361. </member>
  362. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddLanguage">
  363. Add language property element if needed.
  364. </member>
  365. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddLastModifiedBy">
  366. Add 'last modified by' property if needed.
  367. </member>
  368. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddLastPrinted">
  369. Add 'last printed' property if needed.
  370. </member>
  371. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddModified">
  372. Add modified property element if needed.
  373. </member>
  374. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddRevision">
  375. Add revision property if needed.
  376. </member>
  377. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddSubject">
  378. Add subject property if needed.
  379. </member>
  380. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddTitle">
  381. Add title property if needed.
  382. </member>
  383. <member name="T:NPOI.OpenXml4Net.OPC.Internal.Marshallers.ZipPackagePropertiesMarshaller">
  384. Package core properties marshaller specialized for zipped package.
  385. @author Julien Chable
  386. </member>
  387. <member name="T:NPOI.OpenXml4Net.OPC.Internal.Marshallers.ZipPartMarshaller">
  388. Zip part marshaller. This marshaller is use to save any part in a zip stream.
  389. @author Julien Chable
  390. </member>
  391. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.ZipPartMarshaller.Marshall(NPOI.OpenXml4Net.OPC.PackagePart,System.IO.Stream)">
  392. Save the specified part.
  393. @throws OpenXml4NetException
  394. Throws if an internal exception is thrown.
  395. </member>
  396. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.ZipPartMarshaller.MarshallRelationshipPart(NPOI.OpenXml4Net.OPC.PackageRelationshipCollection,NPOI.OpenXml4Net.OPC.PackagePartName,ICSharpCode.SharpZipLib.Zip.ZipOutputStream)">
  397. Save relationships into the part.
  398. @param rels
  399. The relationships collection to marshall.
  400. @param relPartName
  401. Part name of the relationship part to marshall.
  402. @param zos
  403. Zip output stream in which to save the XML content of the
  404. relationships serialization.
  405. </member>
  406. <member name="F:NPOI.OpenXml4Net.OPC.Internal.MemoryPackagePart.data">
  407. Storage for the part data.
  408. </member>
  409. <member name="M:NPOI.OpenXml4Net.OPC.Internal.MemoryPackagePart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName,System.String)">
  410. Constructor.
  411. @param pack
  412. The owner package.
  413. @param partName
  414. The part name.
  415. @param contentType
  416. The content type.
  417. @throws InvalidFormatException
  418. If the specified URI is not OPC compliant.
  419. </member>
  420. <member name="M:NPOI.OpenXml4Net.OPC.Internal.MemoryPackagePart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName,System.String,System.Boolean)">
  421. Constructor.
  422. @param pack
  423. The owner package.
  424. @param partName
  425. The part name.
  426. @param contentType
  427. The content type.
  428. @param loadRelationships
  429. Specify if the relationships will be loaded.
  430. @throws InvalidFormatException
  431. If the specified URI is not OPC compliant.
  432. </member>
  433. <member name="M:NPOI.OpenXml4Net.OPC.Internal.MemoryPackagePartOutputStream.Close">
  434. Close this stream and flush the content.
  435. @see #flush()
  436. </member>
  437. <member name="M:NPOI.OpenXml4Net.OPC.Internal.MemoryPackagePartOutputStream.Flush">
  438. Flush this output stream. This method is called by the close() method.
  439. Warning : don't call this method for output consistency.
  440. @see #close()
  441. </member>
  442. <member name="T:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart">
  443. Represents the core properties part of a package.
  444. @author Julien Chable
  445. @version 1.0
  446. </member>
  447. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName)">
  448. Constructor.
  449. @param pack
  450. Container package.
  451. @param partName
  452. Name of this part.
  453. @throws InvalidFormatException
  454. Throws if the content is invalid.
  455. </member>
  456. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.category">
  457. A categorization of the content of this package.
  458. [Example: Example values for this property might include: Resume, Letter,
  459. Financial Forecast, Proposal, Technical Presentation, and so on. This
  460. value might be used by an application's user interface to facilitate
  461. navigation of a large Set of documents. end example]
  462. </member>
  463. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.contentStatus">
  464. The status of the content.
  465. [Example: Values might include "Draft", "Reviewed", and "Final". end
  466. example]
  467. </member>
  468. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.contentType">
  469. The type of content represented, generally defined by a specific use and
  470. intended audience.
  471. [Example: Values might include "Whitepaper", "Security Bulletin", and
  472. "Exam". end example] [Note: This property is distinct from MIME content
  473. types as defined in RFC 2616. end note]
  474. </member>
  475. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.created">
  476. Date of creation of the resource.
  477. </member>
  478. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.creator">
  479. An entity primarily responsible for making the content of the resource.
  480. </member>
  481. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.description">
  482. An explanation of the content of the resource.
  483. [Example: Values might include an abstract, table of contents, reference
  484. to a graphical representation of content, and a free-text account of the
  485. content. end example]
  486. </member>
  487. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.identifier">
  488. An unambiguous reference to the resource within a given context.
  489. </member>
  490. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.keywords">
  491. A delimited Set of keywords to support searching and indexing. This is
  492. typically a list of terms that are not available elsewhere in the
  493. properties.
  494. </member>
  495. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.language">
  496. The language of the intellectual content of the resource.
  497. [Note: IETF RFC 3066 provides guidance on encoding to represent
  498. languages. end note]
  499. </member>
  500. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.lastModifiedBy">
  501. The user who performed the last modification. The identification is
  502. environment-specific.
  503. [Example: A name, email address, or employee ID. end example] It is
  504. recommended that this value be as concise as possible.
  505. </member>
  506. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.lastPrinted">
  507. The date and time of the last printing.
  508. </member>
  509. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.modified">
  510. Date on which the resource was changed.
  511. </member>
  512. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.revision">
  513. The revision number.
  514. [Example: This value might indicate the number of saves or revisions,
  515. provided the application updates it after each revision. end example]
  516. </member>
  517. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.subject">
  518. The topic of the content of the resource.
  519. </member>
  520. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.title">
  521. The name given to the resource.
  522. </member>
  523. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.version">
  524. The version number. This value is Set by the user or by the application.
  525. </member>
  526. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetCategoryProperty">
  527. Get the category property.
  528. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getCategoryProperty()
  529. </member>
  530. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetContentStatusProperty">
  531. Get content status.
  532. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getContentStatusProperty()
  533. </member>
  534. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetContentTypeProperty">
  535. Get content type.
  536. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getContentTypeProperty()
  537. </member>
  538. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetCreatedProperty">
  539. Get created date.
  540. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getCreatedProperty()
  541. </member>
  542. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetCreatedPropertyString">
  543. Get created date formated into a String.
  544. @return A string representation of the created date.
  545. </member>
  546. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetCreatorProperty">
  547. Get creator.
  548. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getCreatorProperty()
  549. </member>
  550. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetDescriptionProperty">
  551. Get description.
  552. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getDescriptionProperty()
  553. </member>
  554. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetIdentifierProperty">
  555. Get identifier.
  556. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getIdentifierProperty()
  557. </member>
  558. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetKeywordsProperty">
  559. Get keywords.
  560. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getKeywordsProperty()
  561. </member>
  562. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetLanguageProperty">
  563. Get the language.
  564. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getLanguageProperty()
  565. </member>
  566. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetLastModifiedByProperty">
  567. Get the author of last modifications.
  568. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getLastModifiedByProperty()
  569. </member>
  570. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetLastPrintedProperty">
  571. Get last printed date.
  572. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getLastPrintedProperty()
  573. </member>
  574. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetLastPrintedPropertyString">
  575. Get last printed date formated into a String.
  576. @return A string representation of the last printed date.
  577. </member>
  578. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetModifiedProperty">
  579. Get modified date.
  580. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getModifiedProperty()
  581. </member>
  582. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetModifiedPropertyString">
  583. Get modified date formated into a String.
  584. @return A string representation of the modified date.
  585. </member>
  586. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetRevisionProperty">
  587. Get revision.
  588. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getRevisionProperty()
  589. </member>
  590. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetSubjectProperty">
  591. Get subject.
  592. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getSubjectProperty()
  593. </member>
  594. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetTitleProperty">
  595. Get title.
  596. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getTitleProperty()
  597. </member>
  598. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetVersionProperty">
  599. Get version.
  600. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getVersionProperty()
  601. </member>
  602. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetCategoryProperty(System.String)">
  603. Set the category.
  604. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setCategoryProperty(java.lang.String)
  605. </member>
  606. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetContentStatusProperty(System.String)">
  607. Set the content status.
  608. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setContentStatusProperty(java.lang.String)
  609. </member>
  610. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetContentTypeProperty(System.String)">
  611. Set the content type.
  612. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setContentTypeProperty(java.lang.String)
  613. </member>
  614. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetCreatedProperty(System.String)">
  615. Set the created date.
  616. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setCreatedProperty(org.apache.poi.OpenXml4Net.util.Nullable)
  617. </member>
  618. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetCreatedProperty(System.Nullable{System.DateTime})">
  619. Set the created date.
  620. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setCreatedProperty(org.apache.poi.OpenXml4Net.util.Nullable)
  621. </member>
  622. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetCreatorProperty(System.String)">
  623. Set the creator.
  624. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setCreatorProperty(java.lang.String)
  625. </member>
  626. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetDescriptionProperty(System.String)">
  627. Set the description.
  628. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setDescriptionProperty(java.lang.String)
  629. </member>
  630. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetIdentifierProperty(System.String)">
  631. Set identifier.
  632. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setIdentifierProperty(java.lang.String)
  633. </member>
  634. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetKeywordsProperty(System.String)">
  635. Set keywords.
  636. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setKeywordsProperty(java.lang.String)
  637. </member>
  638. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetLanguageProperty(System.String)">
  639. Set language.
  640. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setLanguageProperty(java.lang.String)
  641. </member>
  642. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetLastModifiedByProperty(System.String)">
  643. Set last modifications author.
  644. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setLastModifiedByProperty(java.lang.String)
  645. </member>
  646. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetLastPrintedProperty(System.String)">
  647. Set last printed date.
  648. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setLastPrintedProperty(org.apache.poi.OpenXml4Net.util.Nullable)
  649. </member>
  650. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetLastPrintedProperty(System.Nullable{System.DateTime})">
  651. Set last printed date.
  652. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setLastPrintedProperty(org.apache.poi.OpenXml4Net.util.Nullable)
  653. </member>
  654. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetModifiedProperty(System.String)">
  655. Set last modification date.
  656. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setModifiedProperty(org.apache.poi.OpenXml4Net.util.Nullable)
  657. </member>
  658. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetModifiedProperty(System.Nullable{System.DateTime})">
  659. Set last modification date.
  660. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setModifiedProperty(org.apache.poi.OpenXml4Net.util.Nullable)
  661. </member>
  662. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetRevisionProperty(System.String)">
  663. Set revision.
  664. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setRevisionProperty(java.lang.String)
  665. </member>
  666. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetSubjectProperty(System.String)">
  667. Set subject.
  668. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setSubjectProperty(java.lang.String)
  669. </member>
  670. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetTitleProperty(System.String)">
  671. Set title.
  672. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setTitleProperty(java.lang.String)
  673. </member>
  674. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetVersionProperty(System.String)">
  675. Set version.
  676. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setVersionProperty(java.lang.String)
  677. </member>
  678. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetStringValue(System.String)">
  679. Convert a strig value into a String
  680. </member>
  681. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetDateValue(System.String)">
  682. Convert a string value represented a date into a DateTime?.
  683. @throws InvalidFormatException
  684. Throws if the date format isnot valid.
  685. </member>
  686. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetDateValue(System.Nullable{System.DateTime})">
  687. Convert a DateTime? into a String.
  688. @param d
  689. The Date to convert.
  690. @return The formated date or null.
  691. @see java.util.SimpleDateFormat
  692. </member>
  693. <member name="T:NPOI.OpenXml4Net.OPC.Internal.PartMarshaller">
  694. Object implemented this interface are considered as part marshaller. A part
  695. marshaller is responsible to marshall a part in order to be save in a
  696. package.
  697. @author Julien Chable
  698. @version 0.1
  699. </member>
  700. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PartMarshaller.Marshall(NPOI.OpenXml4Net.OPC.PackagePart,System.IO.Stream)">
  701. Save the content of the package in the stream
  702. @param part
  703. Part to marshall.
  704. @param out
  705. The output stream into which the part will be marshall.
  706. @return false if any marshall error occurs, else <b>true</b>
  707. @throws OpenXml4NetException
  708. Throws only if any other exceptions are thrown by inner
  709. methods.
  710. </member>
  711. <member name="T:NPOI.OpenXml4Net.OPC.Internal.PartUnmarshaller">
  712. Object implemented this interface are considered as part unmarshaller. A part
  713. unmarshaller is responsible to unmarshall a part in order to load it from a
  714. package.
  715. @author Julien Chable
  716. @version 0.1
  717. </member>
  718. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PartUnmarshaller.Unmarshall(NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.UnmarshallContext,System.IO.Stream)">
  719. Save the content of the package in the stream
  720. @param in
  721. The input stream from which the part will be unmarshall.
  722. @return The part freshly unmarshall from the input stream.
  723. @throws OpenXml4NetException
  724. Throws only if any other exceptions are thrown by inner
  725. methods.
  726. </member>
  727. <member name="T:NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.PackagePropertiesUnmarshaller">
  728. Package properties unmarshaller.
  729. @author Julien Chable
  730. @version 1.0
  731. </member>
  732. <!-- Badly formed XML comment ignored for member "M:NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.PackagePropertiesUnmarshaller.CheckElementForOPCCompliance(System.Xml.XmlElement)" -->
  733. <member name="T:NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.UnmarshallContext">
  734. Context needed for the unmarshall process of a part. This class is immutable.
  735. @author Julien Chable
  736. @version 1.0
  737. </member>
  738. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.UnmarshallContext.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName)">
  739. Constructor.
  740. @param targetPackage
  741. Container.
  742. @param partName
  743. Name of the part to unmarshall.
  744. </member>
  745. <member name="P:NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.UnmarshallContext.Package">
  746. @return the container
  747. </member>
  748. <member name="P:NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.UnmarshallContext.PartName">
  749. @return the partName
  750. </member>
  751. <member name="P:NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.UnmarshallContext.ZipEntry">
  752. @return the zipEntry
  753. </member>
  754. <member name="T:NPOI.OpenXml4Net.OPC.Internal.ZipContentTypeManager">
  755. Zip implementation of the ContentTypeManager.
  756. @author Julien Chable
  757. @version 1.0
  758. @see ContentTypeManager
  759. </member>
  760. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipContentTypeManager.#ctor(System.IO.Stream,NPOI.OpenXml4Net.OPC.OPCPackage)">
  761. Delegate constructor to the super constructor.
  762. @param in
  763. The input stream to parse to fill internal content type
  764. collections.
  765. @throws InvalidFormatException
  766. If the content types part content is not valid.
  767. </member>
  768. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.FORWARD_SLASH">
  769. Forward slash use to convert part name between OPC and zip item naming
  770. conventions.
  771. </member>
  772. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.READ_WRITE_FILE_BUFFER_SIZE">
  773. Buffer to read data from file. Use big buffer to improve performaces. the
  774. InputStream class is reading only 8192 bytes per read call (default value
  775. set by sun)
  776. </member>
  777. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.#ctor">
  778. Prevent this class to be instancied.
  779. </member>
  780. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.GetCorePropertiesZipEntry(NPOI.OpenXml4Net.OPC.ZipPackage)">
  781. Retrieve the zip entry of the core properties part.
  782. @throws OpenXml4NetException
  783. Throws if internal error occurs.
  784. </member>
  785. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.GetContentTypeZipEntry(NPOI.OpenXml4Net.OPC.ZipPackage)">
  786. Retrieve the Zip entry of the content types part.
  787. </member>
  788. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.GetOPCNameFromZipItemName(System.String)">
  789. Convert a zip name into an OPC name by adding a leading forward slash to
  790. the specified item name.
  791. @param zipItemName
  792. Zip item name to convert.
  793. @return An OPC compliant name.
  794. </member>
  795. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.GetZipItemNameFromOPCName(System.String)">
  796. Convert an OPC item name into a zip item name by removing any leading
  797. forward slash if it exist.
  798. @param opcItemName
  799. The OPC item name to convert.
  800. @return A zip item name without any leading slashes.
  801. </member>
  802. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.GetZipURIFromOPCName(System.String)">
  803. Convert an OPC item name into a zip URI by removing any leading forward
  804. slash if it exist.
  805. @param opcItemName
  806. The OPC item name to convert.
  807. @return A zip URI without any leading slashes.
  808. </member>
  809. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.VerifyZipHeader(NPOI.Util.InputStream)">
  810. Verifies that the given stream starts with a Zip structure.
  811. Warning - this will consume the first few bytes of the stream,
  812. you should push-back or reset the stream after use!
  813. </member>
  814. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.OpenZipStream(System.IO.Stream)">
  815. Opens the specified stream as a secure zip
  816. @param stream
  817. The stream to open.
  818. @return The zip stream freshly open.
  819. </member>
  820. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.OpenZipFile(System.IO.FileInfo)">
  821. Opens the specified file as a zip, or returns null if no such file exists
  822. @param file
  823. The file to open.
  824. @return The zip archive freshly open.
  825. </member>
  826. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.OpenZipFile(System.String)">
  827. Retrieve and open a zip file with the specified path.
  828. @param path
  829. The file path.
  830. @return The zip archive freshly open.
  831. </member>
  832. <member name="T:NPOI.OpenXml4Net.OPC.OPCPackage">
  833. Represents a container that can store multiple data objects.
  834. @author Julien Chable, CDubet
  835. @version 0.1
  836. </member>
  837. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.logger">
  838. Logger.
  839. </member>
  840. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.defaultPackageAccess">
  841. Default package access.
  842. </member>
  843. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.packageAccess">
  844. Package access.
  845. </member>
  846. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.partList">
  847. Package parts collection.
  848. </member>
  849. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.relationships">
  850. Package relationships.
  851. </member>
  852. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.partMarshallers">
  853. Part marshallers by content type.
  854. </member>
  855. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.defaultPartMarshaller">
  856. Default part marshaller.
  857. </member>
  858. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.partUnmarshallers">
  859. Part unmarshallers by content type.
  860. </member>
  861. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.packageProperties">
  862. Core package properties.
  863. </member>
  864. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.contentTypeManager">
  865. Manage parts content types of this package.
  866. </member>
  867. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.isDirty">
  868. Flag if a modification is done to the document.
  869. </member>
  870. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.originalPackagePath">
  871. File path of this package.
  872. </member>
  873. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.output">
  874. Output stream for writing this package.
  875. </member>
  876. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.#ctor(NPOI.OpenXml4Net.OPC.PackageAccess)">
  877. Constructor.
  878. @param access
  879. Package access.
  880. </member>
  881. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Init">
  882. Initialize the package instance.
  883. </member>
  884. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Open(System.String)">
  885. Open a package with read/write permission.
  886. @param path
  887. The document path.
  888. @return A Package object, else <b>null</b>.
  889. @throws InvalidFormatException
  890. If the specified file doesn't exist, and a parsing error
  891. occur.
  892. </member>
  893. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Open(System.IO.FileInfo)">
  894. Open a package with read/write permission.
  895. @param file
  896. The file to open.
  897. @return A Package object, else <b>null</b>.
  898. @throws InvalidFormatException
  899. If the specified file doesn't exist, and a parsing error
  900. occur.
  901. </member>
  902. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Open(NPOI.OpenXml4Net.Util.ZipEntrySource)">
  903. Open an user provided {@link ZipEntrySource} with read-only permission.
  904. This method can be used to stream data into POI.
  905. Opposed to other open variants, the data is read as-is, e.g. there aren't
  906. any zip-bomb protection put in place.
  907. @param zipEntry the custom source
  908. @return A Package object
  909. @ if a parsing error occur.
  910. </member>
  911. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Open(System.String,NPOI.OpenXml4Net.OPC.PackageAccess)">
  912. Open a package.
  913. @param path
  914. The document path.
  915. @param access
  916. PackageBase access.
  917. @return A PackageBase object, else <b>null</b>.
  918. @throws InvalidFormatException
  919. If the specified file doesn't exist, and a parsing error
  920. occur.
  921. @throws InvalidOperationException If the zip file cannot be opened.
  922. @throws InvalidFormatException if the package is not valid.
  923. </member>
  924. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Open(System.IO.FileInfo,NPOI.OpenXml4Net.OPC.PackageAccess)">
  925. Open a package.
  926. @param file
  927. The file to open.
  928. @param access
  929. PackageBase access.
  930. @return A PackageBase object, else <b>null</b>.
  931. @throws InvalidFormatException
  932. If the specified file doesn't exist, and a parsing error
  933. occur.
  934. </member>
  935. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Open(System.IO.Stream)">
  936. Open a package.
  937. Note - uses quite a bit more memory than {@link #open(String)}, which
  938. doesn't need to hold the whole zip file in memory, and can take advantage
  939. of native methods
  940. @param in
  941. The InputStream to read the package from
  942. @return A PackageBase object
  943. </member>
  944. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.OpenOrCreate(System.String)">
  945. Opens a package if it exists, else it Creates one.
  946. @param file
  947. The file to open or to Create.
  948. @return A newly Created package if the specified file does not exist,
  949. else the package extract from the file.
  950. @throws InvalidFormatException
  951. Throws if the specified file exist and is not valid.
  952. </member>
  953. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Create(System.String)">
  954. Creates a new package.
  955. @param file
  956. Path of the document.
  957. @return A newly Created PackageBase ready to use.
  958. </member>
  959. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Flush">
  960. Flush the package : save all.
  961. @see #close()
  962. </member>
  963. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Close">
  964. Close the package and save its content.
  965. @throws IOException
  966. If an IO exception occur during the saving process.
  967. </member>
  968. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Revert">
  969. Close the package WITHOUT saving its content. Reinitialize this package
  970. and cancel all changes done to it.
  971. </member>
  972. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddThumbnail(System.String)">
  973. <summary>
  974. Add a thumbnail to the package. This method is provided to make easier
  975. the addition of a thumbnail in a package. You can do the same work by
  976. using the traditionnal relationship and part mechanism.
  977. </summary>
  978. <param name="path">path The full path to the image file.</param>
  979. </member>
  980. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddThumbnail(System.String,System.IO.Stream)">
  981. <summary>
  982. Add a thumbnail to the package. This method is provided to make easier
  983. the addition of a thumbnail in a package. You can do the same work by
  984. using the traditionnal relationship and part mechanism.
  985. </summary>
  986. <param name="filename"></param>
  987. <param name="data"></param>
  988. </member>
  989. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.ThrowExceptionIfReadOnly">
  990. Throws an exception if the package access mode is in read only mode
  991. (PackageAccess.Read).
  992. @throws InvalidOperationException
  993. Throws if a writing operation is done on a read only package.
  994. @see org.apache.poi.OpenXml4Net.opc.PackageAccess
  995. </member>
  996. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.ThrowExceptionIfWriteOnly">
  997. Throws an exception if the package access mode is in write only mode
  998. (PackageAccess.Write). This method is call when other methods need write
  999. right.
  1000. @throws InvalidOperationException if a read operation is done on a write only package.
  1001. @see org.apache.poi.OpenXml4Net.opc.PackageAccess
  1002. </member>
  1003. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPackageProperties">
  1004. Retrieves or Creates if none exists, core package property part.
  1005. @return The PackageProperties part of this package.
  1006. </member>
  1007. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPart(NPOI.OpenXml4Net.OPC.PackagePartName)">
  1008. Retrieve a part identified by its name.
  1009. @param PartName
  1010. Part name of the part to retrieve.
  1011. @return The part with the specified name, else <code>null</code>.
  1012. </member>
  1013. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPartsByContentType(System.String)">
  1014. Retrieve parts by content type.
  1015. @param contentType
  1016. The content type criteria.
  1017. @return All part associated to the specified content type.
  1018. </member>
  1019. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPartsByRelationshipType(System.String)">
  1020. Retrieve parts by relationship type.
  1021. @param relationshipType
  1022. Relationship type.
  1023. @return All parts which are the target of a relationship with the
  1024. specified type, if the method can't retrieve relationships from
  1025. the package, then return <code>null</code>.
  1026. </member>
  1027. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPartsByName(System.Text.RegularExpressions.Regex)">
  1028. Retrieve parts by name
  1029. @param namePattern
  1030. The pattern for matching the names
  1031. @return All parts associated to the specified content type, sorted
  1032. in alphanumerically by the part-name
  1033. </member>
  1034. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPart(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  1035. Get the target part from the specified relationship.
  1036. @param partRel
  1037. The part relationship uses to retrieve the part.
  1038. </member>
  1039. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetParts">
  1040. Load the parts of the archive if it has not been done yet. The
  1041. relationships of each part are not loaded.
  1042. Note - Rule M4.1 states that there may only ever be one Core
  1043. Properties Part, but Office produced files will sometimes
  1044. have multiple! As Office ignores all but the first, we relax
  1045. Compliance with Rule M4.1, and ignore all others silently too.
  1046. @return All this package's parts.
  1047. @throws InvalidFormatException if the package is not valid.
  1048. </member>
  1049. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.CreatePart(NPOI.OpenXml4Net.OPC.PackagePartName,System.String)">
  1050. Create and Add a part, with the specified name and content type, to the
  1051. package.
  1052. @param PartName
  1053. Part name.
  1054. @param contentType
  1055. Part content type.
  1056. @return The newly Created part.
  1057. @throws InvalidFormatException
  1058. If rule M1.12 is not verified : Packages shall not contain
  1059. equivalent part names and package implementers shall neither
  1060. Create nor recognize packages with equivalent part names.
  1061. @see #CreatePartImpl(PackagePartName, String, bool)
  1062. </member>
  1063. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.CreatePart(NPOI.OpenXml4Net.OPC.PackagePartName,System.String,System.Boolean)">
  1064. Create and Add a part, with the specified name and content type, to the
  1065. package. For general purpose, prefer the overload version of this method
  1066. without the 'loadRelationships' parameter.
  1067. @param PartName
  1068. Part name.
  1069. @param contentType
  1070. Part content type.
  1071. @param loadRelationships
  1072. Specify if the existing relationship part, if any, logically
  1073. associated to the newly Created part will be loaded.
  1074. @return The newly Created part.
  1075. @throws InvalidFormatException
  1076. If rule M1.12 is not verified : Packages shall not contain
  1077. equivalent part names and package implementers shall neither
  1078. Create nor recognize packages with equivalent part names.
  1079. @see {@link#CreatePartImpl(URI, String)}
  1080. </member>
  1081. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.CreatePart(NPOI.OpenXml4Net.OPC.PackagePartName,System.String,System.IO.MemoryStream)">
  1082. Add a part to the package.
  1083. @param PartName
  1084. Part name of the part to Create.
  1085. @param contentType
  1086. type associated with the file
  1087. @param content
  1088. the contents to Add. In order to have faster operation in
  1089. document merge, the data are stored in memory not on a hard
  1090. disk
  1091. @return The new part.
  1092. @see #CreatePart(PackagePartName, String)
  1093. </member>
  1094. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddPackagePart(NPOI.OpenXml4Net.OPC.PackagePart)">
  1095. Add the specified part to the package. If a part already exists in the
  1096. package with the same name as the one specified, then we replace the old
  1097. part by the specified part.
  1098. @param part
  1099. The part to add (or replace).
  1100. @return The part added to the package, the same as the one specified.
  1101. @throws InvalidOperationException
  1102. If rule M1.12 is not verified : Packages shall not contain
  1103. equivalent part names and package implementers shall neither
  1104. create nor recognize packages with equivalent part names.
  1105. </member>
  1106. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RemovePart(NPOI.OpenXml4Net.OPC.PackagePart)">
  1107. Remove the specified part in this package. If this part is relationship
  1108. part, then delete all relationships in the source part.
  1109. @param part
  1110. The part to Remove. If <code>null</code>, skip the action.
  1111. @see #RemovePart(PackagePartName)
  1112. </member>
  1113. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RemovePart(NPOI.OpenXml4Net.OPC.PackagePartName)">
  1114. Remove a part in this package. If this part is relationship part, then
  1115. delete all relationships in the source part.
  1116. @param PartName
  1117. The part name of the part to Remove.
  1118. </member>
  1119. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RemovePartRecursive(NPOI.OpenXml4Net.OPC.PackagePartName)">
  1120. Remove a part from this package as well as its relationship part, if one
  1121. exists, and all parts listed in the relationship part. Be aware that this
  1122. do not delete relationships which target the specified part.
  1123. @param PartName
  1124. The name of the part to delete.
  1125. @throws InvalidFormatException
  1126. Throws if the associated relationship part of the specified
  1127. part is not valid.
  1128. </member>
  1129. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.DeletePart(NPOI.OpenXml4Net.OPC.PackagePartName)">
  1130. Delete the part with the specified name and its associated relationships
  1131. part if one exists. Prefer the use of this method to delete a part in the
  1132. package, compare to the Remove() methods that don't Remove associated
  1133. relationships part.
  1134. @param PartName
  1135. Name of the part to delete
  1136. </member>
  1137. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.DeletePartRecursive(NPOI.OpenXml4Net.OPC.PackagePartName)">
  1138. Delete the part with the specified name and all part listed in its
  1139. associated relationships part if one exists. This process is recursively
  1140. apply to all parts in the relationships part of the specified part.
  1141. Prefer the use of this method to delete a part in the package, compare to
  1142. the Remove() methods that don't Remove associated relationships part.
  1143. @param PartName
  1144. Name of the part to delete
  1145. </member>
  1146. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.ContainPart(NPOI.OpenXml4Net.OPC.PackagePartName)">
  1147. Check if a part already exists in this package from its name.
  1148. @param PartName
  1149. Part name to check.
  1150. @return <i>true</i> if the part is logically Added to this package, else
  1151. <i>false</i>.
  1152. </member>
  1153. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddRelationship(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.TargetMode,System.String,System.String)">
  1154. Add a relationship to the package (except relationships part).
  1155. Check rule M4.1 : The format designer shall specify and the format
  1156. producer shall Create at most one core properties relationship for a
  1157. package. A format consumer shall consider more than one core properties
  1158. relationship for a package to be an error. If present, the relationship
  1159. shall target the Core Properties part.
  1160. Check rule M1.25: The Relationships part shall not have relationships to
  1161. any other part. Package implementers shall enforce this requirement upon
  1162. the attempt to Create such a relationship and shall treat any such
  1163. relationship as invalid.
  1164. @param targetPartName
  1165. Target part name.
  1166. @param targetMode
  1167. Target mode, either Internal or External.
  1168. @param relationshipType
  1169. Relationship type.
  1170. @param relID
  1171. ID of the relationship.
  1172. @see PackageRelationshipTypes
  1173. </member>
  1174. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddRelationship(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.TargetMode,System.String)">
  1175. Add a package relationship.
  1176. @param targetPartName
  1177. Target part name.
  1178. @param targetMode
  1179. Target mode, either Internal or External.
  1180. @param relationshipType
  1181. Relationship type.
  1182. @see PackageRelationshipTypes
  1183. </member>
  1184. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddExternalRelationship(System.String,System.String)">
  1185. Adds an external relationship to a part (except relationships part).
  1186. The targets of external relationships are not subject to the same
  1187. validity checks that internal ones are, as the contents is potentially
  1188. any file, URL or similar.
  1189. @param target
  1190. External target of the relationship
  1191. @param relationshipType
  1192. Type of relationship.
  1193. @return The newly Created and Added relationship
  1194. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddExternalRelationship(java.lang.String,
  1195. java.lang.String)
  1196. </member>
  1197. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddExternalRelationship(System.String,System.String,System.String)">
  1198. Adds an external relationship to a part (except relationships part).
  1199. The targets of external relationships are not subject to the same
  1200. validity checks that internal ones are, as the contents is potentially
  1201. any file, URL or similar.
  1202. @param target
  1203. External target of the relationship
  1204. @param relationshipType
  1205. Type of relationship.
  1206. @param id
  1207. Relationship unique id.
  1208. @return The newly Created and Added relationship
  1209. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddExternalRelationship(java.lang.String,
  1210. java.lang.String)
  1211. </member>
  1212. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RemoveRelationship(System.String)">
  1213. Delete a relationship from this package.
  1214. @param id
  1215. Id of the relationship to delete.
  1216. </member>
  1217. <member name="P:NPOI.OpenXml4Net.OPC.OPCPackage.Relationships">
  1218. Retrieves all package relationships.
  1219. @return All package relationships of this package.
  1220. @throws InvalidOperationException if a read operation is done on a write only package.
  1221. @see #GetRelationshipsHelper(String)
  1222. </member>
  1223. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetRelationshipsByType(System.String)">
  1224. Retrieves all relationships with the specified type.
  1225. @param relationshipType
  1226. The filter specifying the relationship type.
  1227. @return All relationships with the specified relationship type.
  1228. </member>
  1229. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetRelationshipsHelper(System.String)">
  1230. Retrieves all relationships with specified id (normally just ine because
  1231. a relationship id is supposed to be unique).
  1232. @param id
  1233. Id of the wanted relationship.
  1234. </member>
  1235. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.ClearRelationships">
  1236. Clear package relationships.
  1237. </member>
  1238. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.EnsureRelationships">
  1239. Ensure that the relationships collection is not null.
  1240. </member>
  1241. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetRelationship(System.String)">
  1242. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#GetRelationship(java.lang.String)
  1243. </member>
  1244. <member name="P:NPOI.OpenXml4Net.OPC.OPCPackage.HasRelationships">
  1245. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#hasRelationships()
  1246. </member>
  1247. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.IsRelationshipExists(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  1248. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#isRelationshipExists(org.apache.poi.OpenXml4Net.opc.PackageRelationship)
  1249. </member>
  1250. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddMarshaller(System.String,NPOI.OpenXml4Net.OPC.Internal.PartMarshaller)">
  1251. Add a marshaller.
  1252. @param contentType
  1253. The content type to bind to the specified marshaller.
  1254. @param marshaller
  1255. The marshaller to register with the specified content type.
  1256. </member>
  1257. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddUnmarshaller(System.String,NPOI.OpenXml4Net.OPC.Internal.PartUnmarshaller)">
  1258. Add an unmarshaller.
  1259. @param contentType
  1260. The content type to bind to the specified unmarshaller.
  1261. @param unmarshaller
  1262. The unmarshaller to register with the specified content type.
  1263. </member>
  1264. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RemoveMarshaller(System.String)">
  1265. Remove a marshaller by its content type.
  1266. @param contentType
  1267. The content type associated with the marshaller to Remove.
  1268. </member>
  1269. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RemoveUnmarshaller(System.String)">
  1270. Remove an unmarshaller by its content type.
  1271. @param contentType
  1272. The content type associated with the unmarshaller to Remove.
  1273. </member>
  1274. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPackageAccess">
  1275. Get the package access mode.
  1276. @return the packageAccess The current package access.
  1277. </member>
  1278. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.ValidatePackage(NPOI.OpenXml4Net.OPC.OPCPackage)">
  1279. Validates the package compliance with the OPC specifications.
  1280. @return <b>true</b> if the package is valid else <b>false</b>
  1281. </member>
  1282. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Save(System.String)">
  1283. Save the document in the specified file.
  1284. @param targetFile
  1285. Destination file.
  1286. @throws IOException
  1287. Throws if an IO exception occur.
  1288. @see #save(OutputStream)
  1289. </member>
  1290. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Save(System.IO.Stream)">
  1291. Save the document in the specified output stream.
  1292. @param outputStream
  1293. The stream to save the package.
  1294. @see #saveImpl(OutputStream)
  1295. </member>
  1296. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.CreatePartImpl(NPOI.OpenXml4Net.OPC.PackagePartName,System.String,System.Boolean)">
  1297. Core method to Create a package part. This method must be implemented by
  1298. the subclass.
  1299. @param PartName
  1300. URI of the part to Create.
  1301. @param contentType
  1302. Content type of the part to Create.
  1303. @return The newly Created package part.
  1304. </member>
  1305. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RemovePartImpl(NPOI.OpenXml4Net.OPC.PackagePartName)">
  1306. Core method to delete a package part. This method must be implemented by
  1307. the subclass.
  1308. @param PartName
  1309. The URI of the part to delete.
  1310. </member>
  1311. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.FlushImpl">
  1312. Flush the package but not save.
  1313. </member>
  1314. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.CloseImpl">
  1315. Close the package and cause a save of the package.
  1316. </member>
  1317. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RevertImpl">
  1318. Close the package without saving the document. Discard all changes made
  1319. to this package.
  1320. </member>
  1321. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.SaveImpl(System.IO.Stream)">
  1322. Save the package into the specified output stream.
  1323. @param outputStream
  1324. The output stream use to save this package.
  1325. </member>
  1326. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPartImpl(NPOI.OpenXml4Net.OPC.PackagePartName)">
  1327. Get the package part mapped to the specified URI.
  1328. @param PartName
  1329. The URI of the part to retrieve.
  1330. @return The package part located by the specified URI, else <b>null</b>.
  1331. </member>
  1332. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPartsImpl">
  1333. Get all parts link to the package.
  1334. @return A list of the part owned by the package.
  1335. </member>
  1336. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.ReplaceContentType(System.String,System.String)">
  1337. Replace a content type in this package.
  1338. <p>
  1339. A typical scneario to call this method is to rename a template file to the main format, e.g.
  1340. ".dotx" to ".docx"
  1341. ".dotm" to ".docm"
  1342. ".xltx" to ".xlsx"
  1343. ".xltm" to ".xlsm"
  1344. ".potx" to ".pptx"
  1345. ".potm" to ".pptm"
  1346. </p>
  1347. For example, a code converting a .xlsm macro workbook to .xlsx would look as follows:
  1348. <p>
  1349. <pre><code>
  1350. OPCPackage pkg = OPCPackage.open(new FileInputStream("macro-workbook.xlsm"));
  1351. pkg.replaceContentType(
  1352. "application/vnd.ms-excel.sheet.macroEnabled.main+xml",
  1353. "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml");
  1354. FileOutputStream out = new FileOutputStream("workbook.xlsx");
  1355. pkg.save(out);
  1356. out.close();
  1357. </code></pre>
  1358. </p>
  1359. @param oldContentType the content type to be replaced
  1360. @param newContentType the replacement
  1361. @return whether replacement was succesfull
  1362. @since POI-3.8
  1363. </member>
  1364. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RegisterPartAndContentType(NPOI.OpenXml4Net.OPC.PackagePart)">
  1365. Add the specified part, and register its content type with the content
  1366. type manager.
  1367. @param part
  1368. The part to add.
  1369. </member>
  1370. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.UnregisterPartAndContentType(NPOI.OpenXml4Net.OPC.PackagePartName)">
  1371. Remove the specified part, and clear its content type from the content
  1372. type manager.
  1373. @param partName
  1374. The part name of the part to remove.
  1375. </member>
  1376. <member name="T:NPOI.OpenXml4Net.OPC.PackageAccess">
  1377. Specifies package access.
  1378. @author Julien Chable
  1379. @version 1.0
  1380. </member>
  1381. <member name="F:NPOI.OpenXml4Net.OPC.PackageAccess.READ">
  1382. Read only. Write not authorized.
  1383. </member>
  1384. <member name="F:NPOI.OpenXml4Net.OPC.PackageAccess.WRITE">
  1385. Write only. Read not authorized.
  1386. </member>
  1387. <member name="F:NPOI.OpenXml4Net.OPC.PackageAccess.READ_WRITE">
  1388. Read and Write mode.
  1389. </member>
  1390. <member name="T:NPOI.OpenXml4Net.OPC.PackageNamespaces">
  1391. Open Packaging Convention namespaces URI.
  1392. @author Julien Chable
  1393. @version 1.0
  1394. </member>
  1395. <member name="F:NPOI.OpenXml4Net.OPC.PackageNamespaces.NAMESPACE_DCTERMS">
  1396. Dublin Core Terms URI.
  1397. </member>
  1398. <member name="F:NPOI.OpenXml4Net.OPC.PackageNamespaces.NAMESPACE_DC">
  1399. Dublin Core namespace URI.
  1400. </member>
  1401. <member name="F:NPOI.OpenXml4Net.OPC.PackageNamespaces.CONTENT_TYPES">
  1402. Content Types.
  1403. </member>
  1404. <member name="F:NPOI.OpenXml4Net.OPC.PackageNamespaces.CORE_PROPERTIES">
  1405. Core Properties.
  1406. </member>
  1407. <member name="F:NPOI.OpenXml4Net.OPC.PackageNamespaces.DIGITAL_SIGNATURE">
  1408. Digital Signatures.
  1409. </member>
  1410. <member name="F:NPOI.OpenXml4Net.OPC.PackageNamespaces.RELATIONSHIPS">
  1411. Relationships.
  1412. </member>
  1413. <member name="F:NPOI.OpenXml4Net.OPC.PackageNamespaces.MARKUP_COMPATIBILITY">
  1414. Markup Compatibility.
  1415. </member>
  1416. <member name="T:NPOI.OpenXml4Net.OPC.PackagePart">
  1417. Provides a base class for parts stored in a Package.
  1418. @author Julien Chable
  1419. @version 0.9
  1420. </member>
  1421. <member name="F:NPOI.OpenXml4Net.OPC.PackagePart._container">
  1422. This part's container.
  1423. </member>
  1424. <member name="F:NPOI.OpenXml4Net.OPC.PackagePart._partName">
  1425. The part name. (required by the specification [M1.1])
  1426. </member>
  1427. <member name="F:NPOI.OpenXml4Net.OPC.PackagePart._contentType">
  1428. The type of content of this part. (required by the specification [M1.2])
  1429. </member>
  1430. <member name="F:NPOI.OpenXml4Net.OPC.PackagePart._isRelationshipPart">
  1431. Flag to know if this part is a relationship.
  1432. </member>
  1433. <member name="F:NPOI.OpenXml4Net.OPC.PackagePart._isDeleted">
  1434. Flag to know if this part has been logically deleted.
  1435. </member>
  1436. <member name="F:NPOI.OpenXml4Net.OPC.PackagePart._relationships">
  1437. This part's relationships.
  1438. </member>
  1439. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.Internal.ContentType)">
  1440. Constructor.
  1441. @param pack
  1442. Parent package.
  1443. @param partName
  1444. The part name, relative to the parent Package root.
  1445. @param contentType
  1446. The content type.
  1447. @throws InvalidFormatException
  1448. If the specified URI is not valid.
  1449. </member>
  1450. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.Internal.ContentType,System.Boolean)">
  1451. Constructor.
  1452. @param pack
  1453. Parent package.
  1454. @param partName
  1455. The part name, relative to the parent Package root.
  1456. @param contentType
  1457. The content type.
  1458. @param loadRelationships
  1459. Specify if the relationships will be loaded
  1460. @throws InvalidFormatException
  1461. If the specified URI is not valid.
  1462. </member>
  1463. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName,System.String)">
  1464. Constructor.
  1465. @param pack
  1466. Parent package.
  1467. @param partName
  1468. The part name, relative to the parent Package root.
  1469. @param contentType
  1470. The Multipurpose Internet Mail Extensions (MIME) content type
  1471. of the part's data stream.
  1472. </member>
  1473. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.FindExistingRelation(NPOI.OpenXml4Net.OPC.PackagePart)">
  1474. <summary>
  1475. Check if the new part was already added before via PackagePart.addRelationship()
  1476. </summary>
  1477. <param name="packagePart">to find the relationship for</param>
  1478. <returns>The existing relationship, or null if there isn't yet one</returns>
  1479. </member>
  1480. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.AddExternalRelationship(System.String,System.String)">
  1481. Adds an external relationship to a part (except relationships part).
  1482. The targets of external relationships are not subject to the same
  1483. validity checks that internal ones are, as the contents is potentially
  1484. any file, URL or similar.
  1485. @param target
  1486. External target of the relationship
  1487. @param relationshipType
  1488. Type of relationship.
  1489. @return The newly created and added relationship
  1490. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#addExternalRelationship(java.lang.String,
  1491. java.lang.String)
  1492. </member>
  1493. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.AddExternalRelationship(System.String,System.String,System.String)">
  1494. Adds an external relationship to a part (except relationships part).
  1495. The targets of external relationships are not subject to the same
  1496. validity checks that internal ones are, as the contents is potentially
  1497. any file, URL or similar.
  1498. @param target
  1499. External target of the relationship
  1500. @param relationshipType
  1501. Type of relationship.
  1502. @param id
  1503. Relationship unique id.
  1504. @return The newly created and added relationship
  1505. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#addExternalRelationship(java.lang.String,
  1506. java.lang.String)
  1507. </member>
  1508. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.AddRelationship(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.TargetMode,System.String)">
  1509. Add a relationship to a part (except relationships part).
  1510. @param targetPartName
  1511. Name of the target part. This one must be relative to the
  1512. source root directory of the part.
  1513. @param targetMode
  1514. Mode [Internal|External].
  1515. @param relationshipType
  1516. Type of relationship.
  1517. @return The newly created and added relationship
  1518. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddRelationship(org.apache.poi.OpenXml4Net.opc.PackagePartName,
  1519. org.apache.poi.OpenXml4Net.opc.TargetMode, java.lang.String)
  1520. </member>
  1521. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.AddRelationship(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.TargetMode,System.String,System.String)">
  1522. Add a relationship to a part (except relationships part).
  1523. <p>
  1524. Check rule M1.25: The Relationships part shall not have relationships to
  1525. any other part. Package implementers shall enforce this requirement upon
  1526. the attempt to create such a relationship and shall treat any such
  1527. relationship as invalid.
  1528. </p>
  1529. @param targetPartName
  1530. Name of the target part. This one must be relative to the
  1531. source root directory of the part.
  1532. @param targetMode
  1533. Mode [Internal|External].
  1534. @param relationshipType
  1535. Type of relationship.
  1536. @param id
  1537. Relationship unique id.
  1538. @return The newly created and added relationship
  1539. @throws InvalidFormatException
  1540. If the URI point to a relationship part URI.
  1541. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddRelationship(org.apache.poi.OpenXml4Net.opc.PackagePartName,
  1542. org.apache.poi.OpenXml4Net.opc.TargetMode, java.lang.String, java.lang.String)
  1543. </member>
  1544. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.AddRelationship(System.Uri,NPOI.OpenXml4Net.OPC.TargetMode,System.String)">
  1545. Add a relationship to a part (except relationships part).
  1546. @param targetURI
  1547. URI the target part. Must be relative to the source root
  1548. directory of the part.
  1549. @param targetMode
  1550. Mode [Internal|External].
  1551. @param relationshipType
  1552. Type of relationship.
  1553. @return The newly created and added relationship
  1554. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddRelationship(org.apache.poi.OpenXml4Net.opc.PackagePartName,
  1555. org.apache.poi.OpenXml4Net.opc.TargetMode, java.lang.String)
  1556. </member>
  1557. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.AddRelationship(System.Uri,NPOI.OpenXml4Net.OPC.TargetMode,System.String,System.String)">
  1558. Add a relationship to a part (except relationships part).
  1559. <p>
  1560. Check rule M1.25: The Relationships part shall not have relationships to
  1561. any other part. Package implementers shall enforce this requirement upon
  1562. the attempt to create such a relationship and shall treat any such
  1563. relationship as invalid.
  1564. </p>
  1565. @param targetURI
  1566. URI of the target part. Must be relative to the source root
  1567. directory of the part.
  1568. @param targetMode
  1569. Mode [Internal|External].
  1570. @param relationshipType
  1571. Type of relationship.
  1572. @param id
  1573. Relationship unique id.
  1574. @return The newly created and added relationship
  1575. @throws InvalidFormatException
  1576. If the URI point to a relationship part URI.
  1577. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddRelationship(org.apache.poi.OpenXml4Net.opc.PackagePartName,
  1578. org.apache.poi.OpenXml4Net.opc.TargetMode, java.lang.String, java.lang.String)
  1579. </member>
  1580. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.ClearRelationships">
  1581. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#clearRelationships()
  1582. </member>
  1583. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.RemoveRelationship(System.String)">
  1584. Delete the relationship specified by its id.
  1585. @param id
  1586. The ID identified the part to delete.
  1587. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#removeRelationship(java.lang.String)
  1588. </member>
  1589. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.Relationships">
  1590. Retrieve all the relationships attached to this part.
  1591. @return This part's relationships.
  1592. @throws OpenXml4NetException
  1593. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#getRelationships()
  1594. </member>
  1595. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetRelationship(System.String)">
  1596. Retrieves a package relationship from its id.
  1597. @param id
  1598. ID of the package relationship to retrieve.
  1599. @return The package relationship
  1600. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#getRelationship(java.lang.String)
  1601. </member>
  1602. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetRelationshipsByType(System.String)">
  1603. Retrieve all relationships attached to this part which have the specified
  1604. type.
  1605. @param relationshipType
  1606. Relationship type filter.
  1607. @return All relationships from this part that have the specified type.
  1608. @throws InvalidFormatException
  1609. If an error occurs while parsing the part.
  1610. @throws InvalidOperationException
  1611. If the package is open in write only mode.
  1612. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#getRelationshipsByType(java.lang.String)
  1613. </member>
  1614. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetRelationshipsCore(System.String)">
  1615. Implementation of the getRelationships method().
  1616. @param filter
  1617. Relationship type filter. If <i>null</i> then the filter is
  1618. disabled and return all the relationships.
  1619. @return All relationships from this part that have the specified type.
  1620. @throws InvalidFormatException
  1621. Throws if an error occurs during parsing the relationships
  1622. part.
  1623. @throws InvalidOperationException
  1624. Throws if the package is open en write only mode.
  1625. @see #getRelationshipsByType(String)
  1626. </member>
  1627. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.HasRelationships">
  1628. Knows if the part have any relationships.
  1629. @return <b>true</b> if the part have at least one relationship else
  1630. <b>false</b>.
  1631. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#hasRelationships()
  1632. </member>
  1633. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.IsRelationshipExists(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  1634. Checks if the specified relationship is part of this package part.
  1635. @param rel
  1636. The relationship to check.
  1637. @return <b>true</b> if the specified relationship exists in this part,
  1638. else returns <b>false</b>
  1639. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#isRelationshipExists(org.apache.poi.OpenXml4Net.opc.PackageRelationship)
  1640. </member>
  1641. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetRelatedPart(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  1642. Get the PackagePart that is the target of a relationship.
  1643. @param rel A relationship from this part to another one
  1644. @return The target part of the relationship
  1645. </member>
  1646. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetInputStream">
  1647. Get the input stream of this part to read its content.
  1648. @return The input stream of the content of this part, else
  1649. <code>null</code>.
  1650. </member>
  1651. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetOutputStream">
  1652. Get the output stream of this part. If the part is originally embedded in
  1653. Zip package, it'll be transform intot a <i>MemoryPackagePart</i> in
  1654. order to write inside (the standard Java API doesn't allow to write in
  1655. the file)
  1656. @see org.apache.poi.openxml4j.opc.internal.MemoryPackagePart
  1657. </member>
  1658. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.ThrowExceptionIfRelationship">
  1659. Throws an exception if this package part is a relationship part.
  1660. @throws InvalidOperationException
  1661. If this part is a relationship part.
  1662. </member>
  1663. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.LoadRelationships">
  1664. Ensure the package relationships collection instance is built.
  1665. @throws InvalidFormatException
  1666. Throws if
  1667. </member>
  1668. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.PartName">
  1669. @return the uri
  1670. </member>
  1671. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.ContentType">
  1672. @return the contentType
  1673. </member>
  1674. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.ContentTypeDetails">
  1675. @return The Content Type, including parameters, of the part
  1676. </member>
  1677. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.IsRelationshipPart">
  1678. @return true if this part is a relationship
  1679. </member>
  1680. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.IsDeleted">
  1681. @return true if this part has been logically deleted
  1682. </member>
  1683. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.Size">
  1684. @return The length of the part in bytes, or -1 if not known
  1685. </member>
  1686. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.CompareTo(NPOI.OpenXml4Net.OPC.PackagePart)">
  1687. Compare based on the package part name, using a natural sort order
  1688. </member>
  1689. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetInputStreamImpl">
  1690. Abtract method that get the input stream of this part.
  1691. @exception IOException
  1692. Throws if an IO Exception occur in the implementation
  1693. method.
  1694. </member>
  1695. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetOutputStreamImpl">
  1696. Abstract method that get the output stream of this part.
  1697. </member>
  1698. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.Save(System.IO.Stream)">
  1699. Save the content of this part and the associated relationships part (if
  1700. this part own at least one relationship) into the specified output
  1701. stream.
  1702. @param zos
  1703. Output stream to save this part.
  1704. @throws OpenXml4NetException
  1705. If any exception occur.
  1706. </member>
  1707. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.Load(System.IO.Stream)">
  1708. Load the content of this part.
  1709. @param ios
  1710. The input stream of the content to load.
  1711. @return <b>true</b> if the content has been successfully loaded, else
  1712. <b>false</b>.
  1713. @throws InvalidFormatException
  1714. Throws if the content format is invalid.
  1715. </member>
  1716. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.Close">
  1717. Close this part : flush this part, close the input stream and output
  1718. stream. After this method call, the part must be available for packaging.
  1719. </member>
  1720. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.Flush">
  1721. Flush the content of this part. If the input stream and/or output stream
  1722. as in a waiting state to read or write, the must to empty their
  1723. respective buffer.
  1724. </member>
  1725. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.Clear">
  1726. Allows sub-classes to clean up before new data is added.
  1727. </member>
  1728. <member name="T:NPOI.OpenXml4Net.OPC.PackagePartCollection">
  1729. A package part collection.
  1730. @author Julien Chable
  1731. @version 0.1
  1732. </member>
  1733. <member name="F:NPOI.OpenXml4Net.OPC.PackagePartCollection.registerPartNameStr">
  1734. Arraylist use to store this collection part names as string for rule
  1735. M1.11 optimized checking.
  1736. </member>
  1737. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartCollection.Put(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.PackagePart)">
  1738. Check rule [M1.11]: a package implementer shall neither create nor
  1739. recognize a part with a part name derived from another part name by
  1740. Appending segments to it.
  1741. @exception InvalidOperationException
  1742. Throws if you try to add a part with a name derived from
  1743. another part name.
  1744. </member>
  1745. <member name="T:NPOI.OpenXml4Net.OPC.PackagePartName">
  1746. An immutable Open Packaging Convention compliant part name.
  1747. @author Julien Chable
  1748. @see <a href="http://www.ietf.org/rfc/rfc3986.txt">http://www.ietf.org/rfc/rfc3986.txt</a>
  1749. </member>
  1750. <member name="F:NPOI.OpenXml4Net.OPC.PackagePartName.partNameURI">
  1751. Part name stored as an URI.
  1752. </member>
  1753. <member name="F:NPOI.OpenXml4Net.OPC.PackagePartName.RFC3986_PCHAR_SUB_DELIMS">
  1754. Reserved characters for sub delimitations.
  1755. </member>
  1756. <!-- Badly formed XML comment ignored for member "F:NPOI.OpenXml4Net.OPC.PackagePartName.RFC3986_PCHAR_UNRESERVED_SUP" -->
  1757. <member name="F:NPOI.OpenXml4Net.OPC.PackagePartName.RFC3986_PCHAR_AUTHORIZED_SUP">
  1758. Authorized reserved characters for pChar.
  1759. </member>
  1760. <member name="F:NPOI.OpenXml4Net.OPC.PackagePartName.isRelationship">
  1761. Flag to know if this part name is from a relationship part name.
  1762. </member>
  1763. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.#ctor(System.Uri,System.Boolean)">
  1764. Constructor. Makes a ValidPartName object from a java.net.URI
  1765. @param uri
  1766. The URI to validate and to transform into ValidPartName.
  1767. @param checkConformance
  1768. Flag to specify if the contructor have to validate the OPC
  1769. conformance. Must be always <code>true</code> except for
  1770. special URI like '/' which is needed for internal use by
  1771. OpenXml4Net but is not valid.
  1772. @throws InvalidFormatException
  1773. Throw if the specified part name is not conform to Open
  1774. Packaging Convention specifications.
  1775. @see java.net.URI
  1776. </member>
  1777. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.#ctor(System.String,System.Boolean)">
  1778. Constructor. Makes a ValidPartName object from a String part name.
  1779. @param partName
  1780. Part name to valid and to create.
  1781. @param checkConformance
  1782. Flag to specify if the contructor have to validate the OPC
  1783. conformance. Must be always <code>true</code> except for
  1784. special URI like '/' which is needed for internal use by
  1785. OpenXml4Net but is not valid.
  1786. @throws InvalidFormatException
  1787. Throw if the specified part name is not conform to Open
  1788. Packaging Convention specifications.
  1789. </member>
  1790. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.IsRelationshipPartURI(System.Uri)">
  1791. Check if the specified part name is a relationship part name.
  1792. @param partUri
  1793. The URI to check.
  1794. @return <code>true</code> if this part name respect the relationship
  1795. part naming convention else <code>false</code>.
  1796. </member>
  1797. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.IsRelationshipPartURI">
  1798. Know if this part name is a relationship part name.
  1799. @return <code>true</code> if this part name respect the relationship
  1800. part naming convention else <code>false</code>.
  1801. </member>
  1802. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.ThrowExceptionIfInvalidPartUri(System.Uri)">
  1803. Throws an exception (of any kind) if the specified part name does not
  1804. follow the Open Packaging Convention specifications naming rules.
  1805. @param partUri
  1806. The part name to check.
  1807. @throws Exception
  1808. Throws if the part name is invalid.
  1809. </member>
  1810. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.ThrowExceptionIfEmptyURI(System.Uri)">
  1811. Throws an exception if the specified URI is empty. [M1.1]
  1812. @param partURI
  1813. Part URI to check.
  1814. @throws InvalidFormatException
  1815. If the specified URI is empty.
  1816. </member>
  1817. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.ThrowExceptionIfPartNameHaveInvalidSegments(System.Uri)">
  1818. Throws an exception if the part name has empty segments. [M1.3]
  1819. Throws an exception if a segment any characters other than pchar
  1820. characters. [M1.6]
  1821. Throws an exception if a segment contain percent-encoded forward slash
  1822. ('/'), or backward slash ('\') characters. [M1.7]
  1823. Throws an exception if a segment contain percent-encoded unreserved
  1824. characters. [M1.8]
  1825. Throws an exception if the specified part name's segments end with a dot
  1826. ('.') character. [M1.9]
  1827. Throws an exception if a segment doesn't include at least one non-dot
  1828. character. [M1.10]
  1829. @param partUri
  1830. The part name to check.
  1831. @throws InvalidFormatException
  1832. if the specified URI contain an empty segments or if one the
  1833. segments contained in the part name, ends with a dot ('.')
  1834. character.
  1835. </member>
  1836. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.CheckPCharCompliance(System.String)">
  1837. Throws an exception if a segment any characters other than pchar
  1838. characters. [M1.6]
  1839. Throws an exception if a segment contain percent-encoded forward slash
  1840. ('/'), or backward slash ('\') characters. [M1.7]
  1841. Throws an exception if a segment contain percent-encoded unreserved
  1842. characters. [M1.8]
  1843. @param segment
  1844. The segment to check
  1845. </member>
  1846. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.ThrowExceptionIfPartNameNotStartsWithForwardSlashChar(System.Uri)">
  1847. Throws an exception if the specified part name doesn't start with a
  1848. forward slash character '/'. [M1.4]
  1849. @param partUri
  1850. The part name to check.
  1851. @throws InvalidFormatException
  1852. If the specified part name doesn't start with a forward slash
  1853. character '/'.
  1854. </member>
  1855. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.ThrowExceptionIfPartNameEndsWithForwardSlashChar(System.Uri)">
  1856. Throws an exception if the specified part name ends with a forwar slash
  1857. character '/'. [M1.5]
  1858. @param partUri
  1859. The part name to check.
  1860. @throws InvalidFormatException
  1861. If the specified part name ends with a forwar slash character
  1862. '/'.
  1863. </member>
  1864. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.ThrowExceptionIfAbsoluteUri(System.Uri)">
  1865. Throws an exception if the specified URI is absolute.
  1866. @param partUri
  1867. The URI to check.
  1868. @throws InvalidFormatException
  1869. Throws if the specified URI is absolute.
  1870. </member>
  1871. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.CompareTo(NPOI.OpenXml4Net.OPC.PackagePartName)">
  1872. Compare two part name following the rule M1.12 :
  1873. Part name equivalence is determined by comparing part names as
  1874. case-insensitive ASCII strings. Packages shall not contain equivalent
  1875. part names and package implementers shall neither create nor recognize
  1876. packages with equivalent part names. [M1.12]
  1877. </member>
  1878. <member name="P:NPOI.OpenXml4Net.OPC.PackagePartName.Extension">
  1879. Retrieves the extension of the part name if any. If there is no extension
  1880. returns an empty String. Example : '/document/content.xml' => 'xml'
  1881. @return The extension of the part name.
  1882. </member>
  1883. <member name="P:NPOI.OpenXml4Net.OPC.PackagePartName.Name">
  1884. Get this part name.
  1885. @return The name of this part name.
  1886. </member>
  1887. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.Equals(System.Object)">
  1888. Part name equivalence is determined by comparing part names as
  1889. case-insensitive ASCII strings. Packages shall not contain equivalent
  1890. part names and package implementers shall neither create nor recognize
  1891. packages with equivalent part names. [M1.12]
  1892. </member>
  1893. <member name="P:NPOI.OpenXml4Net.OPC.PackagePartName.URI">
  1894. Part name property getter.
  1895. @return This part name URI.
  1896. </member>
  1897. <!-- Badly formed XML comment ignored for member "M:NPOI.OpenXml4Net.OPC.PackagePartName.Compare(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.PackagePartName)" -->
  1898. <!-- Badly formed XML comment ignored for member "M:NPOI.OpenXml4Net.OPC.PackagePartName.Compare(System.String,System.String)" -->
  1899. <member name="T:NPOI.OpenXml4Net.OPC.PackageProperties">
  1900. Represents the core properties of an OPC package.
  1901. @author Julien Chable
  1902. @version 1.0
  1903. @see org.apache.poi.OpenXml4Net.opc.OPCPackage
  1904. </member>
  1905. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetCategoryProperty">
  1906. Set the category of the content of this package.
  1907. </member>
  1908. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetCategoryProperty(System.String)">
  1909. Set the category of the content of this package.
  1910. </member>
  1911. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetContentStatusProperty">
  1912. Set the status of the content.
  1913. </member>
  1914. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetContentStatusProperty(System.String)">
  1915. Get the status of the content.
  1916. </member>
  1917. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetContentTypeProperty">
  1918. Get the type of content represented, generally defined by a specific use
  1919. and intended audience.
  1920. </member>
  1921. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetContentTypeProperty(System.String)">
  1922. Set the type of content represented, generally defined by a specific use
  1923. and intended audience.
  1924. </member>
  1925. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetCreatedProperty">
  1926. Get the date of creation of the resource.
  1927. </member>
  1928. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetCreatedProperty(System.String)">
  1929. Set the date of creation of the resource.
  1930. </member>
  1931. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetCreatedProperty(System.Nullable{System.DateTime})">
  1932. Set the date of creation of the resource.
  1933. </member>
  1934. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetCreatorProperty">
  1935. Get the entity primarily responsible for making the content of the
  1936. resource.
  1937. </member>
  1938. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetCreatorProperty(System.String)">
  1939. Set the entity primarily responsible for making the content of the
  1940. resource.
  1941. </member>
  1942. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetDescriptionProperty">
  1943. Get the explanation of the content of the resource.
  1944. </member>
  1945. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetDescriptionProperty(System.String)">
  1946. Set the explanation of the content of the resource.
  1947. </member>
  1948. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetIdentifierProperty">
  1949. Get an unambiguous reference to the resource within a given context.
  1950. </member>
  1951. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetIdentifierProperty(System.String)">
  1952. Set an unambiguous reference to the resource within a given context.
  1953. </member>
  1954. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetKeywordsProperty">
  1955. Get a delimited Set of keywords to support searching and indexing. This
  1956. is typically a list of terms that are not available elsewhere in the
  1957. properties
  1958. </member>
  1959. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetKeywordsProperty(System.String)">
  1960. Set a delimited Set of keywords to support searching and indexing. This
  1961. is typically a list of terms that are not available elsewhere in the
  1962. properties
  1963. </member>
  1964. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetLanguageProperty">
  1965. Get the language of the intellectual content of the resource.
  1966. </member>
  1967. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetLanguageProperty(System.String)">
  1968. Set the language of the intellectual content of the resource.
  1969. </member>
  1970. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetLastModifiedByProperty">
  1971. Get the user who performed the last modification.
  1972. </member>
  1973. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetLastModifiedByProperty(System.String)">
  1974. Set the user who performed the last modification.
  1975. </member>
  1976. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetLastPrintedProperty">
  1977. Get the date and time of the last printing.
  1978. </member>
  1979. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetLastPrintedProperty(System.String)">
  1980. Set the date and time of the last printing.
  1981. </member>
  1982. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetLastPrintedProperty(System.Nullable{System.DateTime})">
  1983. Set the date and time of the last printing.
  1984. </member>
  1985. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetModifiedProperty">
  1986. Get the date on which the resource was changed.
  1987. </member>
  1988. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetModifiedProperty(System.String)">
  1989. Set the date on which the resource was changed.
  1990. </member>
  1991. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetModifiedProperty(System.Nullable{System.DateTime})">
  1992. Set the date on which the resource was changed.
  1993. </member>
  1994. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetRevisionProperty">
  1995. Get the revision number.
  1996. </member>
  1997. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetRevisionProperty(System.String)">
  1998. Set the revision number.
  1999. </member>
  2000. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetSubjectProperty">
  2001. Get the topic of the content of the resource.
  2002. </member>
  2003. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetSubjectProperty(System.String)">
  2004. Set the topic of the content of the resource.
  2005. </member>
  2006. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetTitleProperty">
  2007. Get the name given to the resource.
  2008. </member>
  2009. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetTitleProperty(System.String)">
  2010. Set the name given to the resource.
  2011. </member>
  2012. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetVersionProperty">
  2013. Get the version number.
  2014. </member>
  2015. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetVersionProperty(System.String)">
  2016. Set the version number.
  2017. </member>
  2018. <member name="T:NPOI.OpenXml4Net.OPC.PackageRelationship">
  2019. A part relationship.
  2020. @author Julien Chable
  2021. @version 1.0
  2022. </member>
  2023. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationship.id">
  2024. Relation id.
  2025. </member>
  2026. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationship.container">
  2027. Reference to the package.
  2028. </member>
  2029. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationship.relationshipType">
  2030. Relationship type
  2031. </member>
  2032. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationship.source">
  2033. Part of this relationship source
  2034. </member>
  2035. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationship.targetMode">
  2036. Targeting mode [Internal|External]
  2037. </member>
  2038. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationship.targetUri">
  2039. Target URI
  2040. </member>
  2041. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationship.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart,System.Uri,NPOI.OpenXml4Net.OPC.TargetMode,System.String,System.String)">
  2042. Constructor.
  2043. @param pkg
  2044. @param sourcePart
  2045. @param targetUri
  2046. @param targetMode
  2047. @param relationshipType
  2048. @param id
  2049. </member>
  2050. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationship.Package">
  2051. @return the container
  2052. </member>
  2053. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationship.Id">
  2054. @return the id
  2055. </member>
  2056. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationship.RelationshipType">
  2057. @return the relationshipType
  2058. </member>
  2059. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationship.Source">
  2060. @return the source
  2061. </member>
  2062. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationship.SourceUri">
  2063. @return URL of the source part of this relationship
  2064. </member>
  2065. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationship.TargetMode">
  2066. public URI getSourceUri(){ }
  2067. @return the targetMode
  2068. </member>
  2069. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationship.TargetUri">
  2070. @return the targetUri
  2071. </member>
  2072. <member name="T:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection">
  2073. Represents a collection of PackageRelationship elements that are owned by a
  2074. given PackagePart or the Package.
  2075. @author Julien Chable, CDubettier
  2076. @version 0.1
  2077. </member>
  2078. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.relationshipsByID">
  2079. Package relationships ordered by ID.
  2080. </member>
  2081. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.internalRelationshipsByTargetName">
  2082. A lookup of internal relationships to avoid
  2083. </member>
  2084. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.relationshipPart">
  2085. This relationshipPart.
  2086. </member>
  2087. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.sourcePart">
  2088. Source part.
  2089. </member>
  2090. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.partName">
  2091. This part name.
  2092. </member>
  2093. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.container">
  2094. Reference to the package.
  2095. </member>
  2096. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.nextRelationshipId">
  2097. The ID number of the next rID# to generate, or -1
  2098. if that is still to be determined.
  2099. </member>
  2100. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.#ctor">
  2101. Constructor.
  2102. </member>
  2103. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.#ctor(NPOI.OpenXml4Net.OPC.PackageRelationshipCollection,System.String)">
  2104. Copy constructor.
  2105. This collection will contain only elements from the specified collection
  2106. for which the type is compatible with the specified relationship type
  2107. filter.
  2108. @param coll
  2109. Collection to import.
  2110. @param filter
  2111. Relationship type filter.
  2112. </member>
  2113. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  2114. Constructor.
  2115. </member>
  2116. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  2117. Constructor.
  2118. @throws InvalidFormatException
  2119. Throws if the format of the content part is invalid.
  2120. @throws InvalidOperationException
  2121. Throws if the specified part is a relationship part.
  2122. </member>
  2123. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart)">
  2124. Constructor. Parse the existing package relationship part if one exists.
  2125. @param container
  2126. The parent package.
  2127. @param part
  2128. The part that own this relationships collection. If <b>null</b>
  2129. then this part is considered as the package root.
  2130. @throws InvalidFormatException
  2131. If an error occurs during the parsing of the relatinships
  2132. part fo the specified part.
  2133. </member>
  2134. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.GetRelationshipPartName(NPOI.OpenXml4Net.OPC.PackagePart)">
  2135. Get the relationship part name of the specified part.
  2136. @param part
  2137. The part .
  2138. @return The relationship part name of the specified part. Be careful,
  2139. only the correct name is returned, this method does not check if
  2140. the part really exist in a package !
  2141. @throws InvalidOperationException
  2142. Throws if the specified part is a relationship part.
  2143. </member>
  2144. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.AddRelationship(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  2145. Add the specified relationship to the collection.
  2146. @param relPart
  2147. The relationship to add.
  2148. </member>
  2149. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.AddRelationship(System.Uri,NPOI.OpenXml4Net.OPC.TargetMode,System.String,System.String)">
  2150. Add a relationship to the collection.
  2151. @param targetUri
  2152. Target URI.
  2153. @param targetMode
  2154. The target mode : INTERNAL or EXTERNAL
  2155. @param relationshipType
  2156. Relationship type.
  2157. @param id
  2158. Relationship ID.
  2159. @return The newly created relationship.
  2160. @see PackageAccess
  2161. </member>
  2162. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.RemoveRelationship(System.String)">
  2163. Remove a relationship by its ID.
  2164. @param id
  2165. The relationship ID to Remove.
  2166. </member>
  2167. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.RemoveRelationship(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  2168. Remove a relationship by its reference.
  2169. @param rel
  2170. The relationship to delete.
  2171. </member>
  2172. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.GetRelationship(System.Int32)">
  2173. Retrieves a relationship by its index in the collection.
  2174. @param index
  2175. Must be a value between [0-relationships_count-1]
  2176. </member>
  2177. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.GetRelationshipByID(System.String)">
  2178. Retrieves a package relationship based on its id.
  2179. @param id
  2180. ID of the package relationship to retrieve.
  2181. @return The package relationship identified by the specified id.
  2182. </member>
  2183. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.Size">
  2184. Get the numbe rof relationships in the collection.
  2185. </member>
  2186. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.ParseRelationshipsPart(NPOI.OpenXml4Net.OPC.PackagePart)">
  2187. Parse the relationship part and add all relationship in this collection.
  2188. @param relPart
  2189. The package part to parse.
  2190. @throws InvalidFormatException
  2191. Throws if the relationship part is invalid.
  2192. </member>
  2193. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.GetRelationships(System.String)">
  2194. Retrieves all relations with the specified type.
  2195. @param typeFilter
  2196. Relationship type filter. If <b>null</b> then all
  2197. relationships are returned.
  2198. @return All relationships of the type specified by the filter.
  2199. </member>
  2200. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.GetEnumerator">
  2201. Get this collection's iterator.
  2202. </member>
  2203. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.Iterator(System.String)">
  2204. Get an iterator of a collection with all relationship with the specified
  2205. type.
  2206. @param typeFilter
  2207. Type filter.
  2208. @return An iterator to a collection containing all relationships with the
  2209. specified type contain in this collection.
  2210. </member>
  2211. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.Clear">
  2212. Clear all relationships.
  2213. </member>
  2214. <member name="T:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes">
  2215. Relationship types.
  2216. @author Julien Chable
  2217. @version 0.2
  2218. </member>
  2219. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.CORE_PROPERTIES">
  2220. Core properties relationship type.
  2221. <p>
  2222. The standard specifies a source relations ship for the Core File Properties part as follows:
  2223. <code>http://schemas.openxmlformats.org/officedocument/2006/relationships/metadata/core-properties.</code>
  2224. </p>
  2225. <p>
  2226. Office uses the following source relationship for the Core File Properties part:
  2227. <code>http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties.</code>
  2228. </p>
  2229. See 2.1.33 Part 1 Section 15.2.11.1, Core File Properties Part in [MS-OE376].pdf
  2230. </member>
  2231. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.CORE_PROPERTIES_ECMA376">
  2232. Core properties relationship type as defiend in ECMA 376.
  2233. </member>
  2234. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.DIGITAL_SIGNATURE">
  2235. Digital signature relationship type.
  2236. </member>
  2237. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.DIGITAL_SIGNATURE_CERTIFICATE">
  2238. Digital signature certificate relationship type.
  2239. </member>
  2240. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.DIGITAL_SIGNATURE_ORIGIN">
  2241. Digital signature origin relationship type.
  2242. </member>
  2243. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.THUMBNAIL">
  2244. Thumbnail relationship type.
  2245. </member>
  2246. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.EXTENDED_PROPERTIES">
  2247. Extended properties relationship type.
  2248. </member>
  2249. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.STRICT_EXTENDED_PROPERTIES">
  2250. Extended properties relationship type for strict ooxml.
  2251. </member>
  2252. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.CUSTOM_PROPERTIES">
  2253. Custom properties relationship type.
  2254. </member>
  2255. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.CORE_DOCUMENT">
  2256. Core document relationship type.
  2257. </member>
  2258. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.STRICT_CORE_DOCUMENT">
  2259. Core document relationship type for strict ooxml.
  2260. </member>
  2261. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.CUSTOM_XML">
  2262. Custom XML relationship type.
  2263. </member>
  2264. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.IMAGE_PART">
  2265. Image type.
  2266. </member>
  2267. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.HYPERLINK_PART">
  2268. Hyperlink type.
  2269. </member>
  2270. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.STYLE_PART">
  2271. Style type.
  2272. </member>
  2273. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.EXTERNAL_LINK_PATH">
  2274. External Link to another Document
  2275. </member>
  2276. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.VISIO_CORE_DOCUMENT">
  2277. Visio 2010 VSDX equivalent of package {@link #CORE_DOCUMENT}
  2278. </member>
  2279. <member name="T:NPOI.OpenXml4Net.OPC.PackagingUriHelper">
  2280. Helper for part and pack Uri.
  2281. @author Julien Chable, CDubet, Kim Ung
  2282. @version 0.1
  2283. </member>
  2284. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.packageRootUri">
  2285. Package root Uri.
  2286. </member>
  2287. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.RELATIONSHIP_PART_EXTENSION_NAME">
  2288. Extension name of a relationship part.
  2289. </member>
  2290. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.RELATIONSHIP_PART_SEGMENT_NAME">
  2291. Segment name of a relationship part.
  2292. </member>
  2293. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.PACKAGE_PROPERTIES_SEGMENT_NAME">
  2294. Segment name of the package properties folder.
  2295. </member>
  2296. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.PACKAGE_CORE_PROPERTIES_NAME">
  2297. Core package properties art name.
  2298. </member>
  2299. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.FORWARD_SLASH_CHAR">
  2300. Forward slash Uri separator.
  2301. </member>
  2302. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.FORWARD_SLASH_STRING">
  2303. Forward slash Uri separator.
  2304. </member>
  2305. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.PACKAGE_RELATIONSHIPS_ROOT_URI">
  2306. Package relationships part Uri
  2307. </member>
  2308. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.PACKAGE_RELATIONSHIPS_ROOT_PART_NAME">
  2309. Package relationships part name.
  2310. </member>
  2311. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.CORE_PROPERTIES_URI">
  2312. Core properties part Uri.
  2313. </member>
  2314. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.CORE_PROPERTIES_PART_NAME">
  2315. Core properties partname.
  2316. </member>
  2317. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.PACKAGE_ROOT_URI">
  2318. Root package Uri.
  2319. </member>
  2320. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.PACKAGE_ROOT_PART_NAME">
  2321. Root package part name.
  2322. </member>
  2323. <member name="P:NPOI.OpenXml4Net.OPC.PackagingUriHelper.PackageRootUri">
  2324. Gets the Uri for the package root.
  2325. @return Uri of the package root.
  2326. </member>
  2327. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.IsRelationshipPartURI(System.Uri)">
  2328. Know if the specified Uri is a relationship part name.
  2329. @param partUri
  2330. Uri to check.
  2331. @return <i>true</i> if the Uri <i>false</i>.
  2332. </member>
  2333. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.GetFilename(System.Uri)">
  2334. Get file name from the specified Uri.
  2335. </member>
  2336. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.GetFilenameWithoutExtension(System.Uri)">
  2337. Get the file name without the trailing extension.
  2338. </member>
  2339. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.GetPath(System.Uri)">
  2340. Get the directory path from the specified Uri.
  2341. </member>
  2342. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.Combine(System.Uri,System.Uri)">
  2343. Combine two URIs.
  2344. @param prefix the prefix Uri
  2345. @param suffix the suffix Uri
  2346. @return the Combined Uri
  2347. </member>
  2348. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.Combine(System.String,System.String)">
  2349. Combine a string Uri with a prefix and a suffix.
  2350. </member>
  2351. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.RelativizeUri(System.Uri,System.Uri,System.Boolean)">
  2352. Fully relativize the source part Uri against the target part Uri.
  2353. @param sourceURI
  2354. The source part Uri.
  2355. @param targetURI
  2356. The target part Uri.
  2357. @return A fully relativize part name Uri ('word/media/image1.gif',
  2358. '/word/document.xml' => 'media/image1.gif') else
  2359. <code>null</code>.
  2360. </member>
  2361. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.RelativizeUri(System.Uri,System.Uri)">
  2362. Fully relativize the source part URI against the target part URI.
  2363. @param sourceURI
  2364. The source part URI.
  2365. @param targetURI
  2366. The target part URI.
  2367. @return A fully relativize part name URI ('word/media/image1.gif',
  2368. '/word/document.xml' => 'media/image1.gif') else
  2369. <code>null</code>.
  2370. </member>
  2371. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.ResolvePartUri(System.Uri,System.Uri)">
  2372. Resolve a source uri against a target.
  2373. @param sourcePartUri
  2374. The source Uri.
  2375. @param targetUri
  2376. The target Uri.
  2377. @return The resolved Uri.
  2378. </member>
  2379. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.GetURIFromPath(System.String)">
  2380. Get Uri from a string path.
  2381. </member>
  2382. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.GetSourcePartUriFromRelationshipPartUri(System.Uri)">
  2383. Get the source part Uri from a specified relationships part.
  2384. @param relationshipPartUri
  2385. The relationship part use to retrieve the source part.
  2386. @return The source part Uri from the specified relationships part.
  2387. </member>
  2388. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.CreatePartName(System.Uri)">
  2389. Create an OPC compliant part name by throwing an exception if the Uri is
  2390. not valid.
  2391. @param partUri
  2392. The part name Uri to validate.
  2393. @return A valid part name object, else <code>null</code>.
  2394. @throws InvalidFormatException
  2395. Throws if the specified Uri is not OPC compliant.
  2396. </member>
  2397. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.CreatePartName(System.String)">
  2398. Create an OPC compliant part name.
  2399. @param partName
  2400. The part name to validate.
  2401. @return The correspondant part name if valid, else <code>null</code>.
  2402. @throws InvalidFormatException
  2403. Throws if the specified part name is not OPC compliant.
  2404. @see #CreatePartName(Uri)
  2405. </member>
  2406. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.CreatePartName(System.String,NPOI.OpenXml4Net.OPC.PackagePart)">
  2407. Create an OPC compliant part name by resolving it using a base part.
  2408. @param partName
  2409. The part name to validate.
  2410. @param relativePart
  2411. The relative base part.
  2412. @return The correspondant part name if valid, else <code>null</code>.
  2413. @throws InvalidFormatException
  2414. Throws if the specified part name is not OPC compliant.
  2415. @see #CreatePartName(Uri)
  2416. </member>
  2417. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.CreatePartName(System.Uri,NPOI.OpenXml4Net.OPC.PackagePart)">
  2418. Create an OPC compliant part name by resolving it using a base part.
  2419. @param partName
  2420. The part name Uri to validate.
  2421. @param relativePart
  2422. The relative base part.
  2423. @return The correspondant part name if valid, else <code>null</code>.
  2424. @throws InvalidFormatException
  2425. Throws if the specified part name is not OPC compliant.
  2426. @see #CreatePartName(Uri)
  2427. </member>
  2428. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.IsValidPartName(System.Uri)">
  2429. Validate a part Uri by returning a bool.
  2430. ([M1.1],[M1.3],[M1.4],[M1.5],[M1.6])
  2431. (OPC Specifications 8.1.1 Part names) :
  2432. Part Name Syntax
  2433. The part name grammar is defined as follows:
  2434. <i>part_name = 1*( "/" segment )
  2435. segment = 1*( pchar )</i>
  2436. (pchar is defined in RFC 3986)
  2437. @param partUri
  2438. The Uri to validate.
  2439. @return <b>true</b> if the Uri is valid to the OPC Specifications, else
  2440. <b>false</b>
  2441. @see #CreatePartName(Uri)
  2442. </member>
  2443. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.DecodeURI(System.Uri)">
  2444. Decode a Uri by converting all percent encoded character into a String
  2445. character.
  2446. @param uri
  2447. The Uri to decode.
  2448. @return The specified Uri in a String with converted percent encoded
  2449. characters.
  2450. </member>
  2451. <!-- Badly formed XML comment ignored for member "M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.ToUri(System.String)" -->
  2452. <!-- Badly formed XML comment ignored for member "M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.Encode(System.String)" -->
  2453. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.GetRelationshipPartName(NPOI.OpenXml4Net.OPC.PackagePartName)">
  2454. Build a part name where the relationship should be stored ((ex
  2455. /word/document.xml -> /word/_rels/document.xml.rels)
  2456. @param partName
  2457. Source part Uri
  2458. @return the full path (as Uri) of the relation file
  2459. @throws InvalidOperationException
  2460. Throws if the specified Uri is a relationshp part.
  2461. </member>
  2462. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.AddRelationship(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.TargetMode,System.String)">
  2463. Add a relationship to a part (except relationships part).
  2464. @param targetPartName
  2465. Name of the target part. This one must be relative to the
  2466. source root directory of the part.
  2467. @param targetMode
  2468. Mode [Internal|External].
  2469. @param relationshipType
  2470. Type of relationship.
  2471. @return The newly created and added relationship
  2472. </member>
  2473. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.AddRelationship(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.TargetMode,System.String,System.String)">
  2474. * Add a relationship to a part (except relationships part).
  2475. * Check rule M1.25: The Relationships part shall not have relationships to
  2476. * any other part. Package implementers shall enforce this requirement upon
  2477. * the attempt to create such a relationship and shall treat any such
  2478. * relationship as invalid.
  2479. *
  2480. * @param targetPartName
  2481. * Name of the target part. This one must be relative to the
  2482. * source root directory of the part.
  2483. * @param targetMode
  2484. * Mode [Internal|External].
  2485. * @param relationshipType
  2486. * Type of relationship.
  2487. * @param id
  2488. * Relationship unique id.
  2489. * @return The newly created and added relationship
  2490. *
  2491. * @throws InvalidFormatException
  2492. * If the URI point to a relationship part URI.
  2493. </member>
  2494. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.AddExternalRelationship(System.String,System.String)">
  2495. Adds an external relationship to a part
  2496. (except relationships part).
  2497. The targets of external relationships are not
  2498. subject to the same validity checks that internal
  2499. ones are, as the contents is potentially
  2500. any file, URL or similar.
  2501. @param target External target of the relationship
  2502. @param relationshipType Type of relationship.
  2503. @return The newly created and added relationship
  2504. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#addExternalRelationship(java.lang.String, java.lang.String)
  2505. </member>
  2506. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.AddExternalRelationship(System.String,System.String,System.String)">
  2507. Adds an external relationship to a part
  2508. (except relationships part).
  2509. The targets of external relationships are not
  2510. subject to the same validity checks that internal
  2511. ones are, as the contents is potentially
  2512. any file, URL or similar.
  2513. @param target External target of the relationship
  2514. @param relationshipType Type of relationship.
  2515. @param id Relationship unique id.
  2516. @return The newly created and added relationship
  2517. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#addExternalRelationship(java.lang.String, java.lang.String)
  2518. </member>
  2519. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.ClearRelationships">
  2520. Delete all the relationships attached to this.
  2521. </member>
  2522. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.RemoveRelationship(System.String)">
  2523. Delete the relationship specified by its id.
  2524. @param id
  2525. The ID identified the part to delete.
  2526. </member>
  2527. <member name="P:NPOI.OpenXml4Net.OPC.RelationshipSource.Relationships">
  2528. Retrieve all the relationships attached to this.
  2529. @return This part's relationships.
  2530. @throws OpenXml4NetException
  2531. </member>
  2532. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.GetRelationship(System.String)">
  2533. Retrieves a package relationship from its id.
  2534. @param id
  2535. ID of the package relationship to retrieve.
  2536. @return The package relationship
  2537. </member>
  2538. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.GetRelationshipsByType(System.String)">
  2539. Retrieve all relationships attached to this part which have the specified
  2540. type.
  2541. @param relationshipType
  2542. Relationship type filter.
  2543. @return All relationships from this part that have the specified type.
  2544. @throws InvalidFormatException
  2545. If an error occurs while parsing the part.
  2546. @throws InvalidOperationException
  2547. If the package is open in write only mode.
  2548. </member>
  2549. <member name="P:NPOI.OpenXml4Net.OPC.RelationshipSource.HasRelationships">
  2550. Knows if the part have any relationships.
  2551. @return <b>true</b> if the part have at least one relationship else
  2552. <b>false</b>.
  2553. </member>
  2554. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.IsRelationshipExists(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  2555. Checks if the specified relationship is part of this package part.
  2556. @param rel
  2557. The relationship to check.
  2558. @return <b>true</b> if the specified relationship exists in this part,
  2559. else returns <b>false</b>
  2560. </member>
  2561. <member name="M:NPOI.OpenXml4Net.OPC.StreamHelper.SaveXmlInStream(System.Xml.XmlDocument,System.IO.Stream)">
  2562. Turning the DOM4j object in the specified output stream.
  2563. @param xmlContent
  2564. The XML document.
  2565. @param outStream
  2566. The Stream in which the XML document will be written.
  2567. @return <b>true</b> if the xml is successfully written in the stream,
  2568. else <b>false</b>.
  2569. </member>
  2570. <member name="M:NPOI.OpenXml4Net.OPC.StreamHelper.CopyStream(System.IO.Stream,System.IO.Stream)">
  2571. Copy the input stream into the output stream.
  2572. @param inStream
  2573. The source stream.
  2574. @param outStream
  2575. The destination stream.
  2576. @return <b>true</b> if the operation succeed, else return <b>false</b>.
  2577. </member>
  2578. <member name="T:NPOI.OpenXml4Net.OPC.TargetMode">
  2579. Specifies whether the target of a PackageRelationship is inside or outside a
  2580. Package.
  2581. @author Julien Chable
  2582. @version 1.0
  2583. </member>
  2584. <member name="F:NPOI.OpenXml4Net.OPC.TargetMode.Internal">
  2585. The relationship references a resource that is external to the package.
  2586. </member>
  2587. <member name="F:NPOI.OpenXml4Net.OPC.TargetMode.External">
  2588. The relationship references a part that is inside the package.
  2589. </member>
  2590. <member name="T:NPOI.OpenXml4Net.OPC.ZipPackage">
  2591. Physical zip package.
  2592. @author Julien Chable
  2593. </member>
  2594. <member name="F:NPOI.OpenXml4Net.OPC.ZipPackage.zipArchive">
  2595. Zip archive, as either a file on disk,
  2596. or a stream
  2597. </member>
  2598. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.#ctor">
  2599. Constructor. Creates a new ZipPackage.
  2600. </member>
  2601. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.#ctor(System.IO.Stream,NPOI.OpenXml4Net.OPC.PackageAccess)">
  2602. Constructor. <b>Operation not supported.</b>
  2603. @param in
  2604. Zip input stream to load.
  2605. @param access
  2606. </member>
  2607. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.#ctor(System.String,NPOI.OpenXml4Net.OPC.PackageAccess)">
  2608. Constructor. Opens a Zip based Open XML document from a file.
  2609. @param path
  2610. The path of the file to open or create.
  2611. @param access
  2612. The package access mode.
  2613. @throws InvalidOperationException If the zip file cannot be opened.
  2614. </member>
  2615. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.#ctor(System.IO.FileInfo,NPOI.OpenXml4Net.OPC.PackageAccess)">
  2616. Constructor. Opens a Zip based Open XML document from a File.
  2617. @param file
  2618. The file to open or create.
  2619. @param access
  2620. The package access mode.
  2621. @throws InvalidOperationException If the zip file cannot be opened.
  2622. </member>
  2623. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.#ctor(NPOI.OpenXml4Net.Util.ZipEntrySource,NPOI.OpenXml4Net.OPC.PackageAccess)">
  2624. Constructor. Opens a Zip based Open XML document from
  2625. a custom ZipEntrySource, typically an open archive
  2626. from another system
  2627. @param zipEntry
  2628. Zip data to load.
  2629. @param access
  2630. The package access mode.
  2631. </member>
  2632. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.GetPartsImpl">
  2633. Retrieves the parts from this package. We assume that the package has not
  2634. been yet inspect to retrieve all the parts, this method will open the
  2635. archive and look for all parts contain inside it. If the package part
  2636. list is not empty, it will be emptied.
  2637. @return All parts contain in this package.
  2638. @throws InvalidFormatException if the package is not valid.
  2639. </member>
  2640. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.BuildPartName(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
  2641. Builds a PackagePartName for the given ZipEntry,
  2642. or null if it's the content types / invalid part
  2643. </member>
  2644. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.CreatePartImpl(NPOI.OpenXml4Net.OPC.PackagePartName,System.String,System.Boolean)">
  2645. Create a new MemoryPackagePart from the specified URI and content type
  2646. aram partName The part URI.
  2647. @param contentType
  2648. The part content type.
  2649. @return The newly created zip package part, else <b>null</b>.
  2650. </member>
  2651. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.RemovePartImpl(NPOI.OpenXml4Net.OPC.PackagePartName)">
  2652. Delete a part from the package
  2653. @throws ArgumentException
  2654. Throws if the part URI is nulll or invalid.
  2655. </member>
  2656. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.FlushImpl">
  2657. Flush the package. Do nothing.
  2658. </member>
  2659. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.CloseImpl">
  2660. Close and save the package.
  2661. @see #close()
  2662. </member>
  2663. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.GenerateTempFileName(System.String)">
  2664. Create a unique identifier to be use as a temp file name.
  2665. @return A unique identifier use to be use as a temp file name.
  2666. </member>
  2667. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.RevertImpl">
  2668. Close the package without saving the document. Discard all the changes
  2669. made to this package.
  2670. </member>
  2671. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.GetPartImpl(NPOI.OpenXml4Net.OPC.PackagePartName)">
  2672. Implement the getPart() method to retrieve a part from its URI in the
  2673. current package
  2674. @see #getPart(PackageRelationship)
  2675. </member>
  2676. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.SaveImpl(System.IO.Stream)">
  2677. Save this package into the specified stream
  2678. @param outputStream
  2679. The stream use to save this package.
  2680. @see #save(OutputStream)
  2681. </member>
  2682. <member name="P:NPOI.OpenXml4Net.OPC.ZipPackage.ZipArchive">
  2683. Get the zip archive
  2684. @return The zip archive.
  2685. </member>
  2686. <member name="T:NPOI.OpenXml4Net.OPC.ZipPackagePart">
  2687. Zip implementation of a PackagePart.
  2688. @author Julien Chable
  2689. @version 1.0
  2690. @see PackagePart
  2691. </member>
  2692. <member name="F:NPOI.OpenXml4Net.OPC.ZipPackagePart.zipEntry">
  2693. The zip entry corresponding to this part.
  2694. </member>
  2695. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackagePart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName,System.String)">
  2696. Constructor.
  2697. @param container
  2698. The container package.
  2699. @param partName
  2700. Part name.
  2701. @param contentType
  2702. Content type.
  2703. @throws InvalidFormatException
  2704. Throws if the content of this part invalid.
  2705. </member>
  2706. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackagePart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,ICSharpCode.SharpZipLib.Zip.ZipEntry,NPOI.OpenXml4Net.OPC.PackagePartName,System.String)">
  2707. Constructor.
  2708. @param container
  2709. The container package.
  2710. @param zipEntry
  2711. The zip entry corresponding to this part.
  2712. @param partName
  2713. The part name.
  2714. @param contentType
  2715. Content type.
  2716. @throws InvalidFormatException
  2717. Throws if the content of this part is invalid.
  2718. </member>
  2719. <member name="P:NPOI.OpenXml4Net.OPC.ZipPackagePart.ZipArchive">
  2720. Get the zip entry of this part.
  2721. @return The zip entry in the zip structure coresponding to this part.
  2722. </member>
  2723. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackagePart.GetInputStreamImpl">
  2724. Implementation of the getInputStream() which return the inputStream of
  2725. this part zip entry.
  2726. @return Input stream of this part zip entry.
  2727. </member>
  2728. <member name="T:NPOI.OpenXml4Net.Util.ZipEntrySource">
  2729. An Interface to make getting the different bits
  2730. of a Zip File easy.
  2731. Allows you to get at the ZipEntries, without
  2732. needing to worry about ZipFile vs ZipInputStream
  2733. being annoyingly very different.
  2734. </member>
  2735. <member name="P:NPOI.OpenXml4Net.Util.ZipEntrySource.Entries">
  2736. Returns an Enumeration of all the Entries
  2737. </member>
  2738. <member name="M:NPOI.OpenXml4Net.Util.ZipEntrySource.GetInputStream(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
  2739. Returns an InputStream of the decompressed
  2740. data that makes up the entry
  2741. </member>
  2742. <member name="M:NPOI.OpenXml4Net.Util.ZipEntrySource.Close">
  2743. Indicates we are done with reading, and
  2744. resources may be freed
  2745. </member>
  2746. <member name="P:NPOI.OpenXml4Net.Util.ZipEntrySource.IsClosed">
  2747. Has close been called already?
  2748. </member>
  2749. <member name="T:NPOI.OpenXml4Net.Util.ZipFileZipEntrySource">
  2750. A ZipEntrySource wrapper around a ZipFile.
  2751. Should be as low in terms of memory as a
  2752. normal ZipFile implementation is.
  2753. </member>
  2754. <member name="T:NPOI.OpenXml4Net.Util.ZipInputStreamZipEntrySource">
  2755. Provides a way to get at all the ZipEntries
  2756. from a ZipInputStream, as many times as required.
  2757. Allows a ZipInputStream to be treated much like
  2758. a ZipFile, for a price in terms of memory.
  2759. Be sure to call {@link #close()} as soon as you're
  2760. done, to free up that memory!
  2761. </member>
  2762. <member name="M:NPOI.OpenXml4Net.Util.ZipInputStreamZipEntrySource.#ctor(ICSharpCode.SharpZipLib.Zip.ZipInputStream)">
  2763. Reads all the entries from the ZipInputStream
  2764. into memory, and closes the source stream.
  2765. We'll then eat lots of memory, but be able to
  2766. work with the entries at-will.
  2767. </member>
  2768. <member name="T:NPOI.OpenXml4Net.Util.ZipInputStreamZipEntrySource.EntryEnumerator">
  2769. Why oh why oh why are Iterator and Enumeration
  2770. still not compatible?
  2771. </member>
  2772. <member name="T:NPOI.OpenXml4Net.Util.ZipInputStreamZipEntrySource.FakeZipEntry">
  2773. So we can close the real zip entry and still
  2774. effectively work with it.
  2775. Holds the (decompressed!) data in memory, so
  2776. close this as soon as you can!
  2777. </member>
  2778. <member name="M:NPOI.OpenXml4Net.Util.ZipSecureFile.SetMinInflateRatio(System.Double)">
  2779. Sets the ratio between de- and inflated bytes to detect zipbomb.
  2780. It defaults to 1% (= 0.01d), i.e. when the compression is better than
  2781. 1% for any given read package part, the parsing will fail indicating a
  2782. Zip-Bomb.
  2783. @param ratio the ratio between de- and inflated bytes to detect zipbomb
  2784. </member>
  2785. <member name="M:NPOI.OpenXml4Net.Util.ZipSecureFile.GetMinInflateRatio">
  2786. Returns the current minimum compression rate that is used.
  2787. See setMinInflateRatio() for details.
  2788. @return The min accepted compression-ratio.
  2789. </member>
  2790. <member name="M:NPOI.OpenXml4Net.Util.ZipSecureFile.SetMaxEntrySize(System.Int64)">
  2791. Sets the maximum file size of a single zip entry. It defaults to 4GB,
  2792. i.e. the 32-bit zip format maximum.
  2793. This can be used to limit memory consumption and protect against
  2794. security vulnerabilities when documents are provided by users.
  2795. @param maxEntrySize the max. file size of a single zip entry
  2796. </member>
  2797. <member name="M:NPOI.OpenXml4Net.Util.ZipSecureFile.GetMaxEntrySize">
  2798. Returns the current maximum allowed uncompressed file size.
  2799. See setMaxEntrySize() for details.
  2800. @return The max accepted uncompressed file size.
  2801. </member>
  2802. <!-- Badly formed XML comment ignored for member "M:NPOI.OpenXml4Net.Util.ZipSecureFile.GetInputStream(ICSharpCode.SharpZipLib.Zip.ZipEntry)" -->
  2803. <member name="T:NPOI.Openxml4Net.Exceptions.NotOfficeXmlFileException">
  2804. This exception is thrown when we try to open a file that doesn't
  2805. seem to actually be an OOXML (Office Open XML) file After all
  2806. </member>
  2807. <member name="T:NPOI.Openxml4Net.Exceptions.ODFNotOfficeXmlFileException">
  2808. This exception is thrown when we are given an ODF-based file
  2809. (eg OpenOffice .ods) instead of an actually OOXML (Office Open XML) file
  2810. </member>
  2811. <member name="T:NPOI.Openxml4Net.Exceptions.OLE2NotOfficeXmlFileException">
  2812. This exception is thrown when we are given an OLE2-based file
  2813. (eg Excel .xls) instead of an actually OOXML (Office Open XML) file
  2814. </member>
  2815. <member name="F:NPOI.Util.XMLConstants.NULL_NS_URI">
  2816. <p>Namespace URI to use to represent that there is no Namespace.</p>
  2817. <p>Defined by the Namespace specification to be "".</p>
  2818. @see <a href="http://www.w3.org/TR/REC-xml-names/#defaulting">
  2819. Namespaces in XML, 5.2 Namespace Defaulting</a>
  2820. </member>
  2821. <member name="F:NPOI.Util.XMLConstants.DEFAULT_NS_PREFIX">
  2822. <p>Prefix to use to represent the default XML Namespace.</p>
  2823. <p>Defined by the XML specification to be "".</p>
  2824. @see <a
  2825. href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
  2826. Namespaces in XML, 3. Qualified Names</a>
  2827. </member>
  2828. <member name="F:NPOI.Util.XMLConstants.XML_NS_URI">
  2829. <p>The official XML Namespace name URI.</p>
  2830. <p>Defined by the XML specification to be
  2831. "{@code http://www.w3.org/XML/1998/namespace}".</p>
  2832. @see <a
  2833. href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
  2834. Namespaces in XML, 3. Qualified Names</a>
  2835. </member>
  2836. <!-- Badly formed XML comment ignored for member "F:NPOI.Util.XMLConstants.XML_NS_PREFIX" -->
  2837. <member name="F:NPOI.Util.XMLConstants.XMLNS_ATTRIBUTE_NS_URI">
  2838. <p>The official XML attribute used for specifying XML Namespace
  2839. declarations, {@link #XMLNS_ATTRIBUTE
  2840. XMLConstants.XMLNS_ATTRIBUTE}, Namespace name URI.</p>
  2841. <p>Defined by the XML specification to be
  2842. "{@code http://www.w3.org/2000/xmlns/}".</p>
  2843. @see <a
  2844. href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
  2845. Namespaces in XML, 3. Qualified Names</a>
  2846. @see <a
  2847. href="http://www.w3.org/XML/xml-names-19990114-errata">
  2848. Namespaces in XML Errata</a>
  2849. </member>
  2850. <member name="F:NPOI.Util.XMLConstants.XMLNS_ATTRIBUTE">
  2851. <p>The official XML attribute used for specifying XML Namespace
  2852. declarations.</p>
  2853. <p>It is <strong><em>NOT</em></strong> valid to use as a
  2854. prefix. Defined by the XML specification to be
  2855. "{@code xmlns}".</p>
  2856. @see <a
  2857. href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
  2858. Namespaces in XML, 3. Qualified Names</a>
  2859. </member>
  2860. <!-- Badly formed XML comment ignored for member "F:NPOI.Util.XMLConstants.W3C_XML_SCHEMA_NS_URI" -->
  2861. <member name="F:NPOI.Util.XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI">
  2862. <p>W3C XML Schema Instance Namespace URI.</p>
  2863. <p>Defined to be "{@code http://www.w3.org/2001/XMLSchema-instance}".</p>
  2864. @see <a href=
  2865. "http://www.w3.org/TR/xmlschema-1/#Instance_Document_Constructions">
  2866. XML Schema Part 1:
  2867. Structures, 2.6 Schema-Related Markup in Documents Being Validated</a>
  2868. </member>
  2869. <member name="F:NPOI.Util.XMLConstants.W3C_XPATH_DATATYPE_NS_URI">
  2870. <p>W3C XPath Datatype Namespace URI.</p>
  2871. <p>Defined to be "{@code http://www.w3.org/2003/11/xpath-datatypes}".</p>
  2872. @see <a href="http://www.w3.org/TR/xpath-datamodel">XQuery 1.0 and XPath 2.0 Data Model</a>
  2873. </member>
  2874. <!-- Badly formed XML comment ignored for member "F:NPOI.Util.XMLConstants.XML_DTD_NS_URI" -->
  2875. <member name="F:NPOI.Util.XMLConstants.RELAXNG_NS_URI">
  2876. <p>RELAX NG Namespace URI.</p>
  2877. <p>Defined to be "{@code http://relaxng.org/ns/structure/1.0}".</p>
  2878. @see <a href="http://relaxng.org/spec-20011203.html">RELAX NG Specification</a>
  2879. </member>
  2880. </members>
  2881. </doc>