革博士V2程序
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.

3021 строка
177 KiB

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>System.IO.Packaging</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.IO.Packaging.CompressionOption">
  8. <summary>
  9. This class is used to control Compression for package parts.
  10. </summary>
  11. </member>
  12. <member name="F:System.IO.Packaging.CompressionOption.NotCompressed">
  13. <summary>
  14. Compression is turned off in this mode.
  15. </summary>
  16. </member>
  17. <member name="F:System.IO.Packaging.CompressionOption.Normal">
  18. <summary>
  19. Compression is optimized for a reasonable compromise between size and performance.
  20. </summary>
  21. </member>
  22. <member name="F:System.IO.Packaging.CompressionOption.Maximum">
  23. <summary>
  24. Compression is optimized for size.
  25. </summary>
  26. </member>
  27. <member name="F:System.IO.Packaging.CompressionOption.Fast">
  28. <summary>
  29. Compression is optimized for performance.
  30. </summary>
  31. </member>
  32. <member name="F:System.IO.Packaging.CompressionOption.SuperFast">
  33. <summary>
  34. Compression is optimized for super performance.
  35. </summary>
  36. </member>
  37. <member name="T:System.IO.Packaging.ContentType">
  38. <summary>
  39. Content Type class
  40. </summary>
  41. </member>
  42. <member name="M:System.IO.Packaging.ContentType.#ctor(System.String)">
  43. <summary>
  44. This constructor creates a ContentType object that represents
  45. the content-type string. At construction time we validate the
  46. string as per the grammar specified in RFC 2616.
  47. Note: We allow empty strings as valid input. Empty string should
  48. we used more as an indication of an absent/unknown ContentType.
  49. </summary>
  50. <param name="contentType">content-type</param>
  51. <exception cref="T:System.ArgumentNullException">If the contentType parameter is null</exception>
  52. <exception cref="T:System.ArgumentException">If the contentType string has leading or
  53. trailing Linear White Spaces(LWS) characters</exception>
  54. <exception cref="T:System.ArgumentException">If the contentType string invalid CR-LF characters</exception>
  55. </member>
  56. <member name="P:System.IO.Packaging.ContentType.TypeComponent">
  57. <summary>
  58. TypeComponent of the Content Type
  59. If the content type is "text/xml". This property will return "text"
  60. </summary>
  61. </member>
  62. <member name="P:System.IO.Packaging.ContentType.SubTypeComponent">
  63. <summary>
  64. SubType component
  65. If the content type is "text/xml". This property will return "xml"
  66. </summary>
  67. </member>
  68. <member name="P:System.IO.Packaging.ContentType.ParameterValuePairs">
  69. <summary>
  70. Enumerator which iterates over the Parameter and Value pairs which are stored
  71. in a dictionary. We hand out just the enumerator in order to make this property
  72. ReadOnly
  73. Consider following Content type -
  74. type/subtype ; param1=value1 ; param2=value2 ; param3="value3"
  75. This will return an enumerator over a dictionary of the parameter/value pairs.
  76. </summary>
  77. </member>
  78. <member name="M:System.IO.Packaging.ContentType.AreTypeAndSubTypeEqual(System.IO.Packaging.ContentType)">
  79. <summary>
  80. This method does a strong comparison of the content types, as parameters are not allowed.
  81. We only compare the type and subType values in an ASCII case-insensitive manner.
  82. Parameters are not allowed to be present on any of the content type operands.
  83. </summary>
  84. <param name="contentType">Content type to be compared with</param>
  85. <returns></returns>
  86. </member>
  87. <member name="M:System.IO.Packaging.ContentType.AreTypeAndSubTypeEqual(System.IO.Packaging.ContentType,System.Boolean)">
  88. <summary>
  89. This method does a weak comparison of the content types. We only compare the
  90. type and subType values in an ASCII case-insensitive manner.
  91. Parameter and value pairs are not used for the comparison.
  92. If you wish to compare the parameters too, then you must get the ParameterValuePairs from
  93. both the ContentType objects and compare each parameter entry.
  94. The allowParameterValuePairs parameter is used to indicate whether the
  95. comparison is tolerant to parameters being present or no.
  96. </summary>
  97. <param name="contentType">Content type to be compared with</param>
  98. <param name="allowParameterValuePairs">If true, allows the presence of parameter value pairs.
  99. If false, parameter/value pairs cannot be present in the content type string.
  100. In either case, the parameter value pair is not used for the comparison.</param>
  101. <returns></returns>
  102. </member>
  103. <member name="M:System.IO.Packaging.ContentType.ToString">
  104. <summary>
  105. ToString - outputs a normalized form of the content type string
  106. </summary>
  107. <returns></returns>
  108. </member>
  109. <member name="M:System.IO.Packaging.ContentType.ValidateCarriageReturns(System.String)">
  110. <summary>
  111. This method validates if the content type string has
  112. valid CR-LF characters. Specifically we test if '\r' is
  113. accompanied by a '\n' in the string, else its an error.
  114. </summary>
  115. <param name="contentType"></param>
  116. </member>
  117. <member name="M:System.IO.Packaging.ContentType.ParseTypeAndSubType(System.String)">
  118. <summary>
  119. Parses the type and subType tokens from the string.
  120. Also verifies if the Tokens are valid as per the grammar.
  121. </summary>
  122. <param name="typeAndSubType">substring that has the type and subType of the content type</param>
  123. <exception cref="T:System.ArgumentException">If the typeAndSubType parameter does not have the "/" character</exception>
  124. </member>
  125. <member name="M:System.IO.Packaging.ContentType.ParseParameterAndValue(System.String)">
  126. <summary>
  127. Parse the individual parameter=value strings
  128. </summary>
  129. <param name="parameterAndValue">This string has the parameter and value pair of the form
  130. parameter=value</param>
  131. <exception cref="T:System.ArgumentException">If the string does not have the required "="</exception>
  132. </member>
  133. <member name="M:System.IO.Packaging.ContentType.GetLengthOfParameterValue(System.String,System.Int32)">
  134. <summary>
  135. This method returns the length of the first parameter value in the input string.
  136. </summary>
  137. <param name="s"></param>
  138. <param name="startIndex">Starting index for parsing</param>
  139. <returns></returns>
  140. </member>
  141. <member name="M:System.IO.Packaging.ContentType.ValidateToken(System.String)">
  142. <summary>
  143. Validating the given token
  144. The following checks are being made -
  145. 1. If all the characters in the token are either ASCII letter or digit.
  146. 2. If all the characters in the token are either from the remaining allowed cha----ter set.
  147. </summary>
  148. <param name="token">string token</param>
  149. <returns>validated string token</returns>
  150. <exception cref="T:System.ArgumentException">If the token is Empty</exception>
  151. </member>
  152. <member name="M:System.IO.Packaging.ContentType.ValidateQuotedStringOrToken(System.String)">
  153. <summary>
  154. Validating if the value of a parameter is either a valid token or a
  155. valid quoted string
  156. </summary>
  157. <param name="parameterValue">parameter value string</param>
  158. <returns>validate parameter value string</returns>
  159. <exception cref="T:System.ArgumentException">If the parameter value is empty</exception>
  160. </member>
  161. <member name="M:System.IO.Packaging.ContentType.ValidateQuotedText(System.String)">
  162. <summary>
  163. This method validates if the text in the quoted string
  164. </summary>
  165. <param name="quotedText"></param>
  166. </member>
  167. <member name="M:System.IO.Packaging.ContentType.IsAllowedCharacter(System.Char)">
  168. <summary>
  169. Returns true if the input character is an allowed character
  170. Returns false if the input cha----ter is not an allowed character
  171. </summary>
  172. <param name="character">input character</param>
  173. <returns></returns>
  174. </member>
  175. <member name="M:System.IO.Packaging.ContentType.IsAsciiLetterOrDigit(System.Char)">
  176. <summary>
  177. Returns true if the input character is an ASCII digit or letter
  178. Returns false if the input character is not an ASCII digit or letter
  179. </summary>
  180. <param name="character">input character</param>
  181. <returns></returns>
  182. </member>
  183. <member name="M:System.IO.Packaging.ContentType.IsAsciiLetter(System.Char)">
  184. <summary>
  185. Returns true if the input character is an ASCII letter
  186. Returns false if the input character is not an ASCII letter
  187. </summary>
  188. <param name="character">input character</param>
  189. <returns></returns>
  190. </member>
  191. <member name="M:System.IO.Packaging.ContentType.IsLinearWhiteSpaceChar(System.Char)">
  192. <summary>
  193. Returns true if the input character is one of the Linear White Space characters -
  194. ' ', '\t', '\n', '\r'
  195. Returns false if the input character is none of the above
  196. </summary>
  197. <param name="ch">input character</param>
  198. <returns></returns>
  199. </member>
  200. <member name="M:System.IO.Packaging.ContentType.EnsureParameterDictionary">
  201. <summary>
  202. Lazy initialization for the ParameterDictionary
  203. </summary>
  204. </member>
  205. <member name="T:System.IO.Packaging.EncryptionOption">
  206. <summary>
  207. This class is used to control Encryption RM for package parts.
  208. </summary>
  209. </member>
  210. <member name="F:System.IO.Packaging.EncryptionOption.None">
  211. <summary>
  212. Encryption is turned off in this mode. This is not supported.
  213. </summary>
  214. </member>
  215. <member name="F:System.IO.Packaging.EncryptionOption.RightsManagement">
  216. <summary>
  217. RightsManagement is the only supported option right now.
  218. </summary>
  219. </member>
  220. <member name="T:System.IO.Packaging.IgnoreFlushAndCloseStream">
  221. <summary>
  222. This class ignores all calls to Flush() and Close() methods
  223. depending on whether the IgnoreFlushAndClose property is set to true
  224. or false. This has been created for performance improvements for the
  225. ZipPackage.
  226. </summary>
  227. </member>
  228. <member name="M:System.IO.Packaging.IgnoreFlushAndCloseStream.#ctor(System.IO.Stream)">
  229. <summary>
  230. Constructor
  231. </summary>
  232. <param name="stream"></param>
  233. </member>
  234. <member name="P:System.IO.Packaging.IgnoreFlushAndCloseStream.CanRead">
  235. <summary>
  236. Member of the abstract Stream class
  237. </summary>
  238. <value>Bool, true if the stream can be read from, else false</value>
  239. </member>
  240. <member name="P:System.IO.Packaging.IgnoreFlushAndCloseStream.CanSeek">
  241. <summary>
  242. Member of the abstract Stream class
  243. </summary>
  244. <value>Bool, true if the stream can be seeked, else false</value>
  245. </member>
  246. <member name="P:System.IO.Packaging.IgnoreFlushAndCloseStream.CanWrite">
  247. <summary>
  248. Member of the abstract Stream class
  249. </summary>
  250. <value>Bool, true if the stream can be written to, else false</value>
  251. </member>
  252. <member name="P:System.IO.Packaging.IgnoreFlushAndCloseStream.Length">
  253. <summary>
  254. Member of the abstract Stream class
  255. </summary>
  256. <value>Long value indicating the length of the stream</value>
  257. </member>
  258. <member name="P:System.IO.Packaging.IgnoreFlushAndCloseStream.Position">
  259. <summary>
  260. Member of the abstract Stream class
  261. </summary>
  262. <value>Long value indicating the current position in the stream</value>
  263. </member>
  264. <member name="M:System.IO.Packaging.IgnoreFlushAndCloseStream.Seek(System.Int64,System.IO.SeekOrigin)">
  265. <summary>
  266. Member of the abstract Stream class
  267. </summary>
  268. <param name="offset">only zero is supported</param>
  269. <param name="origin">only SeekOrigin.Begin is supported</param>
  270. <returns>zero</returns>
  271. </member>
  272. <member name="M:System.IO.Packaging.IgnoreFlushAndCloseStream.SetLength(System.Int64)">
  273. <summary>
  274. Member of the abstract Stream class
  275. </summary>
  276. <param name="newLength"></param>
  277. </member>
  278. <member name="M:System.IO.Packaging.IgnoreFlushAndCloseStream.Read(System.Byte[],System.Int32,System.Int32)">
  279. <summary>
  280. Member of the abstract Stream class
  281. </summary>
  282. <param name="buffer"></param>
  283. <param name="offset"></param>
  284. <param name="count"></param>
  285. <returns></returns>
  286. <remarks>
  287. The standard Stream.Read semantics, and in particular the restoration of the current
  288. position in case of an exception, is implemented by the underlying stream.
  289. </remarks>
  290. </member>
  291. <member name="M:System.IO.Packaging.IgnoreFlushAndCloseStream.Write(System.Byte[],System.Int32,System.Int32)">
  292. <summary>
  293. Member of the abstract Stream class
  294. </summary>
  295. <param name="buf"></param>
  296. <param name="offset"></param>
  297. <param name="count"></param>
  298. </member>
  299. <member name="M:System.IO.Packaging.IgnoreFlushAndCloseStream.Flush">
  300. <summary>
  301. Member of the abstract Stream class
  302. </summary>
  303. </member>
  304. <member name="M:System.IO.Packaging.IgnoreFlushAndCloseStream.Dispose(System.Boolean)">
  305. <summary>
  306. Dispose(bool)
  307. </summary>
  308. <param name="disposing"></param>
  309. </member>
  310. <member name="T:System.IO.Packaging.InternalRelationshipCollection">
  311. <summary>
  312. Collection of all the relationships corresponding to a given source PackagePart
  313. </summary>
  314. </member>
  315. <member name="M:System.IO.Packaging.InternalRelationshipCollection.System#Collections#IEnumerable#GetEnumerator">
  316. <summary>
  317. Returns an enumerator over all the relationships for a Package or a PackagePart
  318. </summary>
  319. <returns></returns>
  320. </member>
  321. <member name="M:System.IO.Packaging.InternalRelationshipCollection.GetEnumerator">
  322. <summary>
  323. Returns an enumerator over all the relationships for a Package or a PackagePart
  324. </summary>
  325. <returns></returns>
  326. </member>
  327. <member name="M:System.IO.Packaging.InternalRelationshipCollection.#ctor(System.IO.Packaging.PackagePart)">
  328. <summary>
  329. Constructor
  330. </summary>
  331. <remarks>For use by PackagePart</remarks>
  332. </member>
  333. <member name="M:System.IO.Packaging.InternalRelationshipCollection.#ctor(System.IO.Packaging.Package)">
  334. <summary>
  335. Constructor
  336. </summary>
  337. <remarks>For use by Package</remarks>
  338. </member>
  339. <member name="M:System.IO.Packaging.InternalRelationshipCollection.Add(System.Uri,System.IO.Packaging.TargetMode,System.String,System.String)">
  340. <summary>
  341. Add new relationship
  342. </summary>
  343. <param name="targetUri">target</param>
  344. <param name="targetMode">Enumeration indicating the base uri for the target uri</param>
  345. <param name="relationshipType">relationship type that uniquely defines the role of the relationship</param>
  346. <param name="id">String that conforms to the xsd:ID datatype. Unique across the source's relationships.
  347. Null OK (ID will be generated).</param>
  348. </member>
  349. <member name="M:System.IO.Packaging.InternalRelationshipCollection.GetRelationship(System.String)">
  350. <summary>
  351. Return the relationship whose id is 'id', and null if not found.
  352. </summary>
  353. </member>
  354. <member name="M:System.IO.Packaging.InternalRelationshipCollection.Delete(System.String)">
  355. <summary>
  356. Delete relationship with ID 'id'
  357. </summary>
  358. <param name="id">ID of the relationship to remove</param>
  359. </member>
  360. <member name="M:System.IO.Packaging.InternalRelationshipCollection.Clear">
  361. <summary>
  362. Clear all the relationships in this collection
  363. Today it is only used when the entire relationship part is being deleted
  364. </summary>
  365. </member>
  366. <member name="M:System.IO.Packaging.InternalRelationshipCollection.Flush">
  367. <summary>
  368. Flush to stream (destructive)
  369. </summary>
  370. <remarks>
  371. Flush part.
  372. </remarks>
  373. </member>
  374. <member name="M:System.IO.Packaging.InternalRelationshipCollection.#ctor(System.IO.Packaging.Package,System.IO.Packaging.PackagePart)">
  375. <summary>
  376. Constructor
  377. </summary>
  378. <param name="package">package</param>
  379. <param name="part">part will be null if package is the source of the relationships</param>
  380. <remarks>Shared constructor</remarks>
  381. </member>
  382. <member name="M:System.IO.Packaging.InternalRelationshipCollection.GetRelationshipPartUri(System.IO.Packaging.PackagePart)">
  383. <summary>
  384. Returns the associated RelationshipPart for this part
  385. </summary>
  386. <param name="part">may be null</param>
  387. <returns>name of relationship part for the given part</returns>
  388. </member>
  389. <member name="M:System.IO.Packaging.InternalRelationshipCollection.ParseRelationshipPart(System.IO.Packaging.PackagePart)">
  390. <summary>
  391. Parse PackageRelationship Stream
  392. </summary>
  393. <param name="part">relationship part</param>
  394. <exception cref="T:System.Xml.XmlException">Thrown if XML is malformed</exception>
  395. </member>
  396. <member name="M:System.IO.Packaging.InternalRelationshipCollection.Add(System.Uri,System.IO.Packaging.TargetMode,System.String,System.String,System.Boolean)">
  397. <summary>
  398. Add new relationship to the Collection
  399. </summary>
  400. <param name="targetUri">target</param>
  401. <param name="targetMode">Enumeration indicating the base uri for the target uri</param>
  402. <param name="relationshipType">relationship type that uniquely defines the role of the relationship</param>
  403. <param name="id">String that conforms to the xsd:ID datatype. Unique across the source's relationships.
  404. Null OK (ID will be generated).</param>
  405. <param name="parsing">Indicates whether the add call is made while parsing existing relationships
  406. from a relationship part, or we are adding a new relationship</param>
  407. </member>
  408. <member name="M:System.IO.Packaging.InternalRelationshipCollection.WriteRelationshipPart(System.IO.Packaging.PackagePart)">
  409. <summary>
  410. Write PackageRelationship Stream
  411. </summary>
  412. <param name="part">part to persist to</param>
  413. </member>
  414. <member name="M:System.IO.Packaging.InternalRelationshipCollection.WriteRelationshipsAsXml(System.Xml.XmlWriter,System.Collections.Generic.IEnumerable{System.IO.Packaging.PackageRelationship},System.Boolean)">
  415. <summary>
  416. Write one Relationship element for each member of relationships.
  417. This method is used by XmlDigitalSignatureProcessor code as well
  418. </summary>
  419. </member>
  420. <member name="M:System.IO.Packaging.InternalRelationshipCollection.EnsureRelationshipPart">
  421. <summary>
  422. Ensures that the PackageRelationship PackagePart has been created - lazy init
  423. </summary>
  424. <remarks>
  425. </remarks>
  426. </member>
  427. <member name="M:System.IO.Packaging.InternalRelationshipCollection.GetResolvedTargetUri(System.Uri,System.IO.Packaging.TargetMode)">
  428. <summary>
  429. Resolves the target uri in the relationship against the source part or the
  430. package root. This resolved Uri is then used by the Add method to figure
  431. out if a relationship is being created to another relationship part.
  432. </summary>
  433. <param name="target">PackageRelationship target uri</param>
  434. <param name="targetMode"> Enum value specifying the interpretation of the base uri
  435. for the relationship target uri</param>
  436. <returns>Resolved Uri</returns>
  437. </member>
  438. <member name="T:System.IO.Packaging.OrderedDictionary`2">
  439. <summary>
  440. A collection that ensures uniqueness among a list of elements while maintaining the order in which the elements were added.
  441. This is similar to <see cref="T:System.IO.Packaging.OrderedDictionary`2"/>, but the items will not be sorted by a comparer but rather retain the
  442. order in which they were added while still retaining good lookup, insertion, and removal.
  443. </summary>
  444. </member>
  445. <member name="T:System.IO.Packaging.Package">
  446. <summary>
  447. Abstract Base class for the Package.
  448. This is a part of the Packaging Layer APIs
  449. </summary>
  450. </member>
  451. <member name="M:System.IO.Packaging.Package.#ctor(System.IO.FileAccess)">
  452. <summary>
  453. Protected constructor for the abstract Base class.
  454. This is the current contract between the subclass and the base class
  455. If we decide some registration mechanism then this might change
  456. </summary>
  457. <param name="openFileAccess"></param>
  458. <exception cref="T:System.ArgumentOutOfRangeException">If FileAccess enumeration does not have one of the valid values</exception>
  459. </member>
  460. <member name="P:System.IO.Packaging.Package.FileOpenAccess">
  461. <summary>
  462. Gets the FileAccess with which the package was opened. This is a read only property.
  463. This property gets set when the package is opened.
  464. </summary>
  465. <value>FileAccess</value>
  466. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  467. </member>
  468. <member name="P:System.IO.Packaging.Package.PackageProperties">
  469. <summary>
  470. The package properties are a subset of the standard OLE property sets
  471. SummaryInformation and DocumentSummaryInformation, and include such properties
  472. as Title and Subject.
  473. </summary>
  474. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  475. </member>
  476. <member name="M:System.IO.Packaging.Package.Open(System.String)">
  477. <summary>
  478. Opens a package at the specified Path. This method calls the overload which accepts all the parameters
  479. with the following defaults -
  480. FileMode - FileMode.OpenOrCreate,
  481. FileAccess - FileAccess.ReadWrite
  482. FileShare - FileShare.None
  483. </summary>
  484. <param name="path">Path to the package</param>
  485. <returns>Package</returns>
  486. <exception cref="T:System.ArgumentNullException">If path parameter is null</exception>
  487. </member>
  488. <member name="M:System.IO.Packaging.Package.Open(System.String,System.IO.FileMode)">
  489. <summary>
  490. Opens a package at the specified Path in the given mode. This method calls the overload which
  491. accepts all the parameters with the following defaults -
  492. FileAccess - FileAccess.ReadWrite
  493. FileShare - FileShare.None
  494. </summary>
  495. <param name="path">Path to the package</param>
  496. <param name="packageMode">FileMode in which the package should be opened</param>
  497. <returns>Package</returns>
  498. <exception cref="T:System.ArgumentNullException">If path parameter is null</exception>
  499. <exception cref="T:System.ArgumentOutOfRangeException">If FileMode enumeration [packageMode] does not have one of the valid values</exception>
  500. </member>
  501. <member name="M:System.IO.Packaging.Package.Open(System.String,System.IO.FileMode,System.IO.FileAccess)">
  502. <summary>
  503. Opens a package at the specified Path in the given mode with the specified access. This method calls
  504. the overload which accepts all the parameters with the following defaults -
  505. FileShare - FileShare.None
  506. </summary>
  507. <param name="path">Path to the package</param>
  508. <param name="packageMode">FileMode in which the package should be opened</param>
  509. <param name="packageAccess">FileAccess with which the package should be opened</param>
  510. <returns>Package</returns>
  511. <exception cref="T:System.ArgumentNullException">If path parameter is null</exception>
  512. <exception cref="T:System.ArgumentOutOfRangeException">If FileMode enumeration [packageMode] does not have one of the valid values</exception>
  513. <exception cref="T:System.ArgumentOutOfRangeException">If FileAccess enumeration [packageAccess] does not have one of the valid values</exception>
  514. </member>
  515. <member name="M:System.IO.Packaging.Package.Open(System.IO.Stream)">
  516. <summary>
  517. Open a package on this stream. This method calls the overload which accepts all the parameters
  518. with the following defaults -
  519. FileMode - FileMode.Open
  520. FileAccess - FileAccess.Read
  521. </summary>
  522. <param name="stream">Stream on which the package is to be opened</param>
  523. <returns>Package</returns>
  524. <exception cref="T:System.ArgumentNullException">If stream parameter is null</exception>
  525. <exception cref="T:System.IO.IOException">If package to be created should have readwrite/read access and underlying stream is write only</exception>
  526. <exception cref="T:System.IO.IOException">If package to be created should have readwrite/write access and underlying stream is read only</exception>
  527. </member>
  528. <member name="M:System.IO.Packaging.Package.Open(System.IO.Stream,System.IO.FileMode)">
  529. <summary>
  530. Open a package on this stream. This method calls the overload which accepts all the parameters
  531. with the following defaults -
  532. FileAccess - FileAccess.ReadWrite
  533. </summary>
  534. <param name="stream">Stream on which the package is to be opened</param>
  535. <param name="packageMode">FileMode in which the package should be opened.</param>
  536. <returns>Package</returns>
  537. <exception cref="T:System.ArgumentNullException">If stream parameter is null</exception>
  538. <exception cref="T:System.ArgumentOutOfRangeException">If FileMode enumeration [packageMode] does not have one of the valid values</exception>
  539. <exception cref="T:System.IO.IOException">If package to be created should have readwrite/read access and underlying stream is write only</exception>
  540. <exception cref="T:System.IO.IOException">If package to be created should have readwrite/write access and underlying stream is read only</exception>
  541. </member>
  542. <member name="M:System.IO.Packaging.Package.CreatePart(System.Uri,System.String)">
  543. <summary>
  544. Creates a new part in the package. An empty stream corresponding to this part will be created in the
  545. package. If a part with the specified uri already exists then we throw an exception.
  546. This methods will call the CreatePartCore method which will create the actual PackagePart in the package.
  547. </summary>
  548. <param name="partUri">Uri of the PackagePart that is to be added</param>
  549. <param name="contentType">ContentType of the stream to be added</param>
  550. <returns></returns>
  551. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  552. <exception cref="T:System.IO.IOException">If the package is readonly, it cannot be modified</exception>
  553. <exception cref="T:System.ArgumentNullException">If partUri parameter is null</exception>
  554. <exception cref="T:System.ArgumentNullException">If contentType parameter is null</exception>
  555. <exception cref="T:System.ArgumentException">If partUri parameter does not conform to the valid partUri syntax</exception>
  556. <exception cref="T:System.InvalidOperationException">If a PackagePart with the given partUri already exists in the Package</exception>
  557. </member>
  558. <member name="M:System.IO.Packaging.Package.CreatePart(System.Uri,System.String,System.IO.Packaging.CompressionOption)">
  559. <summary>
  560. Creates a new part in the package. An empty stream corresponding to this part will be created in the
  561. package. If a part with the specified uri already exists then we throw an exception.
  562. This methods will call the CreatePartCore method which will create the actual PackagePart in the package.
  563. </summary>
  564. <param name="partUri">Uri of the PackagePart that is to be added</param>
  565. <param name="contentType">ContentType of the stream to be added</param>
  566. <param name="compressionOption">CompressionOption describing compression configuration
  567. for the new part. This compression apply only to the part, it doesn't affect relationship parts or related parts.
  568. This parameter is optional. </param>
  569. <returns></returns>
  570. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  571. <exception cref="T:System.IO.IOException">If the package is readonly, it cannot be modified</exception>
  572. <exception cref="T:System.ArgumentNullException">If partUri parameter is null</exception>
  573. <exception cref="T:System.ArgumentNullException">If contentType parameter is null</exception>
  574. <exception cref="T:System.ArgumentException">If partUri parameter does not conform to the valid partUri syntax</exception>
  575. <exception cref="T:System.ArgumentOutOfRangeException">If CompressionOption enumeration [compressionOption] does not have one of the valid values</exception>
  576. <exception cref="T:System.InvalidOperationException">If a PackagePart with the given partUri already exists in the Package</exception>
  577. </member>
  578. <member name="M:System.IO.Packaging.Package.GetPart(System.Uri)">
  579. <summary>
  580. Returns a part that already exists in the package. If the part
  581. Corresponding to the URI does not exist in the package then an exception is
  582. thrown. The method calls the GetPartCore method which actually fetches the part.
  583. </summary>
  584. <param name="partUri"></param>
  585. <returns></returns>
  586. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  587. <exception cref="T:System.IO.IOException">If the package is write only, information cannot be retrieved from it</exception>
  588. <exception cref="T:System.ArgumentNullException">If partUri parameter is null</exception>
  589. <exception cref="T:System.ArgumentException">If partUri parameter does not conform to the valid partUri syntax</exception>
  590. <exception cref="T:System.InvalidOperationException">If the requested part does not exists in the Package</exception>
  591. </member>
  592. <member name="M:System.IO.Packaging.Package.PartExists(System.Uri)">
  593. <summary>
  594. This is a convenient method to check whether a given part exists in the
  595. package. This will have a default implementation that will try to retrieve
  596. the part and then if successful, it will return true.
  597. If the custom file format has an easier way to do this, they can override this method
  598. to get this information in a more efficient way.
  599. </summary>
  600. <param name="partUri"></param>
  601. <returns></returns>
  602. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  603. <exception cref="T:System.IO.IOException">If the package is write only, information cannot be retrieved from it</exception>
  604. <exception cref="T:System.ArgumentNullException">If partUri parameter is null</exception>
  605. <exception cref="T:System.ArgumentException">If partUri parameter does not conform to the valid partUri syntax</exception>
  606. </member>
  607. <member name="M:System.IO.Packaging.Package.DeletePart(System.Uri)">
  608. <summary>
  609. This method will do all the house keeping required when a part is deleted
  610. Then the DeletePartCore method will be called which will have the actual logic to
  611. do the work specific to the underlying file format and will actually delete the
  612. stream corresponding to this part. This method does not throw if the specified
  613. part does not exist. This is in conformance with the FileInfo.Delete call.
  614. </summary>
  615. <param name="partUri"></param>
  616. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  617. <exception cref="T:System.IO.IOException">If the package is readonly, it cannot be modified</exception>
  618. <exception cref="T:System.ArgumentNullException">If partUri parameter is null</exception>
  619. <exception cref="T:System.ArgumentException">If partUri parameter does not conform to the valid partUri syntax</exception>
  620. </member>
  621. <member name="M:System.IO.Packaging.Package.GetParts">
  622. <summary>
  623. This returns a collection of all the Parts within the package.
  624. </summary>
  625. <returns></returns>
  626. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  627. <exception cref="T:System.IO.IOException">If the package is writeonly, no information can be retrieved from it</exception>
  628. </member>
  629. <member name="M:System.IO.Packaging.Package.System#IDisposable#Dispose">
  630. <summary>
  631. Member of the IDisposable interface. This method will clean up all the resources.
  632. It calls the Flush method to make sure that all the changes made get persisted.
  633. Note - subclasses should only override Dispose(bool) if they have resources to release.
  634. See the Design Guidelines for the Dispose() pattern.
  635. </summary>
  636. </member>
  637. <member name="M:System.IO.Packaging.Package.Close">
  638. <summary>
  639. Closes the package and all the underlying parts and relationships.
  640. Calls the Dispose Method, since they have the same semantics
  641. </summary>
  642. </member>
  643. <member name="M:System.IO.Packaging.Package.Flush">
  644. <summary>
  645. Flushes the contents of the parts and the relationships to the package.
  646. This method will call the FlushCore method which will do the actual flushing of contents.
  647. </summary>
  648. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  649. <exception cref="T:System.IO.IOException">If the package is readonly, it cannot be modified</exception>
  650. </member>
  651. <member name="M:System.IO.Packaging.Package.CreateRelationship(System.Uri,System.IO.Packaging.TargetMode,System.String)">
  652. <summary>
  653. Creates a relationship at the Package level with the Target PackagePart specified as the Uri
  654. </summary>
  655. <param name="targetUri">Target's URI</param>
  656. <param name="targetMode">Enumeration indicating the base uri for the target uri</param>
  657. <param name="relationshipType">PackageRelationship type, having uri like syntax that is used to
  658. uniquely identify the role of the relationship</param>
  659. <returns></returns>
  660. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  661. <exception cref="T:System.IO.IOException">If the package is readonly, it cannot be modified</exception>
  662. <exception cref="T:System.ArgumentNullException">If parameter "targetUri" is null</exception>
  663. <exception cref="T:System.ArgumentNullException">If parameter "relationshipType" is null</exception>
  664. <exception cref="T:System.ArgumentOutOfRangeException">If parameter "targetMode" enumeration does not have a valid value</exception>
  665. <exception cref="T:System.ArgumentException">If TargetMode is TargetMode.Internal and the targetUri is an absolute Uri </exception>
  666. <exception cref="T:System.ArgumentException">If relationship is being targeted to a relationship part</exception>
  667. </member>
  668. <member name="M:System.IO.Packaging.Package.CreateRelationship(System.Uri,System.IO.Packaging.TargetMode,System.String,System.String)">
  669. <summary>
  670. Creates a relationship at the Package level with the Target PackagePart specified as the Uri
  671. </summary>
  672. <param name="targetUri">Target's URI</param>
  673. <param name="targetMode">Enumeration indicating the base uri for the target uri</param>
  674. <param name="relationshipType">PackageRelationship type, having uri like syntax that is used to
  675. uniquely identify the role of the relationship</param>
  676. <param name="id">String that conforms to the xsd:ID datatype. Unique across the source's
  677. relationships. Null is OK (ID will be generated). An empty string is an invalid XML ID.</param>
  678. <returns></returns>
  679. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  680. <exception cref="T:System.IO.IOException">If the package is readonly, it cannot be modified</exception>
  681. <exception cref="T:System.ArgumentNullException">If parameter "targetUri" is null</exception>
  682. <exception cref="T:System.ArgumentNullException">If parameter "relationshipType" is null</exception>
  683. <exception cref="T:System.ArgumentOutOfRangeException">If parameter "targetMode" enumeration does not have a valid value</exception>
  684. <exception cref="T:System.ArgumentException">If TargetMode is TargetMode.Internal and the targetUri is an absolute Uri </exception>
  685. <exception cref="T:System.ArgumentException">If relationship is being targeted to a relationship part</exception>
  686. <exception cref="T:System.Xml.XmlException">If parameter "id" is not a valid Xsd Id</exception>
  687. <exception cref="T:System.Xml.XmlException">If an id is provided in the method, and its not unique</exception>
  688. </member>
  689. <member name="M:System.IO.Packaging.Package.DeleteRelationship(System.String)">
  690. <summary>
  691. Deletes a relationship from the Package. This is done based on the
  692. relationship's ID. The target PackagePart is not affected by this operation.
  693. </summary>
  694. <param name="id">The ID of the relationship to delete. An invalid ID will not
  695. throw an exception, but nothing will be deleted.</param>
  696. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  697. <exception cref="T:System.IO.IOException">If the package is readonly, it cannot be modified</exception>
  698. <exception cref="T:System.ArgumentNullException">If parameter "id" is null</exception>
  699. <exception cref="T:System.Xml.XmlException">If parameter "id" is not a valid Xsd Id</exception>
  700. </member>
  701. <member name="M:System.IO.Packaging.Package.GetRelationships">
  702. <summary>
  703. Returns a collection of all the Relationships that are
  704. owned by the package
  705. </summary>
  706. <returns></returns>
  707. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  708. <exception cref="T:System.IO.IOException">If the package is write only, no information can be retrieved from it</exception>
  709. </member>
  710. <member name="M:System.IO.Packaging.Package.GetRelationshipsByType(System.String)">
  711. <summary>
  712. Returns a collection of filtered Relationships that are
  713. owned by the package
  714. The filter string is compared with the type of the relationships
  715. in a case sensitive and culture ignorant manner.
  716. </summary>
  717. <returns></returns>
  718. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  719. <exception cref="T:System.IO.IOException">If the package is write only, no information can be retrieved from it</exception>
  720. <exception cref="T:System.ArgumentNullException">If parameter "relationshipType" is null</exception>
  721. <exception cref="T:System.ArgumentException">If parameter "relationshipType" is an empty string</exception>
  722. </member>
  723. <member name="M:System.IO.Packaging.Package.GetRelationship(System.String)">
  724. <summary>
  725. Retrieve a relationship per ID.
  726. </summary>
  727. <param name="id">The relationship ID.</param>
  728. <returns>The relationship with ID 'id' or throw an exception if not found.</returns>
  729. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  730. <exception cref="T:System.IO.IOException">If the package is write only, no information can be retrieved from it</exception>
  731. <exception cref="T:System.ArgumentNullException">If parameter "id" is null</exception>
  732. <exception cref="T:System.Xml.XmlException">If parameter "id" is not a valid Xsd Id</exception>
  733. <exception cref="T:System.InvalidOperationException">If the requested relationship does not exist in the Package</exception>
  734. </member>
  735. <member name="M:System.IO.Packaging.Package.RelationshipExists(System.String)">
  736. <summary>
  737. Returns whether there is a relationship with the specified ID.
  738. </summary>
  739. <param name="id">The relationship ID.</param>
  740. <returns>true iff a relationship with ID 'id' is defined on this source.</returns>
  741. <exception cref="T:System.ObjectDisposedException">If this Package object has been disposed</exception>
  742. <exception cref="T:System.IO.IOException">If the package is write only, no information can be retrieved from it</exception>
  743. <exception cref="T:System.ArgumentNullException">If parameter "id" is null</exception>
  744. <exception cref="T:System.Xml.XmlException">If parameter "id" is not a valid Xsd Id</exception>
  745. </member>
  746. <member name="M:System.IO.Packaging.Package.CreatePartCore(System.Uri,System.String,System.IO.Packaging.CompressionOption)">
  747. <summary>
  748. This method is for custom implementation corresponding to the underlying file format.
  749. This method will actually add a new part to the package. An empty part should be
  750. created as a result of this call.
  751. </summary>
  752. <param name="partUri"></param>
  753. <param name="contentType"></param>
  754. <param name="compressionOption"></param>
  755. <returns></returns>
  756. </member>
  757. <member name="M:System.IO.Packaging.Package.GetPartCore(System.Uri)">
  758. <summary>
  759. This method is for custom implementation corresponding to the underlying file format.
  760. This method will actually return the part after reading the actual physical bits.
  761. If the PackagePart does not exists in the underlying package then this method should return a null.
  762. This method must not throw an exception if a part does not exist.
  763. </summary>
  764. <param name="partUri"></param>
  765. <returns></returns>
  766. </member>
  767. <member name="M:System.IO.Packaging.Package.DeletePartCore(System.Uri)">
  768. <summary>
  769. This method is for custom implementation corresponding to the underlying file format.
  770. This method will actually delete the part from the underlying package.
  771. This method should not throw if the specified part does not exist.
  772. This is in conformance with the FileInfo.Delete call.
  773. </summary>
  774. <param name="partUri"></param>
  775. </member>
  776. <member name="M:System.IO.Packaging.Package.GetPartsCore">
  777. <summary>
  778. This method is for custom implementation corresponding to the underlying file format.
  779. This is the method that knows how to get the actual parts. If there are no parts,
  780. this method should return an empty array.
  781. </summary>
  782. <returns></returns>
  783. </member>
  784. <member name="M:System.IO.Packaging.Package.Dispose(System.Boolean)">
  785. <summary>
  786. This method is for custom implementation corresponding to the underlying file format.
  787. This method should be used to dispose the resources that are specific to the file format.
  788. Also everything should be flushed to the disc before closing the package.
  789. </summary>
  790. <remarks>Subclasses that manage non-memory resources should override this method and free these resources.
  791. Any override should be careful to always call base.Dispose(disposing) to ensure orderly cleanup.</remarks>
  792. </member>
  793. <member name="M:System.IO.Packaging.Package.FlushCore">
  794. <summary>
  795. This method is for custom implementation corresponding to the underlying file format.
  796. This method flushes the contents of the package to the disc.
  797. </summary>
  798. </member>
  799. <member name="M:System.IO.Packaging.Package.Open(System.String,System.IO.FileMode,System.IO.FileAccess,System.IO.FileShare)">
  800. <summary>
  801. </summary>
  802. <param name="path">Path to the package.</param>
  803. <param name="packageMode">FileMode in which the package should be opened.</param>
  804. <param name="packageAccess">FileAccess with which the package should be opened.</param>
  805. <param name="packageShare">FileShare with which the package is opened.</param>
  806. <returns>Package</returns>
  807. <exception cref="T:System.ArgumentNullException">If path parameter is null</exception>
  808. <exception cref="T:System.ArgumentOutOfRangeException">If FileAccess enumeration [packageAccess] does not have one of the valid values</exception>
  809. <exception cref="T:System.ArgumentOutOfRangeException">If FileMode enumeration [packageMode] does not have one of the valid values</exception>
  810. </member>
  811. <member name="M:System.IO.Packaging.Package.Open(System.IO.Stream,System.IO.FileMode,System.IO.FileAccess)">
  812. <summary>
  813. </summary>
  814. <param name="stream">Stream on which the package is created</param>
  815. <param name="packageMode">FileMode in which the package is to be opened</param>
  816. <param name="packageAccess">FileAccess on the package that is opened</param>
  817. <returns>Package</returns>
  818. <exception cref="T:System.ArgumentNullException">If stream parameter is null</exception>
  819. <exception cref="T:System.ArgumentOutOfRangeException">If FileMode enumeration [packageMode] does not have one of the valid values</exception>
  820. <exception cref="T:System.ArgumentOutOfRangeException">If FileAccess enumeration [packageAccess] does not have one of the valid values</exception>
  821. <exception cref="T:System.IO.IOException">If package to be created should have readwrite/read access and underlying stream is write only</exception>
  822. <exception cref="T:System.IO.IOException">If package to be created should have readwrite/write access and underlying stream is read only</exception>
  823. </member>
  824. <member name="M:System.IO.Packaging.Package.GetRelationshipHelper(System.String)">
  825. <summary>
  826. Retrieve a relationship per ID.
  827. </summary>
  828. <param name="id">The relationship ID.</param>
  829. <returns>The relationship with ID 'id' or null if not found.</returns>
  830. </member>
  831. <member name="M:System.IO.Packaging.Package.GetRelationshipsHelper(System.String)">
  832. <summary>
  833. Returns a collection of all the Relationships that are
  834. owned by the package based on the filter string.
  835. </summary>
  836. <returns></returns>
  837. </member>
  838. <member name="T:System.IO.Packaging.PackagePart">
  839. <summary>
  840. This class represents the a PackagePart within a container.
  841. This is a part of the Packaging Layer APIs
  842. </summary>
  843. </member>
  844. <member name="M:System.IO.Packaging.PackagePart.#ctor(System.IO.Packaging.Package,System.Uri)">
  845. <summary>
  846. Protected constructor for the abstract Base class.
  847. This is the current contract between the subclass and the base class
  848. If we decide some registration mechanism then this might change
  849. You should use this constructor in the rare case when you do not have
  850. the content type information related to this part and would prefer to
  851. obtain it later as required.
  852. These parts have the CompressionOption as NotCompressed by default.
  853. NOTE : If you are using this constructor from your subclass or passing a null
  854. for the content type parameter, be sure to implement the GetContentTypeCore
  855. method, as that will be called to get the content type value. This is provided
  856. to enable lazy initialization of the ContentType property.
  857. </summary>
  858. <param name="package">Package in which this part is being created</param>
  859. <param name="partUri">uri of the part</param>
  860. <exception cref="T:System.ArgumentNullException">If parameter "package" is null</exception>
  861. <exception cref="T:System.ArgumentNullException">If parameter "partUri" is null</exception>
  862. </member>
  863. <member name="M:System.IO.Packaging.PackagePart.#ctor(System.IO.Packaging.Package,System.Uri,System.String)">
  864. <summary>
  865. Protected constructor for the abstract Base class.
  866. This is the current contract between the subclass and the base class
  867. If we decide some registration mechanism then this might change
  868. These parts have the CompressionOption as NotCompressed by default.
  869. NOTE : If you are using this constructor from your subclass or passing a null
  870. for the content type parameter, be sure to implement the GetContentTypeCore
  871. method, as that will be called to get the content type value. This is provided
  872. to enable lazy initialization of the ContentType property.
  873. </summary>
  874. <param name="package">Package in which this part is being created</param>
  875. <param name="partUri">uri of the part</param>
  876. <param name="contentType">Content Type of the part, can be null if the value
  877. is unknown at the time of construction. However the value has to be made
  878. available anytime the ContentType property is called. A null value only indicates
  879. that the value will be provided later. Every PackagePart must have a valid
  880. Content Type</param>
  881. <exception cref="T:System.ArgumentNullException">If parameter "package" is null</exception>
  882. <exception cref="T:System.ArgumentNullException">If parameter "partUri" is null</exception>
  883. <exception cref="T:System.ArgumentException">If parameter "partUri" does not conform to the valid partUri syntax</exception>
  884. </member>
  885. <member name="M:System.IO.Packaging.PackagePart.#ctor(System.IO.Packaging.Package,System.Uri,System.String,System.IO.Packaging.CompressionOption)">
  886. <summary>
  887. Protected constructor for the abstract Base class.
  888. This is the current contract between the subclass and the base class
  889. If we decide some registration mechanism then this might change
  890. NOTE : If you are using this constructor from your subclass or passing a null
  891. for the content type parameter, be sure to implement the GetContentTypeCore
  892. method, as that will be called to get the content type value. This is provided
  893. to enable lazy initialization of the ContentType property.
  894. </summary>
  895. <param name="package">Package in which this part is being created</param>
  896. <param name="partUri">uri of the part</param>
  897. <param name="contentType">Content Type of the part, can be null if the value
  898. is unknown at the time of construction. However the value has to be made
  899. available anytime the ContentType property is called. A null value only indicates
  900. that the value will be provided later. Every PackagePart must have a valid
  901. Content Type</param>
  902. <param name="compressionOption">compression option for this part</param>
  903. <exception cref="T:System.ArgumentNullException">If parameter "package" is null</exception>
  904. <exception cref="T:System.ArgumentNullException">If parameter "partUri" is null</exception>
  905. <exception cref="T:System.ArgumentOutOfRangeException">If CompressionOption enumeration [compressionOption] does not have one of the valid values</exception>
  906. <exception cref="T:System.ArgumentException">If parameter "partUri" does not conform to the valid partUri syntax</exception>
  907. </member>
  908. <member name="P:System.IO.Packaging.PackagePart.Uri">
  909. <summary>
  910. The Uri for this PackagePart. It is always relative to the Package Root
  911. The PackagePart properties can not be accessed if the parent container is closed.
  912. </summary>
  913. <value></value>
  914. <exception cref="T:System.InvalidOperationException">If this part has been deleted</exception>
  915. <exception cref="T:System.InvalidOperationException">If the parent package has been closed or disposed</exception>
  916. </member>
  917. <member name="P:System.IO.Packaging.PackagePart.ContentType">
  918. <summary>
  919. The Content type of the stream that is represented by this part.
  920. The PackagePart properties can not be accessed if the parent container is closed.
  921. The content type value can be provided by the underlying physical format
  922. implementation at the time of creation of the Part object ( constructor ) or
  923. We can initialize it in a lazy manner when the ContentType property is called
  924. called for the first time by calling the GetContentTypeCore method.
  925. Note: This method GetContentTypeCore() is only for lazy initialization of the Content
  926. type value and will only be called once. There is no way to change the content type of
  927. the part once it has been assigned.
  928. </summary>
  929. <value>Content Type of the Part [can never return null] </value>
  930. <exception cref="T:System.InvalidOperationException">If this part has been deleted</exception>
  931. <exception cref="T:System.InvalidOperationException">If the parent package has been closed or disposed</exception>
  932. <exception cref="T:System.InvalidOperationException">If the subclass fails to provide a non-null content type value.</exception>
  933. </member>
  934. <member name="P:System.IO.Packaging.PackagePart.Package">
  935. <summary>
  936. The parent container for this PackagePart
  937. The PackagePart properties can not be accessed if the parent container is closed.
  938. </summary>
  939. <value></value>
  940. <exception cref="T:System.InvalidOperationException">If this part has been deleted</exception>
  941. <exception cref="T:System.InvalidOperationException">If the parent package has been closed or disposed</exception>
  942. </member>
  943. <member name="P:System.IO.Packaging.PackagePart.CompressionOption">
  944. <summary>
  945. CompressionOption class that was provided as a parameter during the original CreatePart call.
  946. The PackagePart properties can not be accessed if the parent container is closed.
  947. </summary>
  948. <exception cref="T:System.InvalidOperationException">If this part has been deleted</exception>
  949. <exception cref="T:System.InvalidOperationException">If the parent package has been closed or disposed</exception>
  950. </member>
  951. <member name="M:System.IO.Packaging.PackagePart.GetContentTypeCore">
  952. <summary>
  953. Custom Implementation for the GetContentType Method
  954. This method should only be implemented by those physical format implementors where
  955. the value for the content type cannot be provided at the time of construction of
  956. Part object and if calculating the content type value is a non-trivial or costly
  957. operation. The return value has to be a valid ContentType. This method will be used in
  958. real corner cases. The most common usage should be to provide the content type in the
  959. constructor.
  960. This method is only for lazy initialization of the Content type value and will only
  961. be called once. There is no way to change the content type of the part once it is
  962. assigned.
  963. </summary>
  964. <returns>Content type for the Part</returns>
  965. <exception cref="T:System.NotSupportedException">By default, this method throws a NotSupportedException. If a subclass wants to
  966. initialize the content type for a PackagePart in a lazy manner they must override this method.</exception>
  967. </member>
  968. <member name="M:System.IO.Packaging.PackagePart.GetStream">
  969. <summary>
  970. Returns the underlying stream that is represented by this part
  971. with the default FileMode and FileAccess
  972. Note: If you are requesting a stream for a relationship part and
  973. at the same time using relationship APIs to manipulate relationships,
  974. the final persisted data will depend on which data gets flushed last.
  975. </summary>
  976. <returns></returns>
  977. <exception cref="T:System.InvalidOperationException">If this part has been deleted</exception>
  978. <exception cref="T:System.InvalidOperationException">If the parent package has been closed or disposed</exception>
  979. <exception cref="T:System.IO.IOException">If the subclass fails to provide a non-null stream object</exception>
  980. </member>
  981. <member name="M:System.IO.Packaging.PackagePart.GetStream(System.IO.FileMode)">
  982. <summary>
  983. Returns the underlying stream in the specified mode and the
  984. default FileAccess
  985. Note: If you are requesting a stream for a relationship part for editing
  986. and at the same time using relationship APIs to manipulate relationships,
  987. the final persisted data will depend on which data gets flushed last.
  988. </summary>
  989. <param name="mode"></param>
  990. <returns></returns>
  991. <exception cref="T:System.InvalidOperationException">If this part has been deleted</exception>
  992. <exception cref="T:System.InvalidOperationException">If the parent package has been closed or disposed</exception>
  993. <exception cref="T:System.ArgumentOutOfRangeException">If FileMode enumeration [mode] does not have one of the valid values</exception>
  994. <exception cref="T:System.IO.IOException">If FileAccess.Read is provided and FileMode values are any of the following -
  995. FileMode.Create, FileMode.CreateNew, FileMode.Truncate, FileMode.Append</exception>
  996. <exception cref="T:System.IO.IOException">If the mode and access for the Package and the Stream are not compatible</exception>
  997. <exception cref="T:System.IO.IOException">If the subclass fails to provide a non-null stream object</exception>
  998. </member>
  999. <member name="M:System.IO.Packaging.PackagePart.GetStream(System.IO.FileMode,System.IO.FileAccess)">
  1000. <summary>
  1001. Returns the underlying stream that is represented by this part
  1002. in the specified mode with the access.
  1003. Note: If you are requesting a stream for a relationship part and
  1004. at the same time using relationship APIs to manipulate relationships,
  1005. the final persisted data will depend on which data gets flushed last.
  1006. </summary>
  1007. <param name="mode"></param>
  1008. <param name="access"></param>
  1009. <returns></returns>
  1010. <exception cref="T:System.InvalidOperationException">If this part has been deleted</exception>
  1011. <exception cref="T:System.InvalidOperationException">If the parent package has been closed or disposed</exception>
  1012. <exception cref="T:System.ArgumentOutOfRangeException">If FileMode enumeration [mode] does not have one of the valid values</exception>
  1013. <exception cref="T:System.ArgumentOutOfRangeException">If FileAccess enumeration [access] does not have one of the valid values</exception>
  1014. <exception cref="T:System.IO.IOException">If FileAccess.Read is provided and FileMode values are any of the following -
  1015. FileMode.Create, FileMode.CreateNew, FileMode.Truncate, FileMode.Append</exception>
  1016. <exception cref="T:System.IO.IOException">If the mode and access for the Package and the Stream are not compatible</exception>
  1017. <exception cref="T:System.IO.IOException">If the subclass fails to provide a non-null stream object</exception>
  1018. </member>
  1019. <member name="M:System.IO.Packaging.PackagePart.GetStreamCore(System.IO.FileMode,System.IO.FileAccess)">
  1020. <summary>
  1021. Custom Implementation for the GetSream Method
  1022. </summary>
  1023. <param name="mode"></param>
  1024. <param name="access"></param>
  1025. <returns></returns>
  1026. </member>
  1027. <member name="M:System.IO.Packaging.PackagePart.CreateRelationship(System.Uri,System.IO.Packaging.TargetMode,System.String)">
  1028. <summary>
  1029. Adds a relationship to this PackagePart with the Target PackagePart specified as the Uri
  1030. Initial and trailing spaces in the name of the PackageRelationship are trimmed.
  1031. </summary>
  1032. <param name="targetUri"></param>
  1033. <param name="targetMode">Enumeration indicating the base uri for the target uri</param>
  1034. <param name="relationshipType">PackageRelationship type, having uri like syntax that is used to
  1035. uniquely identify the role of the relationship</param>
  1036. <returns></returns>
  1037. <exception cref="T:System.InvalidOperationException">If this part has been deleted</exception>
  1038. <exception cref="T:System.InvalidOperationException">If the parent package has been closed or disposed</exception>
  1039. <exception cref="T:System.IO.IOException">If the package is readonly, it cannot be modified</exception>
  1040. <exception cref="T:System.ArgumentNullException">If parameter "targetUri" is null</exception>
  1041. <exception cref="T:System.ArgumentNullException">If parameter "relationshipType" is null</exception>
  1042. <exception cref="T:System.ArgumentOutOfRangeException">If parameter "targetMode" enumeration does not have a valid value</exception>
  1043. <exception cref="T:System.ArgumentException">If TargetMode is TargetMode.Internal and the targetUri is an absolute Uri </exception>
  1044. <exception cref="T:System.ArgumentException">If relationship is being targeted to a relationship part</exception>
  1045. </member>
  1046. <member name="M:System.IO.Packaging.PackagePart.CreateRelationship(System.Uri,System.IO.Packaging.TargetMode,System.String,System.String)">
  1047. <summary>
  1048. Adds a relationship to this PackagePart with the Target PackagePart specified as the Uri
  1049. Initial and trailing spaces in the name of the PackageRelationship are trimmed.
  1050. </summary>
  1051. <param name="targetUri"></param>
  1052. <param name="targetMode">Enumeration indicating the base uri for the target uri</param>
  1053. <param name="relationshipType">PackageRelationship type, having uri like syntax that is used to
  1054. uniquely identify the role of the relationship</param>
  1055. <param name="id">String that conforms to the xsd:ID datatype. Unique across the source's
  1056. relationships. Null is OK (ID will be generated). An empty string is an invalid XML ID.</param>
  1057. <returns></returns>
  1058. <exception cref="T:System.InvalidOperationException">If this part has been deleted</exception>
  1059. <exception cref="T:System.InvalidOperationException">If the parent package has been closed or disposed</exception>
  1060. <exception cref="T:System.IO.IOException">If the package is readonly, it cannot be modified</exception>
  1061. <exception cref="T:System.ArgumentNullException">If parameter "targetUri" is null</exception>
  1062. <exception cref="T:System.ArgumentNullException">If parameter "relationshipType" is null</exception>
  1063. <exception cref="T:System.ArgumentOutOfRangeException">If parameter "targetMode" enumeration does not have a valid value</exception>
  1064. <exception cref="T:System.ArgumentException">If TargetMode is TargetMode.Internal and the targetUri is an absolute Uri </exception>
  1065. <exception cref="T:System.ArgumentException">If relationship is being targeted to a relationship part</exception>
  1066. <exception cref="T:System.Xml.XmlException">If parameter "id" is not a valid Xsd Id</exception>
  1067. <exception cref="T:System.Xml.XmlException">If an id is provided in the method, and its not unique</exception>
  1068. </member>
  1069. <member name="M:System.IO.Packaging.PackagePart.DeleteRelationship(System.String)">
  1070. <summary>
  1071. Deletes a relationship from the PackagePart. This is done based on the
  1072. relationship's ID. The target PackagePart is not affected by this operation.
  1073. </summary>
  1074. <param name="id">The ID of the relationship to delete. An invalid ID will not
  1075. throw an exception, but nothing will be deleted.</param>
  1076. <exception cref="T:System.InvalidOperationException">If this part has been deleted</exception>
  1077. <exception cref="T:System.InvalidOperationException">If the parent package has been closed or disposed</exception>
  1078. <exception cref="T:System.IO.IOException">If the package is readonly, it cannot be modified</exception>
  1079. <exception cref="T:System.ArgumentNullException">If parameter "id" is null</exception>
  1080. <exception cref="T:System.Xml.XmlException">If parameter "id" is not a valid Xsd Id</exception>
  1081. </member>
  1082. <member name="M:System.IO.Packaging.PackagePart.GetRelationships">
  1083. <summary>
  1084. Returns a collection of all the Relationships that are
  1085. owned by this PackagePart
  1086. </summary>
  1087. <returns></returns>
  1088. <exception cref="T:System.InvalidOperationException">If this part has been deleted</exception>
  1089. <exception cref="T:System.InvalidOperationException">If the parent package has been closed or disposed</exception>
  1090. <exception cref="T:System.IO.IOException">If the package is write only, no information can be retrieved from it</exception>
  1091. </member>
  1092. <member name="M:System.IO.Packaging.PackagePart.GetRelationshipsByType(System.String)">
  1093. <summary>
  1094. Returns a collection of filtered Relationships that are
  1095. owned by this PackagePart
  1096. The relationshipType string is compared with the type of the relationships
  1097. in a case sensitive and culture ignorant manner.
  1098. </summary>
  1099. <returns></returns>
  1100. <exception cref="T:System.InvalidOperationException">If this part has been deleted</exception>
  1101. <exception cref="T:System.InvalidOperationException">If the parent package has been closed or disposed</exception>
  1102. <exception cref="T:System.IO.IOException">If the package is write only, no information can be retrieved from it</exception>
  1103. <exception cref="T:System.ArgumentNullException">If parameter "relationshipType" is null</exception>
  1104. <exception cref="T:System.ArgumentException">If parameter "relationshipType" is an empty string</exception>
  1105. </member>
  1106. <member name="M:System.IO.Packaging.PackagePart.GetRelationship(System.String)">
  1107. <summary>
  1108. Retrieve a relationship per ID.
  1109. </summary>
  1110. <param name="id">The relationship ID.</param>
  1111. <returns>The relationship with ID 'id' or throw an exception if not found.</returns>
  1112. <exception cref="T:System.InvalidOperationException">If this part has been deleted</exception>
  1113. <exception cref="T:System.InvalidOperationException">If the parent package has been closed or disposed</exception>
  1114. <exception cref="T:System.IO.IOException">If the package is write only, no information can be retrieved from it</exception>
  1115. <exception cref="T:System.ArgumentNullException">If parameter "id" is null</exception>
  1116. <exception cref="T:System.Xml.XmlException">If parameter "id" is not a valid Xsd Id</exception>
  1117. <exception cref="T:System.InvalidOperationException">If the requested relationship does not exist in the Package</exception>
  1118. </member>
  1119. <member name="M:System.IO.Packaging.PackagePart.RelationshipExists(System.String)">
  1120. <summary>
  1121. Returns whether there is a relationship with the specified ID.
  1122. </summary>
  1123. <param name="id">The relationship ID.</param>
  1124. <returns>true iff a relationship with ID 'id' is defined on this source.</returns>
  1125. <exception cref="T:System.InvalidOperationException">If this part has been deleted</exception>
  1126. <exception cref="T:System.InvalidOperationException">If the parent package has been closed or disposed</exception>
  1127. <exception cref="T:System.IO.IOException">If the package is write only, no information can be retrieved from it</exception>
  1128. <exception cref="T:System.ArgumentNullException">If parameter "id" is null</exception>
  1129. <exception cref="T:System.Xml.XmlException">If parameter "id" is not a valid Xsd Id</exception>
  1130. </member>
  1131. <member name="P:System.IO.Packaging.PackagePart.ValidatedContentType">
  1132. <summary>
  1133. This property returns the content type of the part
  1134. as a validated strongly typed ContentType object
  1135. </summary>
  1136. </member>
  1137. <member name="M:System.IO.Packaging.PackagePart.FlushRelationships">
  1138. <summary>
  1139. write the relationships part
  1140. </summary>
  1141. <remarks>
  1142. </remarks>
  1143. </member>
  1144. <member name="M:System.IO.Packaging.PackagePart.GetRelationshipHelper(System.String)">
  1145. <summary>
  1146. Retrieve a relationship per ID.
  1147. </summary>
  1148. <param name="id">The relationship ID.</param>
  1149. <returns>The relationship with ID 'id' or null if not found.</returns>
  1150. </member>
  1151. <member name="M:System.IO.Packaging.PackagePart.GetRelationshipsHelper(System.String)">
  1152. <summary>
  1153. Returns a collection of all the Relationships that are
  1154. owned by this PackagePart, based on the filter string
  1155. </summary>
  1156. <returns></returns>
  1157. </member>
  1158. <member name="T:System.IO.Packaging.PackagePartCollection">
  1159. <summary>
  1160. This class is used to get an enumerator for the Parts in a container.
  1161. This is a part of the MMCF Packaging Layer APIs
  1162. </summary>
  1163. </member>
  1164. <member name="M:System.IO.Packaging.PackagePartCollection.System#Collections#IEnumerable#GetEnumerator">
  1165. <summary>
  1166. Returns an enumerator over all the Parts in the container
  1167. </summary>
  1168. <returns></returns>
  1169. </member>
  1170. <member name="M:System.IO.Packaging.PackagePartCollection.System#Collections#Generic#IEnumerable{System#IO#Packaging#PackagePart}#GetEnumerator">
  1171. <summary>
  1172. Returns an enumerator over all the Parts in the container
  1173. </summary>
  1174. <returns></returns>
  1175. </member>
  1176. <member name="M:System.IO.Packaging.PackagePartCollection.GetEnumerator">
  1177. <summary>
  1178. Returns an enumerator over all the Parts in the Container
  1179. </summary>
  1180. <returns></returns>
  1181. </member>
  1182. <member name="T:System.IO.Packaging.PackageProperties">
  1183. <summary>
  1184. This class provides access to the "core properties", such as Title and
  1185. Subject, of an RM-protected XPS package. These properties are a subset of
  1186. of the standard OLE property sets SummaryInformation and
  1187. DocumentSummaryInformation.
  1188. </summary>
  1189. </member>
  1190. <member name="M:System.IO.Packaging.PackageProperties.Dispose">
  1191. <summary>
  1192. Allow the object to clean up all resources it holds (both managed and
  1193. unmanaged), and ensure that the resources won't be released a
  1194. second time by removing it from the finalization queue.
  1195. </summary>
  1196. </member>
  1197. <member name="M:System.IO.Packaging.PackageProperties.Dispose(System.Boolean)">
  1198. <summary>
  1199. This default implementation is provided for subclasses that do not
  1200. make use of the IDisposable functionality.
  1201. </summary>
  1202. </member>
  1203. <member name="P:System.IO.Packaging.PackageProperties.Title">
  1204. <summary>
  1205. The title.
  1206. </summary>
  1207. </member>
  1208. <member name="P:System.IO.Packaging.PackageProperties.Subject">
  1209. <summary>
  1210. The topic of the contents.
  1211. </summary>
  1212. </member>
  1213. <member name="P:System.IO.Packaging.PackageProperties.Creator">
  1214. <summary>
  1215. The primary creator. The identification is environment-specific and
  1216. can consist of a name, email address, employee ID, etc. It is
  1217. recommended that this value be only as verbose as necessary to
  1218. identify the individual.
  1219. </summary>
  1220. </member>
  1221. <member name="P:System.IO.Packaging.PackageProperties.Keywords">
  1222. <summary>
  1223. A delimited set of keywords to support searching and indexing. This
  1224. is typically a list of terms that are not available elsewhere in the
  1225. properties.
  1226. </summary>
  1227. </member>
  1228. <member name="P:System.IO.Packaging.PackageProperties.Description">
  1229. <summary>
  1230. The description or abstract of the contents.
  1231. </summary>
  1232. </member>
  1233. <member name="P:System.IO.Packaging.PackageProperties.LastModifiedBy">
  1234. <summary>
  1235. The user who performed the last modification. The identification is
  1236. environment-specific and can consist of a name, email address,
  1237. employee ID, etc. It is recommended that this value be only as
  1238. verbose as necessary to identify the individual.
  1239. </summary>
  1240. </member>
  1241. <member name="P:System.IO.Packaging.PackageProperties.Revision">
  1242. <summary>
  1243. The revision number. This value indicates the number of saves or
  1244. revisions. The application is responsible for updating this value
  1245. after each revision.
  1246. </summary>
  1247. </member>
  1248. <member name="P:System.IO.Packaging.PackageProperties.LastPrinted">
  1249. <summary>
  1250. The date and time of the last printing.
  1251. </summary>
  1252. </member>
  1253. <member name="P:System.IO.Packaging.PackageProperties.Created">
  1254. <summary>
  1255. The creation date and time.
  1256. </summary>
  1257. </member>
  1258. <member name="P:System.IO.Packaging.PackageProperties.Modified">
  1259. <summary>
  1260. The date and time of the last modification.
  1261. </summary>
  1262. </member>
  1263. <member name="P:System.IO.Packaging.PackageProperties.Category">
  1264. <summary>
  1265. The category. This value is typically used by UI applications to create navigation
  1266. controls.
  1267. </summary>
  1268. </member>
  1269. <member name="P:System.IO.Packaging.PackageProperties.Identifier">
  1270. <summary>
  1271. A unique identifier.
  1272. </summary>
  1273. </member>
  1274. <member name="P:System.IO.Packaging.PackageProperties.ContentType">
  1275. <summary>
  1276. The type of content represented, generally defined by a specific
  1277. use and intended audience. Example values include "Whitepaper",
  1278. "Security Bulletin", and "Exam". (This property is distinct from
  1279. MIME content types as defined in RFC 2045.)
  1280. </summary>
  1281. </member>
  1282. <member name="P:System.IO.Packaging.PackageProperties.Language">
  1283. <summary>
  1284. The primary language of the package content. The language tag is
  1285. composed of one or more parts: A primary language subtag and a
  1286. (possibly empty) series of subsequent subtags, for example, "EN-US".
  1287. These values MUST follow the convention specified in RFC 3066.
  1288. </summary>
  1289. </member>
  1290. <member name="P:System.IO.Packaging.PackageProperties.Version">
  1291. <summary>
  1292. The version number. This value is set by the user or by the application.
  1293. </summary>
  1294. </member>
  1295. <member name="P:System.IO.Packaging.PackageProperties.ContentStatus">
  1296. <summary>
  1297. The status of the content. Example values include "Draft",
  1298. "Reviewed", and "Final".
  1299. </summary>
  1300. </member>
  1301. <member name="T:System.IO.Packaging.PackageRelationship">
  1302. <summary>
  1303. This class is used to express a relationship between a source and a target part.
  1304. The only way to create a PackageRelationship, is to call the PackagePart.CreateRelationship()
  1305. or Package.CreateRelationship(). A relationship is owned by a part or by the package itself.
  1306. If the source part is deleted all the relationships it owns are also deleted.
  1307. A target of the relationship need not be present.
  1308. This class is part of the MMCF Packaging layer.
  1309. </summary>
  1310. </member>
  1311. <member name="P:System.IO.Packaging.PackageRelationship.SourceUri">
  1312. <summary>
  1313. This is a reference to the parent PackagePart to which this relationship belongs.
  1314. </summary>
  1315. <value>Uri</value>
  1316. </member>
  1317. <member name="P:System.IO.Packaging.PackageRelationship.TargetUri">
  1318. <summary>
  1319. Uri of the TargetPart, that this relationship points to.
  1320. </summary>
  1321. <value></value>
  1322. </member>
  1323. <member name="P:System.IO.Packaging.PackageRelationship.RelationshipType">
  1324. <summary>
  1325. Type of the relationship - used to uniquely define the role of the relationship
  1326. </summary>
  1327. <value></value>
  1328. </member>
  1329. <member name="P:System.IO.Packaging.PackageRelationship.TargetMode">
  1330. <summary>
  1331. Enumeration value indicating the interpretations of the "base" of the target uri.
  1332. </summary>
  1333. <value></value>
  1334. </member>
  1335. <member name="P:System.IO.Packaging.PackageRelationship.Id">
  1336. <summary>
  1337. PackageRelationship's identifier. Unique across relationships for the given source.
  1338. </summary>
  1339. <value>String</value>
  1340. </member>
  1341. <member name="P:System.IO.Packaging.PackageRelationship.Package">
  1342. <summary>
  1343. PackageRelationship's owning Package object.
  1344. </summary>
  1345. <value>Package</value>
  1346. </member>
  1347. <member name="M:System.IO.Packaging.PackageRelationship.#ctor(System.IO.Packaging.Package,System.IO.Packaging.PackagePart,System.Uri,System.IO.Packaging.TargetMode,System.String,System.String)">
  1348. <summary>
  1349. PackageRelationship constructor
  1350. </summary>
  1351. <param name="package">Owning Package object for this relationship</param>
  1352. <param name="sourcePart">owning part - will be null if the owner is the container</param>
  1353. <param name="targetUri">target of relationship</param>
  1354. <param name="targetMode">enum specifying the interpretation of the base uri for the target uri</param>
  1355. <param name="relationshipType">type name</param>
  1356. <param name="id">unique identifier</param>
  1357. </member>
  1358. <member name="T:System.IO.Packaging.PackageRelationshipCollection">
  1359. <summary>
  1360. Collection of all the relationships corresponding to a given source PackagePart.
  1361. This class is part of the MMCF Packaging Layer. It handles serialization to/from
  1362. relationship parts, creation of those parts and offers methods to create, delete
  1363. and enumerate relationships.
  1364. </summary>
  1365. </member>
  1366. <member name="M:System.IO.Packaging.PackageRelationshipCollection.System#Collections#IEnumerable#GetEnumerator">
  1367. <summary>
  1368. Returns an enumerator for all the relationships for a PackagePart
  1369. </summary>
  1370. <returns></returns>
  1371. </member>
  1372. <member name="M:System.IO.Packaging.PackageRelationshipCollection.GetEnumerator">
  1373. <summary>
  1374. Returns an enumerator over all the relationships for a PackagePart
  1375. </summary>
  1376. <returns></returns>
  1377. </member>
  1378. <member name="M:System.IO.Packaging.PackageRelationshipCollection.#ctor(System.IO.Packaging.InternalRelationshipCollection,System.String)">
  1379. <summary>
  1380. Constructor
  1381. </summary>
  1382. <remarks>For use by PackagePart</remarks>
  1383. </member>
  1384. <member name="T:System.IO.Packaging.PackageRelationshipCollection.FilteredEnumerator">
  1385. <summary>
  1386. Internal class for the FilteredEnumerator
  1387. </summary>
  1388. </member>
  1389. <member name="M:System.IO.Packaging.PackageRelationshipCollection.FilteredEnumerator.#ctor(System.Collections.Generic.IEnumerator{System.IO.Packaging.PackageRelationship},System.String)">
  1390. <summary>
  1391. Constructs a FilteredEnumerator
  1392. </summary>
  1393. <param name="enumerator"></param>
  1394. <param name="filter"></param>
  1395. </member>
  1396. <member name="M:System.IO.Packaging.PackageRelationshipCollection.FilteredEnumerator.System#Collections#IEnumerator#MoveNext">
  1397. <summary>
  1398. This method keeps moving the enumerator the next position till
  1399. a relationship is found with the matching Name
  1400. </summary>
  1401. <returns>Bool indicating if the enumerator successfully moved to the next position</returns>
  1402. </member>
  1403. <member name="P:System.IO.Packaging.PackageRelationshipCollection.FilteredEnumerator.System#Collections#IEnumerator#Current">
  1404. <summary>
  1405. Gets the current object in the enumerator
  1406. </summary>
  1407. <value></value>
  1408. </member>
  1409. <member name="M:System.IO.Packaging.PackageRelationshipCollection.FilteredEnumerator.System#Collections#IEnumerator#Reset">
  1410. <summary>
  1411. Resets the enumerator to the beginning
  1412. </summary>
  1413. </member>
  1414. <member name="P:System.IO.Packaging.PackageRelationshipCollection.FilteredEnumerator.Current">
  1415. <summary>
  1416. Gets the current object in the enumerator
  1417. </summary>
  1418. <value></value>
  1419. </member>
  1420. <member name="T:System.IO.Packaging.PackageRelationshipSelector">
  1421. <summary>
  1422. This class is used to represent a PackageRelationship selector. PackageRelationships can be
  1423. selected based on their Type or ID. This class will specify what the selection is based on and
  1424. what the actual criteria is. </summary>
  1425. </member>
  1426. <member name="M:System.IO.Packaging.PackageRelationshipSelector.#ctor(System.Uri,System.IO.Packaging.PackageRelationshipSelectorType,System.String)">
  1427. <summary>
  1428. Constructor
  1429. </summary>
  1430. <param name="sourceUri">Source Uri of the PackagePart or PackageRoot ("/") that owns the relationship</param>
  1431. <param name="selectorType">PackageRelationshipSelectorType enum representing the type of the selectionCriteria</param>
  1432. <param name="selectionCriteria">The actual string that is used to select the relationships</param>
  1433. <exception cref="T:System.ArgumentNullException">If sourceUri is null</exception>
  1434. <exception cref="T:System.ArgumentNullException">If selectionCriteria is null</exception>
  1435. <exception cref="T:System.ArgumentOutOfRangeException">If selectorType Enumeration does not have a valid value</exception>
  1436. <exception cref="T:System.Xml.XmlException">If PackageRelationshipSelectorType.Id and selection criteria is not valid Xsd Id</exception>
  1437. <exception cref="T:System.ArgumentException">If PackageRelationshipSelectorType.Type and selection criteria is not valid relationship type</exception>
  1438. <exception cref="T:System.ArgumentException">If sourceUri is not "/" to indicate the PackageRoot, then it must conform to the
  1439. valid PartUri syntax</exception>
  1440. </member>
  1441. <member name="P:System.IO.Packaging.PackageRelationshipSelector.SourceUri">
  1442. <summary>
  1443. This is a uri to the parent PackagePart to which this relationship belongs.
  1444. </summary>
  1445. <value>PackagePart</value>
  1446. </member>
  1447. <member name="P:System.IO.Packaging.PackageRelationshipSelector.SelectorType">
  1448. <summary>
  1449. Enumeration value indicating the interpretations of the SelectionCriteria.
  1450. </summary>
  1451. <value></value>
  1452. </member>
  1453. <member name="P:System.IO.Packaging.PackageRelationshipSelector.SelectionCriteria">
  1454. <summary>
  1455. Selection Criteria - actual value (could be ID or type) on which the selection is based
  1456. </summary>
  1457. <value></value>
  1458. </member>
  1459. <member name="M:System.IO.Packaging.PackageRelationshipSelector.Select(System.IO.Packaging.Package)">
  1460. <summary>
  1461. This method returns the list of selected PackageRelationships as per the
  1462. given criteria, from a part in the Package provided
  1463. </summary>
  1464. <param name="package">Package object from which we get the relationships</param>
  1465. <returns></returns>
  1466. <exception cref="T:System.ArgumentNullException">If package parameter is null</exception>
  1467. </member>
  1468. <member name="T:System.IO.Packaging.PackageRelationshipSelectorType">
  1469. <summary>
  1470. Enum to represent the different selector types for PackageRelationshipSelector
  1471. </summary>
  1472. </member>
  1473. <member name="F:System.IO.Packaging.PackageRelationshipSelectorType.Id">
  1474. <summary>
  1475. Id
  1476. </summary>
  1477. </member>
  1478. <member name="F:System.IO.Packaging.PackageRelationshipSelectorType.Type">
  1479. <summary>
  1480. Type
  1481. </summary>
  1482. </member>
  1483. <member name="M:System.IO.Packaging.PackagingUtilities.PerformInitialReadAndVerifyEncoding(System.Xml.XmlReader)">
  1484. <summary>
  1485. This method is used to determine if we support a given Encoding as per the
  1486. OPC and XPS specs. Currently the only two encodings supported are UTF-8 and
  1487. UTF-16 (Little Endian and Big Endian)
  1488. </summary>
  1489. <param name="reader">XmlReader</param>
  1490. </member>
  1491. <member name="M:System.IO.Packaging.PackagingUtilities.GetNonXmlnsAttributeCount(System.Xml.XmlReader)">
  1492. <summary>
  1493. This method returns the count of xml attributes other than:
  1494. 1. xmlns="namespace"
  1495. 2. xmlns:someprefix="namespace"
  1496. Reader should be positioned at the Element whose attributes
  1497. are to be counted.
  1498. </summary>
  1499. <param name="reader"></param>
  1500. <returns>An integer indicating the number of non-xmlns attributes</returns>
  1501. </member>
  1502. <member name="F:System.IO.Packaging.PackagingUtilities.XmlNamespace">
  1503. <summary>
  1504. Synchronize access to IsolatedStorage methods that can step on each-other
  1505. </summary>
  1506. <remarks>See PS 1468964 for details.</remarks>
  1507. </member>
  1508. <member name="T:System.IO.Packaging.PackUriHelper">
  1509. <summary>
  1510. This class has the utility methods for composing and parsing an Uri of pack:// scheme
  1511. </summary>
  1512. <summary>
  1513. This class has the utility methods for composing and parsing an Uri of pack:// scheme
  1514. </summary>
  1515. </member>
  1516. <member name="M:System.IO.Packaging.PackUriHelper.CreatePartUri(System.Uri)">
  1517. <summary>
  1518. This method is used to create a valid part Uri given a relative URI
  1519. Makes sure that the URI -
  1520. 1. Relative
  1521. 2. Begins with '/'
  1522. 3. Does not begin with two "//"
  1523. 4. Does not end with "/"
  1524. 5. Does not have a fragment component
  1525. 6. Does the correct escaping
  1526. 7. And is refined correctly
  1527. </summary>
  1528. <param name="partUri">The relative uri that represents the part within a package</param>
  1529. <returns>Returns a relative URI with an absolute path that points to a part within a package</returns>
  1530. <exception cref="T:System.ArgumentNullException">If partUri parameter is null</exception>
  1531. <exception cref="T:System.ArgumentException">If partUri parameter is an absolute Uri</exception>
  1532. <exception cref="T:System.ArgumentException">If partUri parameter is empty</exception>
  1533. <exception cref="T:System.ArgumentException">If partUri parameter ends with "/"</exception>
  1534. <exception cref="T:System.ArgumentException">If partUri parameter starts with two "/"</exception>
  1535. <exception cref="T:System.ArgumentException">If partUri parameter has a fragment</exception>
  1536. </member>
  1537. <member name="M:System.IO.Packaging.PackUriHelper.ResolvePartUri(System.Uri,System.Uri)">
  1538. <summary>
  1539. This method is used to resolve part Uris
  1540. Constructs resolved relative URI from two relative URIs
  1541. This method should be used in places where we have a
  1542. a target URI in the PackageRelationship and we want to get the
  1543. name of the part it targets with respect to the source part
  1544. </summary>
  1545. <param name="sourcePartUri">This should be a valid partName.
  1546. The only exception to this rule is an Uri of the form "/". This uri
  1547. will only be used to resolve package level relationships. This Uri
  1548. indicates that the relative Uri is being resolved against the root of the
  1549. package.</param>
  1550. <param name="targetUri">This URI can be any relative URI</param>
  1551. <returns></returns>
  1552. <exception cref="T:System.ArgumentNullException">If either sourcePartUri or targetUri parameter is null</exception>
  1553. <exception cref="T:System.ArgumentException">If either sourcePartUri or targetUri parameter is an absolute Uri</exception>
  1554. <exception cref="T:System.ArgumentException">If sourcePartUri parameter does not conform to the valid partUri syntax</exception>
  1555. </member>
  1556. <member name="M:System.IO.Packaging.PackUriHelper.GetRelativeUri(System.Uri,System.Uri)">
  1557. <summary>
  1558. This method returns the relative uri between two given parts
  1559. </summary>
  1560. <param name="sourcePartUri"></param>
  1561. <param name="targetPartUri"></param>
  1562. <returns>The relative path between two parts</returns>
  1563. <exception cref="T:System.ArgumentNullException">If either the sourcePartUri or targetPartUri parameter is null</exception>
  1564. <exception cref="T:System.ArgumentException">If either sourcePartUri or targetPartUri parameter does not conform to the valid partUri syntax</exception>
  1565. </member>
  1566. <member name="M:System.IO.Packaging.PackUriHelper.GetNormalizedPartUri(System.Uri)">
  1567. <summary>
  1568. Returns the normalized form of the part URI
  1569. </summary>
  1570. <param name="partUri">Part Uri</param>
  1571. <returns>Normalized Part Uri</returns>
  1572. <exception cref="T:System.ArgumentNullException">If partUri is null</exception>
  1573. <exception cref="T:System.ArgumentException">If partUri parameter does not conform to the valid partUri syntax</exception>
  1574. </member>
  1575. <member name="M:System.IO.Packaging.PackUriHelper.ComparePartUri(System.Uri,System.Uri)">
  1576. <summary>
  1577. This method compares two part uris and returns an int to indicate the equivalence
  1578. Null values are allowed
  1579. </summary>
  1580. <param name="firstPartUri">First part Uri to be compared</param>
  1581. <param name="secondPartUri">Second part Uri to be compared</param>
  1582. <returns>A 32-bit signed integer indicating the lexical relationship between the compared Uri components.
  1583. Value - Less than zero means firstUri is less than secondUri
  1584. Value - Equal to zero means both the Uris are equal</returns>
  1585. Value - Greater than zero means firstUri is greater than secondUri
  1586. <exception cref="T:System.ArgumentException">If firstPartUri or secondPartUri parameter does not conform to the valid partUri syntax</exception>
  1587. </member>
  1588. <member name="M:System.IO.Packaging.PackUriHelper.IsRelationshipPartUri(System.Uri)">
  1589. <summary>
  1590. IsRelationshipPartUri method returns a boolean indicating whether the
  1591. Uri given is a relationship part Uri or not.
  1592. </summary>
  1593. <param name="partUri">uri of part to evaluate</param>
  1594. <returns>true if the given part is a PackageRelationship part</returns>
  1595. <remarks>Does not inspect the part contents - this is based solely on the name</remarks>
  1596. <exception cref="T:System.ArgumentNullException">If partUri parameter is null</exception>
  1597. <exception cref="T:System.ArgumentException">If partUri parameter is an absolute Uri</exception>
  1598. <exception cref="T:System.ArgumentException">If partUri parameter does not conform to the valid partUri Syntax</exception>
  1599. </member>
  1600. <member name="M:System.IO.Packaging.PackUriHelper.GetRelationshipPartUri(System.Uri)">
  1601. <summary>
  1602. This method returns a relationship part Uri given a part Uri
  1603. Example Input - partUri - /files/document.xaml
  1604. Return - Relationship Uri - /files/_rels/document.xaml.rels
  1605. If the input to the method is Uri - "/", then we will return /_rels/.rels as the
  1606. relationship part Uri for the Package level relationships
  1607. </summary>
  1608. <param name="partUri">Part Uri for which the relationship part Uri is wanted</param>
  1609. <returns>returns a Uri that conforms to the relationship part Uri syntax</returns>
  1610. <exception cref="T:System.ArgumentException">If the input Uri is a relationship part Uri itself</exception>
  1611. <exception cref="T:System.ArgumentNullException">If partUri parameter is null</exception>
  1612. <exception cref="T:System.ArgumentException">If partUri parameter is an absolute Uri</exception>
  1613. <exception cref="T:System.ArgumentException">If partUri parameter does not conform to the valid partUri Syntax</exception>
  1614. </member>
  1615. <member name="M:System.IO.Packaging.PackUriHelper.GetSourcePartUriFromRelationshipPartUri(System.Uri)">
  1616. <summary>
  1617. Given a valid relationship Part Uri, this method returns the source Part Uri for
  1618. this relationship Part Uri.
  1619. If the relationship part name is for the Package Level relationships [/_rels/.rels],
  1620. we return a relative Uri of the form "/" indicating that it has no part as the parent,
  1621. but is at the package level
  1622. Example Input - Relationship Uri - /files/_rels/document.xaml.rels
  1623. Returns -Source Part Uri - /files/document.xaml
  1624. </summary>
  1625. <param name="relationshipPartUri">relationship part Uri</param>
  1626. <returns>A uri that is a valid source part Uri for the relationship Uri provided</returns>
  1627. <exception cref="T:System.ArgumentNullException">If relationshipPartUri parameter is null</exception>
  1628. <exception cref="T:System.ArgumentException">If relationshipPartUri parameter is an absolute Uri</exception>
  1629. <exception cref="T:System.ArgumentException">If relationshipPartUri parameter does not conform to the valid partUri Syntax</exception>
  1630. <exception cref="T:System.ArgumentException">If the relationshipPartUri is not a relationship part Uri itself</exception>
  1631. <exception cref="T:System.ArgumentException">If the resultant Uri obtained is a relationship part Uri</exception>
  1632. </member>
  1633. <member name="M:System.IO.Packaging.PackUriHelper.ValidatePartUri(System.Uri)">
  1634. <summary>
  1635. This method is used to validate a part Uri
  1636. This method does not perform a case sensitive check of the Uri
  1637. </summary>
  1638. <param name="partUri">The string that represents the part within a package</param>
  1639. <returns>Returns the part uri if it is valid</returns>
  1640. <exception cref="T:System.ArgumentNullException">If partUri parameter is null</exception>
  1641. <exception cref="T:System.ArgumentException">If partUri parameter is an absolute Uri</exception>
  1642. <exception cref="T:System.ArgumentException">If partUri parameter is empty</exception>
  1643. <exception cref="T:System.ArgumentException">If partUri parameter does not start with a "/"</exception>
  1644. <exception cref="T:System.ArgumentException">If partUri parameter starts with two "/"</exception>
  1645. <exception cref="T:System.ArgumentException">If partUri parameter ends with a "/"</exception>
  1646. <exception cref="T:System.ArgumentException">If partUri parameter has a fragment</exception>
  1647. <exception cref="T:System.ArgumentException">If partUri parameter has some escaped characters that should not be escaped
  1648. or some characters that should be escaped are not escaped.</exception>
  1649. </member>
  1650. <member name="F:System.IO.Packaging.PackUriHelper.UriSchemePack">
  1651. <summary>
  1652. pack scheme name
  1653. </summary>
  1654. </member>
  1655. <member name="T:System.IO.Packaging.PackUriHelper.ValidatedPartUri">
  1656. <summary>
  1657. ValidatedPartUri class
  1658. Once the partUri has been validated as per the syntax in the OPC spec
  1659. we create a ValidatedPartUri, this way we do not have to re-validate
  1660. this.
  1661. This class is heavily used throughout the Packaging APIs and in order
  1662. to reduce the parsing and number of allocations for Strings and Uris
  1663. we cache the results after parsing.
  1664. </summary>
  1665. </member>
  1666. <member name="M:System.IO.Packaging.PackUriHelper.Create(System.Uri)">
  1667. <summary>
  1668. This method is used to create a valid pack Uri
  1669. </summary>
  1670. <param name="packageUri">This is the uri that points to the entire package.
  1671. This parameter should be an absolute Uri. This parameter cannot be null or empty
  1672. This method will create a valid pack uri that references the entire package</param>
  1673. <returns>A Uri with the "pack://" scheme</returns>
  1674. <exception cref="T:System.ArgumentNullException">If packageUri parameter is null</exception>
  1675. <exception cref="T:System.ArgumentException">If packageUri parameter is not an absolute Uri</exception>
  1676. </member>
  1677. <member name="M:System.IO.Packaging.PackUriHelper.Create(System.Uri,System.Uri)">
  1678. <summary>
  1679. This method is used to create a valid pack Uri
  1680. </summary>
  1681. <param name="packageUri">This is the uri that points to the entire package.
  1682. This parameter should be an absolute Uri. This parameter cannot be null or empty </param>
  1683. <param name="partUri">This is the uri that points to the part within the package
  1684. This parameter should be a relative Uri.
  1685. This parameter can be null in which case we will create a valid pack uri
  1686. that references the entire package</param>
  1687. <returns>A Uri with the "pack://" scheme</returns>
  1688. <exception cref="T:System.ArgumentNullException">If packageUri parameter is null</exception>
  1689. <exception cref="T:System.ArgumentException">If packageUri parameter is not an absolute Uri</exception>
  1690. <exception cref="T:System.ArgumentException">If partUri parameter does not conform to the valid partUri syntax</exception>
  1691. </member>
  1692. <member name="M:System.IO.Packaging.PackUriHelper.Create(System.Uri,System.Uri,System.String)">
  1693. <summary>
  1694. This method is used to create a valid pack Uri
  1695. </summary>
  1696. <param name="packageUri">This is the uri that points to the entire package.
  1697. This parameter should be an absolute Uri. This parameter cannot be null or empty </param>
  1698. <param name="partUri">This is the uri that points to the part within the package
  1699. This parameter should be a relative Uri.
  1700. This parameter can be null in which case we will create a valid pack uri
  1701. that references the entire package</param>
  1702. <param name="fragment">Fragment for the resulting Pack URI. This parameter can be null
  1703. The fragment string must start with a "#"</param>
  1704. <returns>A Uri with the "pack://" scheme</returns>
  1705. <exception cref="T:System.ArgumentNullException">If packageUri parameter is null</exception>
  1706. <exception cref="T:System.ArgumentException">If packageUri parameter is not an absolute Uri</exception>
  1707. <exception cref="T:System.ArgumentException">If partUri parameter does not conform to the valid partUri syntax</exception>
  1708. <exception cref="T:System.ArgumentException">If fragment parameter is empty or does not start with a "#"</exception>
  1709. </member>
  1710. <member name="M:System.IO.Packaging.PackUriHelper.GetPackageUri(System.Uri)">
  1711. <summary>
  1712. This method parses the pack uri and returns the inner
  1713. Uri that points to the package as a whole.
  1714. </summary>
  1715. <param name="packUri">Uri which has pack:// scheme</param>
  1716. <returns>Returns the inner uri that points to the entire package</returns>
  1717. <exception cref="T:System.ArgumentNullException">If packUri parameter is null</exception>
  1718. <exception cref="T:System.ArgumentException">If packUri parameter is not an absolute Uri</exception>
  1719. <exception cref="T:System.ArgumentException">If packUri parameter does not have "pack://" scheme</exception>
  1720. <exception cref="T:System.ArgumentException">If inner packageUri extracted from the packUri has a fragment component</exception>
  1721. </member>
  1722. <member name="M:System.IO.Packaging.PackUriHelper.GetPartUri(System.Uri)">
  1723. <summary>
  1724. This method parses the pack uri and returns the absolute
  1725. path of the URI. This corresponds to the part within the
  1726. package. This corresponds to the absolute path component in
  1727. the Uri. If there is no part component present, this method
  1728. returns a null
  1729. </summary>
  1730. <param name="packUri">Returns a relative Uri that represents the
  1731. part within the package. If the pack Uri points to the entire
  1732. package then we return a null</param>
  1733. <returns>Returns a relative URI with an absolute path that points to a part within a package</returns>
  1734. <exception cref="T:System.ArgumentNullException">If packUri parameter is null</exception>
  1735. <exception cref="T:System.ArgumentException">If packUri parameter is not an absolute Uri</exception>
  1736. <exception cref="T:System.ArgumentException">If packUri parameter does not have "pack://" scheme</exception>
  1737. <exception cref="T:System.ArgumentException">If partUri extracted from packUri does not conform to the valid partUri syntax</exception>
  1738. </member>
  1739. <member name="M:System.IO.Packaging.PackUriHelper.ComparePackUri(System.Uri,System.Uri)">
  1740. <summary>
  1741. This method compares two pack uris and returns an int to indicate the equivalence.
  1742. </summary>
  1743. <param name="firstPackUri">First Uri of pack:// scheme to be compared</param>
  1744. <param name="secondPackUri">Second Uri of pack:// scheme to be compared</param>
  1745. <returns>A 32-bit signed integer indicating the lexical relationship between the compared Uri components.
  1746. Value - Less than zero means firstUri is less than secondUri
  1747. Value - Equal to zero means both the Uris are equal
  1748. Value - Greater than zero means firstUri is greater than secondUri </returns>
  1749. <exception cref="T:System.ArgumentException">If either of the Uris are not absolute or if either of the Uris are not with pack:// scheme</exception>
  1750. <exception cref="T:System.ArgumentException">If firstPackUri or secondPackUri parameter is not an absolute Uri</exception>
  1751. <exception cref="T:System.ArgumentException">If firstPackUri or secondPackUri parameter does not have "pack://" scheme</exception>
  1752. </member>
  1753. <member name="M:System.IO.Packaging.PackUriHelper.ValidatePackageUri(System.Uri)">
  1754. <summary>
  1755. This method is used to validate the package uri
  1756. </summary>
  1757. <param name="packageUri"></param>
  1758. <returns></returns>
  1759. </member>
  1760. <member name="M:System.IO.Packaging.PackUriHelper.EscapeSpecialCharacters(System.String)">
  1761. <summary>
  1762. Escapes - %', '@', ',', '?' in the package URI
  1763. This method modifies the string in a culture safe and case safe manner.
  1764. </summary>
  1765. <param name="path"></param>
  1766. <returns></returns>
  1767. </member>
  1768. <member name="T:System.IO.Packaging.PartBasedPackageProperties">
  1769. <summary>
  1770. The package properties are a subset of the standard OLE property sets
  1771. SummaryInformation and DocumentSummaryInformation, and include such properties
  1772. as Title and Subject.
  1773. </summary>
  1774. <remarks>
  1775. <para>Setting a property to null deletes this property. 'null' is never strictly speaking
  1776. a property value, but an absence indicator.</para>
  1777. </remarks>
  1778. </member>
  1779. <member name="P:System.IO.Packaging.PartBasedPackageProperties.Creator">
  1780. <value>
  1781. The primary creator. The identification is environment-specific and
  1782. can consist of a name, email address, employee ID, etc. It is
  1783. recommended that this value be only as verbose as necessary to
  1784. identify the individual.
  1785. </value>
  1786. </member>
  1787. <member name="P:System.IO.Packaging.PartBasedPackageProperties.Title">
  1788. <value>
  1789. The title.
  1790. </value>
  1791. </member>
  1792. <member name="P:System.IO.Packaging.PartBasedPackageProperties.Subject">
  1793. <value>
  1794. The topic of the contents.
  1795. </value>
  1796. </member>
  1797. <member name="P:System.IO.Packaging.PartBasedPackageProperties.Category">
  1798. <value>
  1799. The category. This value is typically used by UI applications to create navigation
  1800. controls.
  1801. </value>
  1802. </member>
  1803. <member name="P:System.IO.Packaging.PartBasedPackageProperties.Keywords">
  1804. <value>
  1805. A delimited set of keywords to support searching and indexing. This
  1806. is typically a list of terms that are not available elsewhere in the
  1807. properties.
  1808. </value>
  1809. </member>
  1810. <member name="P:System.IO.Packaging.PartBasedPackageProperties.Description">
  1811. <value>
  1812. The description or abstract of the contents.
  1813. </value>
  1814. </member>
  1815. <member name="P:System.IO.Packaging.PartBasedPackageProperties.ContentType">
  1816. <value>
  1817. The type of content represented, generally defined by a specific
  1818. use and intended audience. Example values include "Whitepaper",
  1819. "Security Bulletin", and "Exam". (This property is distinct from
  1820. MIME content types as defined in RFC 2616.)
  1821. </value>
  1822. </member>
  1823. <member name="P:System.IO.Packaging.PartBasedPackageProperties.ContentStatus">
  1824. <value>
  1825. The status of the content. Example values include "Draft",
  1826. "Reviewed", and "Final".
  1827. </value>
  1828. </member>
  1829. <member name="P:System.IO.Packaging.PartBasedPackageProperties.Version">
  1830. <value>
  1831. The version number. This value is set by the user or by the application.
  1832. </value>
  1833. </member>
  1834. <member name="P:System.IO.Packaging.PartBasedPackageProperties.Revision">
  1835. <value>
  1836. The revision number. This value indicates the number of saves or
  1837. revisions. The application is responsible for updating this value
  1838. after each revision.
  1839. </value>
  1840. </member>
  1841. <member name="P:System.IO.Packaging.PartBasedPackageProperties.Created">
  1842. <value>
  1843. The creation date and time.
  1844. </value>
  1845. </member>
  1846. <member name="P:System.IO.Packaging.PartBasedPackageProperties.Modified">
  1847. <value>
  1848. The date and time of the last modification.
  1849. </value>
  1850. </member>
  1851. <member name="P:System.IO.Packaging.PartBasedPackageProperties.LastModifiedBy">
  1852. <value>
  1853. The user who performed the last modification. The identification is
  1854. environment-specific and can consist of a name, email address,
  1855. employee ID, etc. It is recommended that this value be only as
  1856. verbose as necessary to identify the individual.
  1857. </value>
  1858. </member>
  1859. <member name="P:System.IO.Packaging.PartBasedPackageProperties.LastPrinted">
  1860. <value>
  1861. The date and time of the last printing.
  1862. </value>
  1863. </member>
  1864. <member name="P:System.IO.Packaging.PartBasedPackageProperties.Language">
  1865. <value>
  1866. A language of the intellectual content of the resource
  1867. </value>
  1868. </member>
  1869. <member name="P:System.IO.Packaging.PartBasedPackageProperties.Identifier">
  1870. <value>
  1871. A unique identifier.
  1872. </value>
  1873. </member>
  1874. <member name="T:System.IO.Packaging.TargetMode">
  1875. <summary>
  1876. The TargetMode enumeration is used to interpret the
  1877. "base" uri for the PackageRelationship target Uri.
  1878. Possible values -
  1879. 0: "Internal" - target points to a part within the package
  1880. PackageRelationship target uri must be relative.
  1881. 1: "External" - target points to an external resource. The
  1882. resource can be relative to the package entity
  1883. or an absolute URI
  1884. </summary>
  1885. </member>
  1886. <member name="F:System.IO.Packaging.TargetMode.Internal">
  1887. <summary>
  1888. TargetMode is "Internal".
  1889. PackageRelationship target points to a part within the package
  1890. PackageRelationship target uri must be relative.
  1891. </summary>
  1892. </member>
  1893. <member name="F:System.IO.Packaging.TargetMode.External">
  1894. <summary>
  1895. TargetMode is "External".
  1896. PackageRelationship target points to an external resource.
  1897. PackageRelationship target uri can be relative or absolute.
  1898. The resource can be relative to the package entity or an absolute URI.
  1899. </summary>
  1900. </member>
  1901. <member name="M:System.IO.Packaging.XmlCompatibilityReader.DeclareNamespaceCompatibility(System.String,System.String)">
  1902. <summary>
  1903. replaces all future references of namespace URI 'oldNamespace' with 'newNamespace'
  1904. </summary>
  1905. <param name="newNamespace">
  1906. the namespace to subsume with
  1907. </param>
  1908. <param name="oldNamespace">
  1909. the namespace to be subsumed
  1910. </param>
  1911. </member>
  1912. <member name="M:System.IO.Packaging.XmlCompatibilityReader.Read">
  1913. <summary>
  1914. Reads the next node from the stream.
  1915. </summary>
  1916. <returns>
  1917. true if the next node was read successfully; false if there are no more nodes to read.
  1918. </returns>
  1919. </member>
  1920. <member name="M:System.IO.Packaging.XmlCompatibilityReader.ReadStartElement(System.Boolean@)">
  1921. <summary>
  1922. Used to handle 'start element' tags. These are actually
  1923. just called 'element' tags, the 'start' is just for clarity
  1924. </summary>
  1925. <param name="more">
  1926. is set to true if there is the document contains more elements, false if the end of the
  1927. document has been reached.
  1928. </param>
  1929. <returns>
  1930. true if an element was read that should not be ignored
  1931. false if the element read should be ignored or the end of document has been reached
  1932. </returns>
  1933. </member>
  1934. <member name="M:System.IO.Packaging.XmlCompatibilityReader.ReadEndElement(System.Boolean@)">
  1935. <summary>
  1936. Used to handle any end element tag
  1937. </summary>
  1938. <param name="more">
  1939. is set to true if there is the document contains more elements, false if the end of the
  1940. document has been reached.
  1941. </param>
  1942. <returns>
  1943. true if an element was read that should not be ignored
  1944. false if the element read should be ignored or the end of document has been reached
  1945. </returns>
  1946. </member>
  1947. <member name="M:System.IO.Packaging.XmlCompatibilityReader.GetAttribute(System.Int32)">
  1948. <summary>
  1949. Gets the value of the attribute with the specified index.
  1950. </summary>
  1951. <param name="i">
  1952. The index of the attribute. The index is zero-based. (The first attribute has index 0.)
  1953. </param>
  1954. <returns>
  1955. The value of the specified attribute. If the attribute is not found, a null reference is returned.
  1956. </returns>
  1957. </member>
  1958. <member name="M:System.IO.Packaging.XmlCompatibilityReader.GetAttribute(System.String)">
  1959. <summary>
  1960. Gets the value of the attribute with the specified name.
  1961. </summary>
  1962. <param name="name">
  1963. The qualified name of the attribute.
  1964. </param>
  1965. <returns>
  1966. The value of the specified attribute. If the attribute is not found, a null reference is returned.
  1967. </returns>
  1968. </member>
  1969. <member name="M:System.IO.Packaging.XmlCompatibilityReader.GetAttribute(System.String,System.String)">
  1970. <summary>
  1971. Gets the value of the attribute with the specified local name and namespace URI.
  1972. </summary>
  1973. <param name="localName">
  1974. The local name of the attribute.
  1975. </param>
  1976. <param name="namespaceURI">
  1977. The namespace URI of the attribute.
  1978. </param>
  1979. <returns>
  1980. The value of the specified attribute. If the attribute is not found, a null reference is returned.
  1981. </returns>
  1982. </member>
  1983. <member name="M:System.IO.Packaging.XmlCompatibilityReader.MoveToAttribute(System.Int32)">
  1984. <summary>
  1985. Gets the value of the attribute with the specified index.
  1986. </summary>
  1987. <param name="i">
  1988. The index of the attribute. The index is zero-based. (The first attribute has index 0.)
  1989. </param>
  1990. </member>
  1991. <member name="M:System.IO.Packaging.XmlCompatibilityReader.MoveToAttribute(System.String)">
  1992. <summary>
  1993. Moves to the attribute with the specified name.
  1994. </summary>
  1995. <param name="name">
  1996. The qualified name of the attribute.
  1997. </param>
  1998. <returns>
  1999. true if the attribute is found; otherwise, false. If false, the reader's position does not change.
  2000. </returns>
  2001. </member>
  2002. <member name="M:System.IO.Packaging.XmlCompatibilityReader.MoveToAttribute(System.String,System.String)">
  2003. <summary>
  2004. Moves to the attribute with the specified local name and namespace URI.
  2005. </summary>
  2006. <param name="localName">
  2007. The local name of the attribute.
  2008. </param>
  2009. <param name="namespaceURI">
  2010. The namespace URI of the attribute.
  2011. </param>
  2012. <returns>
  2013. true if the attribute is found; otherwise, false. If false, the reader's position does not change.
  2014. </returns>
  2015. </member>
  2016. <member name="M:System.IO.Packaging.XmlCompatibilityReader.MoveToFirstAttribute">
  2017. <summary>
  2018. Moves to the first attribute.
  2019. </summary>
  2020. <returns>
  2021. true if an attribute exists (the reader moves to the first attribute);
  2022. otherwise, false (the position of the reader does not change).
  2023. </returns>
  2024. </member>
  2025. <member name="M:System.IO.Packaging.XmlCompatibilityReader.MoveToNextAttribute">
  2026. <summary>
  2027. Moves to the next attribute.
  2028. </summary>
  2029. <returns>
  2030. true if there is a next attribute; false if there are no more attributes.
  2031. </returns>
  2032. </member>
  2033. <member name="M:System.IO.Packaging.XmlCompatibilityReader.LookupNamespace(System.String)">
  2034. <summary>
  2035. Resolves a namespace prefix in the current element's scope.
  2036. </summary>
  2037. <param name="prefix">
  2038. The prefix whose namespace URI you want to resolve. To match the default namespace,
  2039. pass an empty string. This string does not have to be atomized.
  2040. </param>
  2041. <returns>
  2042. The namespace URI to which the prefix maps or a null reference if no matching prefix is found.
  2043. </returns>
  2044. </member>
  2045. <member name="P:System.IO.Packaging.XmlCompatibilityReader.Value">
  2046. <summary>
  2047. This override is to ensure that the value
  2048. for the xmlns attribute reflects all the
  2049. compatibility (subsuming) rules.
  2050. </summary>
  2051. </member>
  2052. <member name="P:System.IO.Packaging.XmlCompatibilityReader.NamespaceURI">
  2053. <summary>
  2054. Gets the namespace URI (as defined in the W3C Namespace specification) of the node
  2055. on which the reader is positioned.
  2056. </summary>
  2057. </member>
  2058. <member name="P:System.IO.Packaging.XmlCompatibilityReader.Depth">
  2059. <summary>
  2060. Gets the depth of the current node in the XML document.
  2061. </summary>
  2062. </member>
  2063. <member name="P:System.IO.Packaging.XmlCompatibilityReader.HasAttributes">
  2064. <summary>
  2065. Gets a value indicating whether the current node has any attributes
  2066. </summary>
  2067. </member>
  2068. <member name="P:System.IO.Packaging.XmlCompatibilityReader.AttributeCount">
  2069. <summary>
  2070. Gets the number of attributes on the current node.
  2071. </summary>
  2072. </member>
  2073. <member name="M:System.IO.Packaging.XmlCompatibilityReader.GetMappedNamespace(System.String)">
  2074. <summary>
  2075. Retrieves the correctly mapped namespace from the namespace provided
  2076. </summary>
  2077. <param name="namespaceName">
  2078. The name of the namespace to retrieve the mapping of
  2079. </param>
  2080. <returns>
  2081. The name of the mapped namespace.
  2082. </returns>
  2083. </member>
  2084. <member name="M:System.IO.Packaging.XmlCompatibilityReader.MapNewNamespace(System.String)">
  2085. <summary>
  2086. Adds the namespace to the namespace map. The default is to map the namespace to itself.
  2087. The namespace is mapped to the value returned by the callback, if a callback exists and the
  2088. callback returns a subsuming namespace.
  2089. </summary>
  2090. <param name="namespaceName">
  2091. The name of the namespace to be mapped.
  2092. </param>
  2093. <returns>
  2094. The name of the mapped namespace.
  2095. </returns>
  2096. </member>
  2097. <member name="M:System.IO.Packaging.XmlCompatibilityReader.IsSubsumingNamespace(System.String)">
  2098. <summary>
  2099. Used to determine whether a given namespace subsumes another namespace
  2100. </summary>
  2101. <param name="namespaceName">
  2102. The name of the namespace to be checked.
  2103. </param>
  2104. <returns>
  2105. true if the namespace subsumes another namespace; false otherwise
  2106. </returns>
  2107. </member>
  2108. <member name="M:System.IO.Packaging.XmlCompatibilityReader.AddSubsumingNamespace(System.String)">
  2109. <summary>
  2110. Used to specify that a namespace subsumes another namespace
  2111. </summary>
  2112. <param name="namespaceName">
  2113. The name of the namespace to be added.
  2114. </param>
  2115. </member>
  2116. <member name="M:System.IO.Packaging.XmlCompatibilityReader.IsNamespaceKnown(System.String)">
  2117. <summary>
  2118. Used to determine whether a given namespace is known/supported
  2119. </summary>
  2120. <param name="namespaceName">
  2121. The name of the namespace to be checked.
  2122. </param>
  2123. <returns>
  2124. true if the namespace is known/supported; false otherwise
  2125. </returns>
  2126. </member>
  2127. <member name="M:System.IO.Packaging.XmlCompatibilityReader.AddKnownNamespace(System.String)">
  2128. <summary>
  2129. Used to specify that a namespace is known or supported
  2130. </summary>
  2131. <param name="namespaceName">
  2132. The name of the namespace to be added.
  2133. </param>
  2134. </member>
  2135. <member name="M:System.IO.Packaging.XmlCompatibilityReader.ShouldIgnoreNamespace(System.String)">
  2136. <summary>
  2137. Used to determine whether a given namespace should be ignored. A namespace should be ignored if:
  2138. EITHER
  2139. a) the namespace is not known/supported and has been marked Ignorable
  2140. OR
  2141. b) the namespace is the markup-compatibility namespace
  2142. </summary>
  2143. <param name="namespaceName">
  2144. The name of the prefix to be checked.
  2145. </param>
  2146. <returns>
  2147. true if the namespace should be ignored; false otherwise
  2148. </returns>
  2149. </member>
  2150. <member name="M:System.IO.Packaging.XmlCompatibilityReader.ParseContentToNamespaceElementPair(System.String,System.String)">
  2151. <summary>
  2152. breaks up a space-delineated string into namespace/element pairs
  2153. </summary>
  2154. <param name="content">
  2155. the string to be parsed
  2156. </param>
  2157. <param name="callerContext">
  2158. The calling element, used in case of an error
  2159. </param>
  2160. <returns>
  2161. the list of namespace/element pairs
  2162. </returns>
  2163. </member>
  2164. <member name="M:System.IO.Packaging.XmlCompatibilityReader.PrefixesToNamespaces(System.String)">
  2165. <summary>
  2166. converts a string of space-delineated prefixes into a list of namespaces
  2167. </summary>
  2168. <param name="prefixes">
  2169. the string to be parsed
  2170. </param>
  2171. <returns>
  2172. the list of namespace/element pairs
  2173. </returns>
  2174. </member>
  2175. <member name="M:System.IO.Packaging.XmlCompatibilityReader.SkipToKnownAttribute">
  2176. <summary>
  2177. advances the reader to the next known namespace/attribute pair
  2178. </summary>
  2179. <returns>
  2180. true if a known namespace/attribute pair was found
  2181. </returns>
  2182. </member>
  2183. <member name="M:System.IO.Packaging.XmlCompatibilityReader.ScanForCompatibility(System.Int32)">
  2184. <summary>
  2185. Scans the current element for compatibility attributes. Pushes a new
  2186. scope onto the stack under the following conditions:
  2187. 1) Ignorable or MustUnderstand attribute read
  2188. 2) current element has not previously declared an Ignorable or
  2189. MustUnderstand attribute
  2190. However, if a last condition is not fulfilled, then the scope is popped off
  2191. before the function returns
  2192. 3) current element is not empty
  2193. stores in _ignoredAttributeCount the number of attributes on the current element
  2194. that should be ignored, for the sake of improving perf in attribute-related
  2195. methods/properties
  2196. </summary>
  2197. <param name="elementDepth">
  2198. the depth of the Reader at the element currently being processed
  2199. </param>
  2200. </member>
  2201. <member name="M:System.IO.Packaging.XmlCompatibilityReader.ScanForEndCompatibility(System.Int32)">
  2202. <summary>
  2203. pops a scope if the end of a compatibility region.
  2204. </summary>
  2205. <param name="elementDepth">
  2206. the depth of the Reader at the element currently being processed
  2207. </param>
  2208. </member>
  2209. <member name="M:System.IO.Packaging.XmlCompatibilityReader.PushScope(System.Int32)">
  2210. <summary>
  2211. pushes a new scope onto the stack with a depth passed as an arg.
  2212. PushScope does not push a scope if the top scope on the stack is not a lower depth.
  2213. </summary>
  2214. <param name="elementDepth">
  2215. the depth of the Reader at the element currently being processed
  2216. </param>
  2217. </member>
  2218. <member name="M:System.IO.Packaging.XmlCompatibilityReader.PopScope">
  2219. <summary>
  2220. pops a scope off the top of the stack.
  2221. PopScope *always* pops, it does not check the depth before doing so
  2222. </summary>
  2223. </member>
  2224. <member name="M:System.IO.Packaging.XmlCompatibilityReader.HandleAlternateContent(System.Int32,System.Boolean@)">
  2225. <summary>
  2226. handles mc:AlternateContent element
  2227. a good way to think of AlternateContent blocks is as a switch/case
  2228. statement. The AlternateContent tag is like switch, Choice is like
  2229. case, and Fallback is like default.
  2230. </summary>
  2231. <param name="elementDepth">
  2232. the depth of the Reader at the element currently being processed
  2233. </param>
  2234. <param name="more">
  2235. returns whether the Reader has more to be read
  2236. </param>
  2237. </member>
  2238. <member name="M:System.IO.Packaging.XmlCompatibilityReader.HandleChoice(System.Int32,System.Boolean@)">
  2239. <summary>
  2240. handles mc:Choice element
  2241. a good way to think of AlternateContent blocks is as a switch/case
  2242. statement. The AlternateContent tag is like switch, Choice is like
  2243. case, and Fallback is like default.
  2244. </summary>
  2245. <param name="elementDepth">
  2246. the depth of the Reader at the element currently being processed
  2247. </param>
  2248. <param name="more">
  2249. returns whether the Reader has more to be read
  2250. </param>
  2251. </member>
  2252. <member name="M:System.IO.Packaging.XmlCompatibilityReader.HandleFallback(System.Int32,System.Boolean@)">
  2253. <summary>
  2254. handles mc:Fallback element
  2255. a good way to think of AlternateContent blocks is as a switch/case
  2256. statement. The AlternateContent tag is like switch, Choice is like
  2257. case, and Fallback is like default.
  2258. </summary>
  2259. <param name="elementDepth">
  2260. the depth of the Reader at the element currently being processed
  2261. </param>
  2262. <param name="more">
  2263. returns whether the Reader has more to be read
  2264. </param>
  2265. </member>
  2266. <member name="M:System.IO.Packaging.XmlCompatibilityReader.HandleIgnorable(System.Int32)">
  2267. <summary>
  2268. handles mc:Ignorable="foo" attribute
  2269. Ignorable is used to indicate that the namespace the prefix is mapped to can
  2270. be ignored, i.e. when the namespace/element or namespace/attribute occurs it
  2271. is not returned by the reader.
  2272. </summary>
  2273. </member>
  2274. <member name="M:System.IO.Packaging.XmlCompatibilityReader.HandleMustUnderstand(System.Int32)">
  2275. <summary>
  2276. handles mc:MustUnderstand="foo" attribute
  2277. MustUnderstand is used to indicate that the namespace the prefix is mapped to
  2278. cannot be handled, and if it is not understood an exception is thrown
  2279. </summary>
  2280. </member>
  2281. <member name="M:System.IO.Packaging.XmlCompatibilityReader.HandleProcessContent(System.Int32)">
  2282. <summary>
  2283. handles mc:ProcessContent="foo:bar" attribute
  2284. ProcessContent is used to indicate that an ignorable namespace has some
  2285. elements that should be skipped, but contain child elements that should be processed.
  2286. The wildcard token ("foo:*") indicates that the children of any element in that
  2287. namespace should be processed.
  2288. </summary>
  2289. </member>
  2290. <member name="M:System.IO.Packaging.XmlCompatibilityReader.HandlePreserveElements(System.Int32)">
  2291. <summary>
  2292. handles mc:PreserveElements="foo:bar" attribute
  2293. functionality is supported, but not implemented
  2294. </summary>
  2295. </member>
  2296. <member name="M:System.IO.Packaging.XmlCompatibilityReader.HandlePreserveAttributes(System.Int32)">
  2297. <summary>
  2298. handles mc:PreserveAttributes="foo:bar" attribute
  2299. functionality is supported, but not implemented
  2300. </summary>
  2301. </member>
  2302. <member name="M:System.IO.Packaging.XmlCompatibilityReader.Error(System.String,System.Object[])">
  2303. <summary>
  2304. helper method to generate an exception
  2305. </summary>
  2306. </member>
  2307. <member name="T:System.IO.Packaging.XmlCompatibilityReader.CompatibilityScope">
  2308. <summary>
  2309. CompatibilityScopes are used to handle markup-compatibility elements and attributes.
  2310. Each scope stores the "previous" or parent scope, its depth, and an associated XmlCompatibilityReader.
  2311. At a particular Reader depth, only one scope should be pushed.
  2312. </summary>
  2313. </member>
  2314. <member name="T:System.IO.Packaging.ZipPackage">
  2315. <summary>
  2316. ZipPackage is a specific implementation for the abstract Package
  2317. class, corresponding to the Zip file format.
  2318. This is a part of the Packaging Layer APIs.
  2319. </summary>
  2320. </member>
  2321. <member name="M:System.IO.Packaging.ZipPackage.CreatePartCore(System.Uri,System.String,System.IO.Packaging.CompressionOption)">
  2322. <summary>
  2323. This method is for custom implementation for the underlying file format
  2324. Adds a new item to the zip archive corresponding to the PackagePart in the package.
  2325. </summary>
  2326. <param name="partUri">PartName</param>
  2327. <param name="contentType">Content type of the part</param>
  2328. <param name="compressionOption">Compression option for this part</param>
  2329. <returns></returns>
  2330. <exception cref="T:System.ArgumentNullException">If partUri parameter is null</exception>
  2331. <exception cref="T:System.ArgumentNullException">If contentType parameter is null</exception>
  2332. <exception cref="T:System.ArgumentException">If partUri parameter does not conform to the valid partUri syntax</exception>
  2333. <exception cref="T:System.ArgumentOutOfRangeException">If CompressionOption enumeration [compressionOption] does not have one of the valid values</exception>
  2334. </member>
  2335. <member name="M:System.IO.Packaging.ZipPackage.GetPartCore(System.Uri)">
  2336. <summary>
  2337. This method is for custom implementation specific to the file format.
  2338. Returns the part after reading the actual physical bits. The method
  2339. returns a null to indicate that the part corresponding to the specified
  2340. Uri was not found in the container.
  2341. This method does not throw an exception if a part does not exist.
  2342. </summary>
  2343. <param name="partUri"></param>
  2344. <returns></returns>
  2345. </member>
  2346. <member name="M:System.IO.Packaging.ZipPackage.DeletePartCore(System.Uri)">
  2347. <summary>
  2348. This method is for custom implementation specific to the file format.
  2349. Deletes the part corresponding to the uri specified. Deleting a part that does not
  2350. exists is not an error and so we do not throw an exception in that case.
  2351. </summary>
  2352. <param name="partUri"></param>
  2353. <exception cref="T:System.ArgumentNullException">If partUri parameter is null</exception>
  2354. <exception cref="T:System.ArgumentException">If partUri parameter does not conform to the valid partUri syntax</exception>
  2355. </member>
  2356. <member name="M:System.IO.Packaging.ZipPackage.GetPartsCore">
  2357. <summary>
  2358. This method is for custom implementation specific to the file format.
  2359. This is the method that knows how to get the actual parts from the underlying
  2360. zip archive.
  2361. </summary>
  2362. <remarks>
  2363. <para>
  2364. Some or all of the parts may be interleaved. The Part object for an interleaved part encapsulates
  2365. the Uri of the proper part name and the ZipFileInfo of the initial piece.
  2366. This function does not go through the extra work of checking piece naming validity
  2367. throughout the package.
  2368. </para>
  2369. <para>
  2370. This means that interleaved parts without an initial piece will be silently ignored.
  2371. Other naming anomalies get caught at the Stream level when an I/O operation involves
  2372. an anomalous or missing piece.
  2373. </para>
  2374. <para>
  2375. This function reads directly from the underlying IO layer and is supposed to be called
  2376. just once in the lifetime of a package (at init time).
  2377. </para>
  2378. </remarks>
  2379. <returns>An array of ZipPackagePart.</returns>
  2380. </member>
  2381. <member name="M:System.IO.Packaging.ZipPackage.FlushCore">
  2382. <summary>
  2383. This method is for custom implementation corresponding to the underlying zip file format.
  2384. </summary>
  2385. </member>
  2386. <member name="M:System.IO.Packaging.ZipPackage.Dispose(System.Boolean)">
  2387. <summary>
  2388. Closes the underlying ZipArchive object for this container
  2389. </summary>
  2390. <param name="disposing">True if called during Dispose, false if called during Finalize</param>
  2391. </member>
  2392. <member name="M:System.IO.Packaging.ZipPackage.#ctor(System.String,System.IO.FileMode,System.IO.FileAccess,System.IO.FileShare)">
  2393. <summary>
  2394. Internal constructor that is called by the OpenOnFile static method.
  2395. </summary>
  2396. <param name="path">File path to the container.</param>
  2397. <param name="packageFileMode">Container is opened in the specified mode if possible</param>
  2398. <param name="packageFileAccess">Container is opened with the specified access if possible</param>
  2399. <param name="share">Container is opened with the specified share if possible</param>
  2400. </member>
  2401. <member name="M:System.IO.Packaging.ZipPackage.#ctor(System.IO.Stream,System.IO.FileMode,System.IO.FileAccess)">
  2402. <summary>
  2403. Internal constructor that is called by the Open(Stream) static methods.
  2404. </summary>
  2405. <param name="s"></param>
  2406. <param name="packageFileMode"></param>
  2407. <param name="packageFileAccess"></param>
  2408. </member>
  2409. <member name="T:System.IO.Packaging.ZipPackage.ExtensionEqualityComparer">
  2410. <summary>
  2411. ExtensionComparer
  2412. The Extensions are stored in the Default Dictionary in their original form,
  2413. however they are compared in a normalized manner.
  2414. Equivalence for extensions in the content type stream, should follow
  2415. the same rules as extensions of partnames. Also, by the time this code is invoked,
  2416. we have already validated, that the extension is in the correct format as per the
  2417. part name rules.So we are simplifying the logic here to just convert the extensions
  2418. to Upper invariant form and then compare them.
  2419. </summary>
  2420. </member>
  2421. <member name="T:System.IO.Packaging.ZipPackage.ContentTypeHelper">
  2422. <summary>
  2423. This is a helper class that maintains the Content Types File related to
  2424. this ZipPackage.
  2425. </summary>
  2426. </member>
  2427. <member name="M:System.IO.Packaging.ZipPackage.ContentTypeHelper.#ctor(System.IO.Compression.ZipArchive,System.IO.FileMode,System.IO.FileAccess,System.IO.Packaging.ZipStreamManager)">
  2428. <summary>
  2429. Initialize the object without uploading any information from the package.
  2430. Complete initialization in read mode also involves calling ParseContentTypesFile
  2431. to deserialize content type information.
  2432. </summary>
  2433. </member>
  2434. <member name="M:System.IO.Packaging.ZipPackage.ContentTypeHelper.OpenContentTypeStream(System.Collections.ObjectModel.ReadOnlyCollection{System.IO.Compression.ZipArchiveEntry})">
  2435. <summary>
  2436. Find the content type stream, allowing for interleaving. Naming collisions
  2437. (as between an atomic and an interleaved part) will result in an exception being thrown.
  2438. Return null if no content type stream has been found.
  2439. </summary>
  2440. <remarks>
  2441. The input array is lexicographically sorted
  2442. </remarks>
  2443. </member>
  2444. <member name="T:System.IO.Packaging.ZipPackagePart">
  2445. <summary>
  2446. This class represents a Part within a Zip container.
  2447. This is a part of the Packaging Layer APIs.
  2448. This implementation is specific to the Zip file format.
  2449. </summary>
  2450. </member>
  2451. <member name="M:System.IO.Packaging.ZipPackagePart.GetStreamCore(System.IO.FileMode,System.IO.FileAccess)">
  2452. <summary>
  2453. Custom Implementation for the GetStream Method
  2454. </summary>
  2455. <param name="streamFileMode">Mode in which the stream should be opened</param>
  2456. <param name="streamFileAccess">Access with which the stream should be opened</param>
  2457. <returns>Stream Corresponding to this part</returns>
  2458. </member>
  2459. <member name="M:System.IO.Packaging.ZipPackagePart.#ctor(System.IO.Packaging.ZipPackage,System.IO.Compression.ZipArchive,System.IO.Compression.ZipArchiveEntry,System.IO.Packaging.ZipStreamManager,System.IO.Packaging.PackUriHelper.ValidatedPartUri,System.String,System.IO.Packaging.CompressionOption)">
  2460. <summary>
  2461. Constructs a ZipPackagePart for an atomic (i.e. non-interleaved) part.
  2462. This is called from the ZipPackage class as a result of GetPartCore,
  2463. GetPartsCore or CreatePartCore methods
  2464. </summary>
  2465. <param name="zipPackage"></param>
  2466. <param name="zipArchive"></param>
  2467. <param name="zipArchiveEntry"></param>
  2468. <param name="zipStreamManager"></param>
  2469. <param name="partUri"></param>
  2470. <param name="compressionOption"></param>
  2471. <param name="contentType"></param>
  2472. </member>
  2473. <member name="P:System.IO.Packaging.ZipPackagePart.ZipArchiveEntry">
  2474. <summary>
  2475. Obtain the ZipFileInfo descriptor of an atomic part.
  2476. </summary>
  2477. </member>
  2478. <member name="T:System.IO.FileFormatException">
  2479. <summary>
  2480. The FileFormatException class is thrown when an input file or a data stream that is supposed to conform
  2481. to a certain file format specification is malformed.
  2482. </summary>
  2483. </member>
  2484. <member name="M:System.IO.FileFormatException.#ctor">
  2485. <summary>
  2486. Creates a new instance of FileFormatException class.
  2487. This constructor initializes the Message property of the new instance to a system-supplied message that describes the error,
  2488. such as "An input file or a data stream does not conform to the expected file format specification."
  2489. This message takes into account the current system culture.
  2490. </summary>
  2491. </member>
  2492. <member name="M:System.IO.FileFormatException.#ctor(System.String)">
  2493. <summary>
  2494. Creates a new instance of FileFormatException class.
  2495. This constructor initializes the Message property of the new instance with a specified error message.
  2496. </summary>
  2497. <param name="message">The message that describes the error.</param>
  2498. </member>
  2499. <member name="M:System.IO.FileFormatException.#ctor(System.String,System.Exception)">
  2500. <summary>
  2501. Creates a new instance of FileFormatException class.
  2502. This constructor initializes the Message property of the new instance with a specified error message.
  2503. The InnerException property is initialized using the innerException parameter.
  2504. </summary>
  2505. <param name="message">The error message that explains the reason for the exception.</param>
  2506. <param name="innerException">The exception that is the cause of the current exception.</param>
  2507. </member>
  2508. <member name="M:System.IO.FileFormatException.#ctor(System.Uri)">
  2509. <summary>
  2510. Creates a new instance of FileFormatException class.
  2511. This constructor initializes the Message property of the new instance to a system-supplied message that describes the error and includes the file name,
  2512. such as "The file 'sourceUri' does not conform to the expected file format specification."
  2513. This message takes into account the current system culture.
  2514. The SourceUri property is initialized using the sourceUri parameter.
  2515. </summary>
  2516. <param name="sourceUri">The Uri of a file that caused this error.</param>
  2517. </member>
  2518. <member name="M:System.IO.FileFormatException.#ctor(System.Uri,System.String)">
  2519. <summary>
  2520. Creates a new instance of FileFormatException class.
  2521. This constructor initializes the Message property of the new instance using the message parameter.
  2522. The content of message is intended to be understood by humans.
  2523. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
  2524. The SourceUri property is initialized using the sourceUri parameter.
  2525. </summary>
  2526. <param name="sourceUri">The Uri of a file that caused this error.</param>
  2527. <param name="message">The message that describes the error.</param>
  2528. </member>
  2529. <member name="M:System.IO.FileFormatException.#ctor(System.Uri,System.Exception)">
  2530. <summary>
  2531. Creates a new instance of FileFormatException class.
  2532. This constructor initializes the Message property of the new instance to a system-supplied message that describes the error and includes the file name,
  2533. such as "The file 'sourceUri' does not conform to the expected file format specification."
  2534. This message takes into account the current system culture.
  2535. The SourceUri property is initialized using the sourceUri parameter.
  2536. The InnerException property is initialized using the innerException parameter.
  2537. </summary>
  2538. <param name="sourceUri">The Uri of a file that caused this error.</param>
  2539. <param name="innerException">The exception that is the cause of the current exception.</param>
  2540. </member>
  2541. <member name="M:System.IO.FileFormatException.#ctor(System.Uri,System.String,System.Exception)">
  2542. <summary>
  2543. Creates a new instance of FileFormatException class.
  2544. This constructor initializes the Message property of the new instance using the message parameter.
  2545. The content of message is intended to be understood by humans.
  2546. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
  2547. The SourceUri property is initialized using the sourceUri parameter.
  2548. The InnerException property is initialized using the innerException parameter.
  2549. </summary>
  2550. <param name="sourceUri">The Uri of a file that caused this error.</param>
  2551. <param name="message">The message that describes the error.</param>
  2552. <param name="innerException">The exception that is the cause of the current exception.</param>
  2553. </member>
  2554. <member name="M:System.IO.FileFormatException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2555. <summary>
  2556. Sets the SerializationInfo object with the file name and additional exception information.
  2557. </summary>
  2558. <param name="info">The object that holds the serialized object data.</param>
  2559. <param name="context">The contextual information about the source or destination.</param>
  2560. </member>
  2561. <member name="P:System.IO.FileFormatException.SourceUri">
  2562. <summary>
  2563. Returns the name of a file that caused this exception. This property may be equal to an empty string
  2564. if obtaining the file path that caused the error was not possible.
  2565. </summary>
  2566. <value>The file name.</value>
  2567. <SecurityNote>
  2568. Critical : Calls critical Demand for path discovery
  2569. Safe : Path which could be leaked by an exception is already known to caller since it is supplied by the caller
  2570. </SecurityNote>
  2571. </member>
  2572. <member name="P:System.SR.BadPackageFormat">
  2573. <summary>Format error in package.</summary>
  2574. </member>
  2575. <member name="P:System.SR.CannotModifyReadOnlyContainer">
  2576. <summary>Cannot modify readonly container</summary>
  2577. </member>
  2578. <member name="P:System.SR.CannotRetrievePartsOfWriteOnlyContainer">
  2579. <summary>Cannot retrieve parts of writeonly container</summary>
  2580. </member>
  2581. <member name="P:System.SR.ContainerAndPartModeIncompatible">
  2582. <summary>FileMode/FileAccess for Part.GetStream is not compatible with FileMode/FileAccess used to open the Package.</summary>
  2583. </member>
  2584. <member name="P:System.SR.ContentTypeCannotHaveLeadingTrailingLWS">
  2585. <summary>ContentType string cannot have leading/trailing Linear White Spaces [LWS - RFC 2616].</summary>
  2586. </member>
  2587. <member name="P:System.SR.CorePropertiesElementExpected">
  2588. <summary>Unrecognized root element in Core Properties part.</summary>
  2589. </member>
  2590. <member name="P:System.SR.CreateNewNotSupported">
  2591. <summary>CreateNew not supported</summary>
  2592. </member>
  2593. <member name="P:System.SR.DanglingMetadataRelationship">
  2594. <summary>The target of the Core Properties relationship does not reference an existing part.</summary>
  2595. </member>
  2596. <member name="P:System.SR.DefaultTagDoesNotMatchSchema">
  2597. <summary>Default tag is not valid per the schema. Verify that attributes are correct.</summary>
  2598. </member>
  2599. <member name="P:System.SR.DuplicateCorePropertyName">
  2600. <summary>More than one '{0}' property found.</summary>
  2601. </member>
  2602. <member name="P:System.SR.ElementIsNotEmptyElement">
  2603. <summary>'{0}' element must be empty.</summary>
  2604. </member>
  2605. <member name="P:System.SR.EncodingNotSupported">
  2606. <summary>Encoding format is not supported. Only UTF-8 and UTF-16 are supported.</summary>
  2607. </member>
  2608. <member name="P:System.SR.ExpectedRelationshipsElementTag">
  2609. <summary>Relationships tag expected at root level.</summary>
  2610. </member>
  2611. <member name="P:System.SR.ExpectingParameterValuePairs">
  2612. <summary>';' must be followed by parameter=value pair.</summary>
  2613. </member>
  2614. <member name="P:System.SR.ExpectingSemicolon">
  2615. <summary>Semicolon separator is required between two valid parameter=value pairs.</summary>
  2616. </member>
  2617. <member name="P:System.SR.FileFormatException">
  2618. <summary>Invalid file format.</summary>
  2619. </member>
  2620. <member name="P:System.SR.FileFormatExceptionWithFileName">
  2621. <summary>Invalid file format.</summary>
  2622. </member>
  2623. <member name="P:System.SR.GetContentTypeCoreNotImplemented">
  2624. <summary>PackagePart subclass must implement GetContentTypeCore method if passing a null value for the content type when PackagePart object is constructed.</summary>
  2625. </member>
  2626. <member name="P:System.SR.InvalidLinearWhiteSpaceCharacter">
  2627. <summary>A Linear White Space character is not valid.</summary>
  2628. </member>
  2629. <member name="P:System.SR.InvalidParameterValue">
  2630. <summary>Parameter value must be a valid token or a quoted string as per RFC 2616.</summary>
  2631. </member>
  2632. <member name="P:System.SR.InvalidParameterValuePair">
  2633. <summary>Parameter and value pair is not valid. Expected form is parameter=value.</summary>
  2634. </member>
  2635. <member name="P:System.SR.InvalidPartUri">
  2636. <summary>Part URI is not valid per rules defined in the Open Packaging Conventions specification.</summary>
  2637. </member>
  2638. <member name="P:System.SR.InvalidPropertyNameInCorePropertiesPart">
  2639. <summary>'{0}' property name is not valid in Core Properties part.</summary>
  2640. </member>
  2641. <member name="P:System.SR.InvalidRelationshipType">
  2642. <summary>Relationship Type cannot contain only spaces or be empty.</summary>
  2643. </member>
  2644. <member name="P:System.SR.InvalidToken_ContentType">
  2645. <summary>A token is not valid. Refer to RFC 2616 for correct grammar of content types.</summary>
  2646. </member>
  2647. <member name="P:System.SR.InvalidTypeSubType">
  2648. <summary>ContentType string is not valid. Expected format is type/subtype.</summary>
  2649. </member>
  2650. <member name="P:System.SR.InvalidValueForTheAttribute">
  2651. <summary>'{0}' attribute value is not valid.</summary>
  2652. </member>
  2653. <member name="P:System.SR.InvalidXmlBaseAttributePresent">
  2654. <summary>Relationships XML elements cannot specify attribute '{0}'.</summary>
  2655. </member>
  2656. <member name="P:System.SR.MoreThanOneMetadataRelationships">
  2657. <summary>Package has more than one Core Properties relationship.</summary>
  2658. </member>
  2659. <member name="P:System.SR.NoExternalTargetForMetadataRelationship">
  2660. <summary>TargetMode for a Core Properties relationship must be 'Internal'.</summary>
  2661. </member>
  2662. <member name="P:System.SR.NoStructuredContentInsideProperties">
  2663. <summary>Core Properties part: core property elements can contain only text data.</summary>
  2664. </member>
  2665. <member name="P:System.SR.NotAUniqueRelationshipId">
  2666. <summary>'{0}' ID conflicts with the ID of an existing relationship for the specified source.</summary>
  2667. </member>
  2668. <member name="P:System.SR.NotAValidRelationshipPartUri">
  2669. <summary>PackageRelationship part URI syntax is not valid.</summary>
  2670. </member>
  2671. <member name="P:System.SR.NotAValidXmlIdString">
  2672. <summary>'{0}' ID is not a valid XSD ID.</summary>
  2673. </member>
  2674. <member name="P:System.SR.NullContentTypeProvided">
  2675. <summary>GetContentTypeCore method cannot return null for the content type stream.</summary>
  2676. </member>
  2677. <member name="P:System.SR.NullStreamReturned">
  2678. <summary>Returned stream for the part is null.</summary>
  2679. </member>
  2680. <member name="P:System.SR.ObjectDisposed">
  2681. <summary>Package object was closed and disposed, so cannot carry out operations on this object or any stream opened on a part of this package.</summary>
  2682. </member>
  2683. <member name="P:System.SR.OverrideTagDoesNotMatchSchema">
  2684. <summary>Override tag is not valid per the schema. Verify that attributes are correct.</summary>
  2685. </member>
  2686. <member name="P:System.SR.PackagePartDeleted">
  2687. <summary>Part was deleted.</summary>
  2688. </member>
  2689. <member name="P:System.SR.PackagePartRelationshipDoesNotExist">
  2690. <summary>PackageRelationship with specified ID does not exist for the source part.</summary>
  2691. </member>
  2692. <member name="P:System.SR.PackageRelationshipDoesNotExist">
  2693. <summary>PackageRelationship with specified ID does not exist at the Package level.</summary>
  2694. </member>
  2695. <member name="P:System.SR.ParentContainerClosed">
  2696. <summary>Cannot access part because parent package was closed.</summary>
  2697. </member>
  2698. <member name="P:System.SR.PartAlreadyExists">
  2699. <summary>Cannot add part for the specified URI because it is already in the package.</summary>
  2700. </member>
  2701. <member name="P:System.SR.PartDoesNotExist">
  2702. <summary>Specified part does not exist in the package.</summary>
  2703. </member>
  2704. <member name="P:System.SR.PartNamePrefixExists">
  2705. <summary>Cannot add part to the package. Part names cannot be derived from another part name by appending segments to it.</summary>
  2706. </member>
  2707. <member name="P:System.SR.PartUriCannotHaveAFragment">
  2708. <summary>Part URI cannot contain a Fragment component.</summary>
  2709. </member>
  2710. <member name="P:System.SR.PartUriIsEmpty">
  2711. <summary>Part URI is empty.</summary>
  2712. </member>
  2713. <member name="P:System.SR.PartUriShouldNotEndWithForwardSlash">
  2714. <summary>Part URI cannot end with a forward slash.</summary>
  2715. </member>
  2716. <member name="P:System.SR.PartUriShouldNotStartWithTwoForwardSlashes">
  2717. <summary>Part URI cannot start with two forward slashes.</summary>
  2718. </member>
  2719. <member name="P:System.SR.PartUriShouldStartWithForwardSlash">
  2720. <summary>Part URI must start with a forward slash.</summary>
  2721. </member>
  2722. <member name="P:System.SR.PropertyStartTagExpected">
  2723. <summary>Core Properties part: A property start-tag was expected.</summary>
  2724. </member>
  2725. <member name="P:System.SR.PropertyWrongNumbOfAttribsDefinedOn">
  2726. <summary>Unexpected number of attributes is found on '{0}'.</summary>
  2727. </member>
  2728. <member name="P:System.SR.RelationshipPartIncorrectContentType">
  2729. <summary>Incorrect content type for PackageRelationship part.</summary>
  2730. </member>
  2731. <member name="P:System.SR.RelationshipPartsCannotHaveRelationships">
  2732. <summary>PackageRelationship parts cannot have relationships to other parts.</summary>
  2733. </member>
  2734. <member name="P:System.SR.RelationshipPartUriExpected">
  2735. <summary>PackageRelationship part URI is expected.</summary>
  2736. </member>
  2737. <member name="P:System.SR.RelationshipPartUriNotExpected">
  2738. <summary>PackageRelationship part URI is not expected.</summary>
  2739. </member>
  2740. <member name="P:System.SR.RelationshipsTagHasExtraAttributes">
  2741. <summary>Relationships tag has extra attributes.</summary>
  2742. </member>
  2743. <member name="P:System.SR.RelationshipTagDoesntMatchSchema">
  2744. <summary>Relationship tag contains incorrect attribute.</summary>
  2745. </member>
  2746. <member name="P:System.SR.RelationshipTargetMustBeRelative">
  2747. <summary>PackageRelationship target must be relative URI if TargetMode is Internal.</summary>
  2748. </member>
  2749. <member name="P:System.SR.RelationshipToRelationshipIllegal">
  2750. <summary>PackageRelationship cannot target another PackageRelationship.</summary>
  2751. </member>
  2752. <member name="P:System.SR.RequiredAttributeEmpty">
  2753. <summary>'{0}' tag requires a nonempty '{1}' attribute.</summary>
  2754. </member>
  2755. <member name="P:System.SR.RequiredAttributeMissing">
  2756. <summary>'{0}' tag requires attribute '{1}'.</summary>
  2757. </member>
  2758. <member name="P:System.SR.RequiredRelationshipAttributeMissing">
  2759. <summary>Relationship tag requires attribute '{0}'.</summary>
  2760. </member>
  2761. <member name="P:System.SR.StreamObjectDisposed">
  2762. <summary>Cannot access Stream object because it was closed or disposed.</summary>
  2763. </member>
  2764. <member name="P:System.SR.TruncateNotSupported">
  2765. <summary>Truncate not supported</summary>
  2766. </member>
  2767. <member name="P:System.SR.TypesElementExpected">
  2768. <summary>Required Types tag not found.</summary>
  2769. </member>
  2770. <member name="P:System.SR.TypesTagHasExtraAttributes">
  2771. <summary>Types tag has attributes not valid per the schema.</summary>
  2772. </member>
  2773. <member name="P:System.SR.TypesXmlDoesNotMatchSchema">
  2774. <summary>Content Types XML does not match schema.</summary>
  2775. </member>
  2776. <member name="P:System.SR.UnknownDCDateTimeXsiType">
  2777. <summary>Unknown xsi:type for DateTime on '{0}'.</summary>
  2778. </member>
  2779. <member name="P:System.SR.UnknownNamespaceInCorePropertiesPart">
  2780. <summary>Unrecognized namespace in Core Properties part.</summary>
  2781. </member>
  2782. <member name="P:System.SR.UnknownTagEncountered">
  2783. <summary>Unrecognized tag found in Relationships XML.</summary>
  2784. </member>
  2785. <member name="P:System.SR.UnsupportedCombinationOfModeAccess">
  2786. <summary>Cannot get stream with FileMode.Create, FileMode.CreateNew, FileMode.Truncate, FileMode.Append when access is FileAccess.Read.</summary>
  2787. </member>
  2788. <member name="P:System.SR.URIShouldNotBeAbsolute">
  2789. <summary>Cannot be an absolute URI.</summary>
  2790. </member>
  2791. <member name="P:System.SR.WrongContentTypeForPropertyPart">
  2792. <summary>The Core Properties relationship references a part that has an incorrect content type.</summary>
  2793. </member>
  2794. <member name="P:System.SR.XCRChoiceAfterFallback">
  2795. <summary>Choice cannot follow a Fallback.</summary>
  2796. </member>
  2797. <member name="P:System.SR.XCRChoiceNotFound">
  2798. <summary>AlternateContent must contain one or more Choice elements.</summary>
  2799. </member>
  2800. <member name="P:System.SR.XCRChoiceOnlyInAC">
  2801. <summary>Choice is valid only in AlternateContent.</summary>
  2802. </member>
  2803. <member name="P:System.SR.XCRCompatCycle">
  2804. <summary>There is a cycle of XML compatibility definitions, such that namespace '{0}' overrides itself. This could be due to inconsistent XmlnsCompatibilityAttributes in different assemblies. Please change the definitions to eliminate this cycle.</summary>
  2805. </member>
  2806. <member name="P:System.SR.XCRDuplicatePreserve">
  2807. <summary>Duplicate Preserve declaration for element {1} in namespace '{0}'.</summary>
  2808. </member>
  2809. <member name="P:System.SR.XCRDuplicateProcessContent">
  2810. <summary>Duplicate ProcessContent declaration for element '{1}' in namespace '{0}'.</summary>
  2811. </member>
  2812. <member name="P:System.SR.XCRDuplicateWildcardPreserve">
  2813. <summary>Duplicate wildcard Preserve declaration for namespace '{0}'.</summary>
  2814. </member>
  2815. <member name="P:System.SR.XCRDuplicateWildcardProcessContent">
  2816. <summary>Duplicate wildcard ProcessContent declaration for namespace '{0}'.</summary>
  2817. </member>
  2818. <member name="P:System.SR.XCRFallbackOnlyInAC">
  2819. <summary>Fallback is valid only in AlternateContent.</summary>
  2820. </member>
  2821. <member name="P:System.SR.XCRInvalidACChild">
  2822. <summary>'{0}' element is not a valid child of AlternateContent. Only Choice and Fallback elements are valid children of an AlternateContent element.</summary>
  2823. </member>
  2824. <member name="P:System.SR.XCRInvalidAttribInElement">
  2825. <summary>'{0}' attribute is not valid for '{1}' element.</summary>
  2826. </member>
  2827. <member name="P:System.SR.XCRInvalidFormat">
  2828. <summary>'{0}' format is not valid.</summary>
  2829. </member>
  2830. <member name="P:System.SR.XCRInvalidPreserve">
  2831. <summary>Cannot have both a specific and a wildcard Preserve declaration for namespace '{0}'.</summary>
  2832. </member>
  2833. <member name="P:System.SR.XCRInvalidProcessContent">
  2834. <summary>Cannot have both a specific and a wildcard ProcessContent declaration for namespace '{0}'.</summary>
  2835. </member>
  2836. <member name="P:System.SR.XCRInvalidRequiresAttribute">
  2837. <summary>Requires attribute must contain a valid namespace prefix.</summary>
  2838. </member>
  2839. <member name="P:System.SR.XCRInvalidXMLName">
  2840. <summary>'{0}' attribute value is not a valid XML name.</summary>
  2841. </member>
  2842. <member name="P:System.SR.XCRMultipleFallbackFound">
  2843. <summary>AlternateContent must contain only one Fallback element.</summary>
  2844. </member>
  2845. <member name="P:System.SR.XCRMustUnderstandFailed">
  2846. <summary>MustUnderstand condition failed on namespace '{0}'</summary>
  2847. </member>
  2848. <member name="P:System.SR.XCRNSPreserveNotIgnorable">
  2849. <summary>'{0}' namespace cannot preserve items; it must be declared Ignorable first.</summary>
  2850. </member>
  2851. <member name="P:System.SR.XCRNSProcessContentNotIgnorable">
  2852. <summary>'{0}' namespace cannot process content; it must be declared Ignorable first.</summary>
  2853. </member>
  2854. <member name="P:System.SR.XCRRequiresAttribNotFound">
  2855. <summary>Choice must contain Requires attribute.</summary>
  2856. </member>
  2857. <member name="P:System.SR.XCRUndefinedPrefix">
  2858. <summary>'{0}' prefix is not defined.</summary>
  2859. </member>
  2860. <member name="P:System.SR.XCRUnknownCompatAttrib">
  2861. <summary>Unrecognized compatibility attribute '{0}'.</summary>
  2862. </member>
  2863. <member name="P:System.SR.XCRUnknownCompatElement">
  2864. <summary>Unrecognized Compatibility element '{0}'.</summary>
  2865. </member>
  2866. <member name="P:System.SR.XsdDateTimeExpected">
  2867. <summary>Core Properties part: Text data of XSD type 'DateTime' was expected.</summary>
  2868. </member>
  2869. <member name="P:System.SR.CreateNewOnNonEmptyStream">
  2870. <summary>CreateNew is not a valid FileMode for a non-empty stream.</summary>
  2871. </member>
  2872. <member name="P:System.SR.ZipZeroSizeFileIsNotValidArchive">
  2873. <summary>Archive file cannot be size 0.</summary>
  2874. </member>
  2875. <member name="P:System.SR.InnerPackageUriHasFragment">
  2876. <summary>Package URI obtained from the pack URI cannot contain a Fragment.</summary>
  2877. </member>
  2878. <member name="P:System.SR.FragmentMustStartWithHash">
  2879. <summary>The '{0}' parameter must start with '#'.</summary>
  2880. </member>
  2881. <member name="P:System.SR.UriShouldBePackScheme">
  2882. <summary>URI must contain pack:// scheme.</summary>
  2883. </member>
  2884. <member name="P:System.SR.UriShouldBeAbsolute">
  2885. <summary>Must have absolute URI.</summary>
  2886. </member>
  2887. <member name="P:System.SR.FileContainsCorruptedData">
  2888. <summary>File contains corrupted data.</summary>
  2889. </member>
  2890. <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
  2891. <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
  2892. </member>
  2893. <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
  2894. <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
  2895. </member>
  2896. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
  2897. <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
  2898. </member>
  2899. <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
  2900. <summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
  2901. </member>
  2902. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
  2903. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
  2904. </member>
  2905. <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
  2906. <summary>Initializes the attribute with the specified return value condition.</summary>
  2907. <param name="returnValue">
  2908. The return value condition. If the method returns this value, the associated parameter may be null.
  2909. </param>
  2910. </member>
  2911. <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
  2912. <summary>Gets the return value condition.</summary>
  2913. </member>
  2914. <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
  2915. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
  2916. </member>
  2917. <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
  2918. <summary>Initializes the attribute with the specified return value condition.</summary>
  2919. <param name="returnValue">
  2920. The return value condition. If the method returns this value, the associated parameter will not be null.
  2921. </param>
  2922. </member>
  2923. <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
  2924. <summary>Gets the return value condition.</summary>
  2925. </member>
  2926. <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
  2927. <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
  2928. </member>
  2929. <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
  2930. <summary>Initializes the attribute with the associated parameter name.</summary>
  2931. <param name="parameterName">
  2932. The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
  2933. </param>
  2934. </member>
  2935. <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
  2936. <summary>Gets the associated parameter name.</summary>
  2937. </member>
  2938. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
  2939. <summary>Applied to a method that will never return under any circumstance.</summary>
  2940. </member>
  2941. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
  2942. <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
  2943. </member>
  2944. <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
  2945. <summary>Initializes the attribute with the specified parameter value.</summary>
  2946. <param name="parameterValue">
  2947. The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
  2948. the associated parameter matches this value.
  2949. </param>
  2950. </member>
  2951. <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
  2952. <summary>Gets the condition parameter value.</summary>
  2953. </member>
  2954. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
  2955. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
  2956. </member>
  2957. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
  2958. <summary>Initializes the attribute with a field or property member.</summary>
  2959. <param name="member">
  2960. The field or property member that is promised to be not-null.
  2961. </param>
  2962. </member>
  2963. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
  2964. <summary>Initializes the attribute with the list of field and property members.</summary>
  2965. <param name="members">
  2966. The list of field and property members that are promised to be not-null.
  2967. </param>
  2968. </member>
  2969. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
  2970. <summary>Gets field or property member names.</summary>
  2971. </member>
  2972. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
  2973. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
  2974. </member>
  2975. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
  2976. <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
  2977. <param name="returnValue">
  2978. The return value condition. If the method returns this value, the associated parameter will not be null.
  2979. </param>
  2980. <param name="member">
  2981. The field or property member that is promised to be not-null.
  2982. </param>
  2983. </member>
  2984. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
  2985. <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
  2986. <param name="returnValue">
  2987. The return value condition. If the method returns this value, the associated parameter will not be null.
  2988. </param>
  2989. <param name="members">
  2990. The list of field and property members that are promised to be not-null.
  2991. </param>
  2992. </member>
  2993. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
  2994. <summary>Gets the return value condition.</summary>
  2995. </member>
  2996. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
  2997. <summary>Gets field or property member names.</summary>
  2998. </member>
  2999. </members>
  3000. </doc>