NPOI.OpenXml4Net.xml 158 KB

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