NPOI.OpenXml4Net.XML 159 KB

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