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

729 line
80 KiB

  1. <?xml version="1.0" encoding="utf-8"?><span>
  2. <doc>
  3. <assembly>
  4. <name>System.IO.Packaging</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.IO.FileFormatException">
  8. <summary>The exception that is thrown when an input file or a data stream that is supposed to conform to a certain file format specification is malformed.</summary>
  9. </member>
  10. <member name="M:System.IO.FileFormatException.#ctor">
  11. <summary>Creates a new instance of the <see cref="T:System.IO.FileFormatException"></see> class.</summary>
  12. </member>
  13. <member name="M:System.IO.FileFormatException.#ctor(System.String)">
  14. <summary>Creates a new instance of the <see cref="T:System.IO.FileFormatException"></see> class with a specified error message.</summary>
  15. <param name="message">A <see cref="T:System.String"></see> value that represents the error message.</param>
  16. </member>
  17. <member name="M:System.IO.FileFormatException.#ctor(System.Uri)">
  18. <summary>Creates a new instance of the <see cref="T:System.IO.FileFormatException"></see> class with a source URI value.</summary>
  19. <param name="sourceUri">The <see cref="T:System.Uri"></see> value of the file that caused this error.</param>
  20. </member>
  21. <member name="M:System.IO.FileFormatException.#ctor(System.String,System.Exception)">
  22. <summary>Creates a new instance of the <see cref="T:System.IO.FileFormatException"></see> class with a specified error message and exception type.</summary>
  23. <param name="message">A <see cref="T:System.String"></see> value that represents the error message.</param>
  24. <param name="innerException">The value of the <see cref="P:System.Exception.InnerException"></see> property, which represents the cause of the current exception.</param>
  25. </member>
  26. <member name="M:System.IO.FileFormatException.#ctor(System.Uri,System.Exception)">
  27. <summary>Creates a new instance of the <see cref="T:System.IO.FileFormatException"></see> class with a source URI value and an exception type.</summary>
  28. <param name="sourceUri">The <see cref="T:System.Uri"></see> value of the file that caused this error.</param>
  29. <param name="innerException">The value of the <see cref="P:System.Exception.InnerException"></see> property, which represents the cause of the current exception.</param>
  30. </member>
  31. <member name="M:System.IO.FileFormatException.#ctor(System.Uri,System.String)">
  32. <summary>Creates a new instance of the <see cref="T:System.IO.FileFormatException"></see> class with a source URI value and a specified error message.</summary>
  33. <param name="sourceUri">The <see cref="T:System.Uri"></see> value of the file that caused this error.</param>
  34. <param name="message">A <see cref="T:System.String"></see> value that represents the error message.</param>
  35. </member>
  36. <member name="M:System.IO.FileFormatException.#ctor(System.Uri,System.String,System.Exception)">
  37. <summary>Creates a new instance of the <see cref="T:System.IO.FileFormatException"></see> class with a source URI value, a specified error message, and an exception type.</summary>
  38. <param name="sourceUri">The <see cref="T:System.Uri"></see> value of the file that caused this error.</param>
  39. <param name="message">A <see cref="T:System.String"></see> value that represents the error message.</param>
  40. <param name="innerException">The value of the <see cref="P:System.Exception.InnerException"></see> property, which represents the cause of the current exception.</param>
  41. </member>
  42. <member name="P:System.IO.FileFormatException.SourceUri">
  43. <summary>Gets the name of a file that caused the <see cref="T:System.IO.FileFormatException"></see>.</summary>
  44. <returns>A <see cref="T:System.Uri"></see> that represents the name the file that caused the exception.</returns>
  45. </member>
  46. <member name="T:System.IO.Packaging.CompressionOption">
  47. <summary>Specifies the compression level for content that is stored in a <see cref="T:System.IO.Packaging.PackagePart"></see>.</summary>
  48. </member>
  49. <member name="F:System.IO.Packaging.CompressionOption.Fast">
  50. <summary>Compression is optimized for performance.</summary>
  51. <returns></returns>
  52. </member>
  53. <member name="F:System.IO.Packaging.CompressionOption.Maximum">
  54. <summary>Compression is optimized for size.</summary>
  55. <returns></returns>
  56. </member>
  57. <member name="F:System.IO.Packaging.CompressionOption.Normal">
  58. <summary>Compression is optimized for a balance between size and performance.</summary>
  59. <returns></returns>
  60. </member>
  61. <member name="F:System.IO.Packaging.CompressionOption.NotCompressed">
  62. <summary>Compression is turned off.</summary>
  63. <returns></returns>
  64. </member>
  65. <member name="F:System.IO.Packaging.CompressionOption.SuperFast">
  66. <summary>Compression is optimized for high performance.</summary>
  67. <returns></returns>
  68. </member>
  69. <member name="T:System.IO.Packaging.EncryptionOption">
  70. <summary>Specifies the encryption option for parts in a <see cref="T:System.IO.Packaging.Package"></see>.</summary>
  71. </member>
  72. <member name="F:System.IO.Packaging.EncryptionOption.None">
  73. <summary>No encryption.</summary>
  74. <returns></returns>
  75. </member>
  76. <member name="F:System.IO.Packaging.EncryptionOption.RightsManagement">
  77. <summary>Encryption supported through rights management.</summary>
  78. <returns></returns>
  79. </member>
  80. <member name="T:System.IO.Packaging.Package">
  81. <summary>Represents a container that can store multiple data objects.</summary>
  82. </member>
  83. <member name="M:System.IO.Packaging.Package.#ctor(System.IO.FileAccess)">
  84. <summary>Initializes a new instance of the <see cref="T:System.IO.Packaging.Package"></see> class that uses a given <see cref="T:System.IO.FileAccess"></see>.</summary>
  85. <param name="openFileAccess">The file IO permissions for the package.</param>
  86. <exception cref="T:System.ArgumentOutOfRangeException">The value for <paramref name="openFileAccess">openFileAccess</paramref> is not valid.</exception>
  87. </member>
  88. <member name="M:System.IO.Packaging.Package.Close">
  89. <summary>Saves and closes the package plus all underlying part streams.</summary>
  90. </member>
  91. <member name="M:System.IO.Packaging.Package.CreatePart(System.Uri,System.String)">
  92. <summary>Creates a new uncompressed part with a given URI and content type.</summary>
  93. <param name="partUri">The uniform resource identifier (URI) of the new part.</param>
  94. <param name="contentType">The content type of the data stream.</param>
  95. <returns>The new created part.</returns>
  96. <exception cref="T:System.ArgumentNullException"><paramref name="partUri">partUri</paramref> or <paramref name="contentType">contentType</paramref> is null.</exception>
  97. <exception cref="T:System.ArgumentException"><paramref name="partUri">partUri</paramref> is not a valid <see cref="T:System.IO.Packaging.PackagePart"></see> URI.</exception>
  98. <exception cref="T:System.InvalidOperationException">A part with the specified <paramref name="partUri">partUri</paramref> is already present in the package.</exception>
  99. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  100. <exception cref="T:System.IO.IOException">The package is read-only (a new part cannot be added).</exception>
  101. </member>
  102. <member name="M:System.IO.Packaging.Package.CreatePart(System.Uri,System.String,System.IO.Packaging.CompressionOption)">
  103. <summary>Creates a new part with a given URI, content type, and compression option.</summary>
  104. <param name="partUri">The URI of the new part.</param>
  105. <param name="contentType">The content type of the data stream.</param>
  106. <param name="compressionOption">The compression option for the data stream, <see cref="F:System.IO.Packaging.CompressionOption.NotCompressed"></see> or <see cref="F:System.IO.Packaging.CompressionOption.Normal"></see> compression.</param>
  107. <returns>The new created part.</returns>
  108. <exception cref="T:System.ArgumentNullException"><paramref name="partUri">partUri</paramref> or <paramref name="contentType">contentType</paramref> is null.</exception>
  109. <exception cref="T:System.ArgumentException"><paramref name="partUri">partUri</paramref> is not a valid <see cref="T:System.IO.Packaging.PackagePart"></see> uniform resource identifier (URI).</exception>
  110. <exception cref="T:System.InvalidOperationException">A part with the specified <paramref name="partUri">partUri</paramref> is already present in the package.</exception>
  111. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="compressionOption">compressionOption</paramref> value is not valid.</exception>
  112. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  113. <exception cref="T:System.IO.IOException">The package is read-only (a new part cannot be added).</exception>
  114. </member>
  115. <member name="M:System.IO.Packaging.Package.CreatePartCore(System.Uri,System.String,System.IO.Packaging.CompressionOption)">
  116. <summary>When overridden in a derived class, creates a new part in the package.</summary>
  117. <param name="partUri">The uniform resource identifier (URI) for the part being created.</param>
  118. <param name="contentType">The content type of the data stream.</param>
  119. <param name="compressionOption">The compression option for the data stream.</param>
  120. <returns>The created part.</returns>
  121. </member>
  122. <member name="M:System.IO.Packaging.Package.CreateRelationship(System.Uri,System.IO.Packaging.TargetMode,System.String)">
  123. <summary>Creates a package-level relationship to a part with a given URI, target mode, and relationship type.</summary>
  124. <param name="targetUri">The uniform resource identifier (URI) of the target part.</param>
  125. <param name="targetMode">Indicates if the target part is <see cref="F:System.IO.Packaging.TargetMode.Internal"></see> or <see cref="F:System.IO.Packaging.TargetMode.External"></see> to the package.</param>
  126. <param name="relationshipType">A URI that uniquely defines the role of the relationship.</param>
  127. <returns>The package-level relationship to the specified part.</returns>
  128. <exception cref="T:System.ArgumentNullException"><paramref name="targetUri">targetUri</paramref> or <paramref name="relationshipType">relationshipType</paramref> is null.</exception>
  129. <exception cref="T:System.ArgumentException">The <paramref name="targetUri">targetUri</paramref> part is a <see cref="T:System.IO.Packaging.PackageRelationship"></see>, or <paramref name="targetMode">targetMode</paramref> is <see cref="F:System.IO.Packaging.TargetMode.Internal"></see> and <paramref name="targetUri">targetUri</paramref> is an absolute URI.</exception>
  130. <exception cref="T:System.ArgumentOutOfRangeException">The value for <paramref name="targetMode">targetMode</paramref> is not valid.</exception>
  131. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  132. <exception cref="T:System.IO.IOException">The package is read-only.</exception>
  133. </member>
  134. <member name="M:System.IO.Packaging.Package.CreateRelationship(System.Uri,System.IO.Packaging.TargetMode,System.String,System.String)">
  135. <summary>Creates a package-level relationship to a part with a given URI, target mode, relationship type, and identifier (ID).</summary>
  136. <param name="targetUri">The uniform resource identifier (URI) of the target part.</param>
  137. <param name="targetMode">Indicates if the target part is <see cref="F:System.IO.Packaging.TargetMode.Internal"></see> or <see cref="F:System.IO.Packaging.TargetMode.External"></see> to the package.</param>
  138. <param name="relationshipType">A URI that uniquely defines the role of the relationship.</param>
  139. <param name="id">A unique XML identifier.</param>
  140. <returns>The package-level relationship to the specified part.</returns>
  141. <exception cref="T:System.ArgumentNullException"><paramref name="targetUri">targetUri</paramref> or <paramref name="relationshipType">relationshipType</paramref> is null.</exception>
  142. <exception cref="T:System.ArgumentException">The <paramref name="targetUri">targetUri</paramref> part is a <see cref="T:System.IO.Packaging.PackageRelationship"></see>, or <paramref name="targetMode">targetMode</paramref> is <see cref="F:System.IO.Packaging.TargetMode.Internal"></see> and <paramref name="targetUri">targetUri</paramref> is an absolute URI.</exception>
  143. <exception cref="T:System.ArgumentOutOfRangeException">The value for <paramref name="targetMode">targetMode</paramref> is not valid.</exception>
  144. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  145. <exception cref="T:System.IO.IOException">The package is read-only.</exception>
  146. <exception cref="T:System.Xml.XmlException"><paramref name="id">id</paramref> is not a valid XML identifier; or a part with the specified <paramref name="id">id</paramref> already occurs in the package.</exception>
  147. </member>
  148. <member name="M:System.IO.Packaging.Package.DeletePart(System.Uri)">
  149. <summary>Deletes a part with a given URI from the package.</summary>
  150. <param name="partUri">The URI of the part to delete.</param>
  151. <exception cref="T:System.ArgumentNullException"><paramref name="partUri">partUri</paramref> is null.</exception>
  152. <exception cref="T:System.ArgumentException"><paramref name="partUri">partUri</paramref> is not a valid <see cref="T:System.IO.Packaging.PackagePart"></see> URI.</exception>
  153. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  154. <exception cref="T:System.IO.IOException">The package is read-only.</exception>
  155. </member>
  156. <member name="M:System.IO.Packaging.Package.DeletePartCore(System.Uri)">
  157. <summary>When overridden in a derived class, deletes a part with a given URI.</summary>
  158. <param name="partUri">The <see cref="P:System.IO.Packaging.PackagePart.Uri"></see> of the <see cref="T:System.IO.Packaging.PackagePart"></see> to delete.</param>
  159. </member>
  160. <member name="M:System.IO.Packaging.Package.DeleteRelationship(System.String)">
  161. <summary>Deletes a package-level relationship.</summary>
  162. <param name="id">The <see cref="P:System.IO.Packaging.PackageRelationship.Id"></see> of the <see cref="T:System.IO.Packaging.PackageRelationship"></see> to delete.</param>
  163. <exception cref="T:System.ArgumentNullException"><paramref name="id">id</paramref> is null.</exception>
  164. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  165. <exception cref="T:System.IO.IOException">The package is read-only.</exception>
  166. <exception cref="T:System.Xml.XmlException"><paramref name="id">id</paramref> is not a valid XML identifier.</exception>
  167. </member>
  168. <member name="M:System.IO.Packaging.Package.Dispose(System.Boolean)">
  169. <summary>Flushes and saves the content of all parts and relationships, closes the package, and releases all resources.</summary>
  170. <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
  171. </member>
  172. <member name="P:System.IO.Packaging.Package.FileOpenAccess">
  173. <summary>Gets the file access setting for the package.</summary>
  174. <returns>One of the <see cref="T:System.IO.FileAccess"></see> values: <see cref="F:System.IO.FileAccess.Read"></see>, <see cref="F:System.IO.FileAccess.Write"></see>, or <see cref="F:System.IO.FileAccess.ReadWrite"></see>.</returns>
  175. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  176. </member>
  177. <member name="M:System.IO.Packaging.Package.Flush">
  178. <summary>Saves the contents of all parts and relationships that are contained in the package.</summary>
  179. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  180. <exception cref="T:System.IO.IOException">The package is read-only and cannot be modified.</exception>
  181. </member>
  182. <member name="M:System.IO.Packaging.Package.FlushCore">
  183. <summary>When overridden in a derived class, saves the content of all parts and relationships to the derived class store.</summary>
  184. </member>
  185. <member name="M:System.IO.Packaging.Package.GetPart(System.Uri)">
  186. <summary>Returns the part with a given URI.</summary>
  187. <param name="partUri">The uniform resource identifier (URI) of the part to return.</param>
  188. <returns>The part with the specified <paramref name="partUri">partUri</paramref>.</returns>
  189. <exception cref="T:System.ArgumentNullException"><paramref name="partUri">partUri</paramref> is null.</exception>
  190. <exception cref="T:System.ArgumentException"><paramref name="partUri">partUri</paramref> is not a valid <see cref="T:System.IO.Packaging.PackagePart"></see> uniform resource identifier (URI).</exception>
  191. <exception cref="T:System.InvalidOperationException">A part with the specified <paramref name="partUri">partUri</paramref> is not in the package.</exception>
  192. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  193. <exception cref="T:System.IO.IOException">The package is write-only.</exception>
  194. </member>
  195. <member name="M:System.IO.Packaging.Package.GetPartCore(System.Uri)">
  196. <summary>When overridden in a derived class, returns the part addressed by a given URI.</summary>
  197. <param name="partUri">The uniform resource identifier (URI) of the part to retrieve.</param>
  198. <returns>The requested part; or null, if a part with the specified <paramref name="partUri">partUri</paramref> is not in the package.</returns>
  199. </member>
  200. <member name="M:System.IO.Packaging.Package.GetParts">
  201. <summary>Returns a collection of all the parts in the package.</summary>
  202. <returns>A collection of all the <see cref="T:System.IO.Packaging.PackagePart"></see> elements that are contained in the package.</returns>
  203. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  204. <exception cref="T:System.IO.IOException">The package is write-only.</exception>
  205. </member>
  206. <member name="M:System.IO.Packaging.Package.GetPartsCore">
  207. <summary>When overridden in a derived class, returns an array of all the parts in the package.</summary>
  208. <returns>An array of all the parts that are contained in the package.</returns>
  209. </member>
  210. <member name="M:System.IO.Packaging.Package.GetRelationship(System.String)">
  211. <summary>Returns the package-level relationship with a given identifier.</summary>
  212. <param name="id">The <see cref="P:System.IO.Packaging.PackageRelationship.Id"></see> of the relationship to return.</param>
  213. <returns>The package-level relationship with the specified <paramref name="id">id</paramref>.</returns>
  214. <exception cref="T:System.ArgumentNullException"><paramref name="id">id</paramref> is null.</exception>
  215. <exception cref="T:System.Xml.XmlException"><paramref name="id">id</paramref> is not a valid XML identifier.</exception>
  216. <exception cref="T:System.InvalidOperationException">A relationship with the specified <paramref name="id">id</paramref> is not in the package.</exception>
  217. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  218. <exception cref="T:System.IO.IOException">The package is write-only.</exception>
  219. </member>
  220. <member name="M:System.IO.Packaging.Package.GetRelationships">
  221. <summary>Returns a collection of all the package-level relationships.</summary>
  222. <returns>A collection of all the package-level relationships that are contained in the package.</returns>
  223. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  224. <exception cref="T:System.IO.IOException">The package is write-only.</exception>
  225. </member>
  226. <member name="M:System.IO.Packaging.Package.GetRelationshipsByType(System.String)">
  227. <summary>Returns a collection of all the package-level relationships that match a given <see cref="P:System.IO.Packaging.PackageRelationship.RelationshipType"></see>.</summary>
  228. <param name="relationshipType">The <see cref="P:System.IO.Packaging.PackageRelationship.RelationshipType"></see> to match and return in the collection.</param>
  229. <returns>A collection of package-level relationships that match the specified <paramref name="relationshipType">relationshipType</paramref>.</returns>
  230. <exception cref="T:System.ArgumentNullException"><paramref name="relationshipType">relationshipType</paramref> is null.</exception>
  231. <exception cref="T:System.ArgumentException"><paramref name="relationshipType">relationshipType</paramref> is an empty string.</exception>
  232. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  233. <exception cref="T:System.IO.IOException">The package is write-only.</exception>
  234. </member>
  235. <member name="M:System.IO.Packaging.Package.Open(System.IO.Stream)">
  236. <summary>Opens a package on a given IO stream.</summary>
  237. <param name="stream">The IO stream on which to open the package.</param>
  238. <returns>The opened package.</returns>
  239. <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
  240. <exception cref="T:System.IO.IOException">The package to open requires read or read/write permission and the specified <paramref name="stream">stream</paramref> is write-only; or, the package to open requires write or read/write permission and the specified <paramref name="stream">stream</paramref> is read-only.</exception>
  241. </member>
  242. <member name="M:System.IO.Packaging.Package.Open(System.String)">
  243. <summary>Opens a package at a given path and file name.</summary>
  244. <param name="path">The path and file name of the package.</param>
  245. <returns>The opened package.</returns>
  246. <exception cref="T:System.ArgumentNullException"><paramref name="path">path</paramref> is null.</exception>
  247. </member>
  248. <member name="M:System.IO.Packaging.Package.Open(System.IO.Stream,System.IO.FileMode)">
  249. <summary>Opens a package with a given IO stream and file mode.</summary>
  250. <param name="stream">The IO stream on which to open the package.</param>
  251. <param name="packageMode">The file mode in which to open the package.</param>
  252. <returns>The opened package.</returns>
  253. <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
  254. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="packageMode">packageMode</paramref> value is not valid.</exception>
  255. <exception cref="T:System.IO.IOException">The package to open requires read or read/write permission and the specified <paramref name="stream">stream</paramref> is write-only; or, the package to open requires write or read/write permission and the specified <paramref name="stream">stream</paramref> is read-only.</exception>
  256. </member>
  257. <member name="M:System.IO.Packaging.Package.Open(System.String,System.IO.FileMode)">
  258. <summary>Opens a package at a given path using a given file mode.</summary>
  259. <param name="path">The path and file name of the package.</param>
  260. <param name="packageMode">The file mode in which to open the package.</param>
  261. <returns>The opened package.</returns>
  262. <exception cref="T:System.ArgumentNullException"><paramref name="path">path</paramref> is null.</exception>
  263. <exception cref="T:System.ArgumentOutOfRangeException">Value for <paramref name="packageMode">packageMode</paramref> is not valid.</exception>
  264. </member>
  265. <member name="M:System.IO.Packaging.Package.Open(System.IO.Stream,System.IO.FileMode,System.IO.FileAccess)">
  266. <summary>Opens a package with a given IO stream, file mode, and file access setting.</summary>
  267. <param name="stream">The IO stream on which to open the package.</param>
  268. <param name="packageMode">The file mode in which to open the package.</param>
  269. <param name="packageAccess">The file access in which to open the package.</param>
  270. <returns>The opened package.</returns>
  271. <exception cref="T:System.ArgumentNullException"><paramref name="stream">stream</paramref> is null.</exception>
  272. <exception cref="T:System.ArgumentOutOfRangeException">The value for <paramref name="packageMode">packageMode</paramref> or <paramref name="packageAccess">packageAccess</paramref> is not valid.</exception>
  273. <exception cref="T:System.IO.IOException">The package to open requires read or read/write permission and the specified <paramref name="stream">stream</paramref> is write-only; or the package to open requires write or read/write permission and the specified <paramref name="stream">stream</paramref> is read-only.</exception>
  274. </member>
  275. <member name="M:System.IO.Packaging.Package.Open(System.String,System.IO.FileMode,System.IO.FileAccess)">
  276. <summary>Opens a package at a given path using a given file mode and file access setting.</summary>
  277. <param name="path">The path and file name of the package.</param>
  278. <param name="packageMode">The file mode in which to open the package.</param>
  279. <param name="packageAccess">The file access in which to open the package.</param>
  280. <returns>The opened package.</returns>
  281. <exception cref="T:System.ArgumentNullException"><paramref name="path">path</paramref> is null.</exception>
  282. <exception cref="T:System.ArgumentOutOfRangeException">Value for <paramref name="packageMode">packageMode</paramref> or <paramref name="packageAccess">packageAccess</paramref> is not valid.</exception>
  283. </member>
  284. <member name="M:System.IO.Packaging.Package.Open(System.String,System.IO.FileMode,System.IO.FileAccess,System.IO.FileShare)">
  285. <summary>Opens a package at a given path using a given file mode, file access, and file share setting.</summary>
  286. <param name="path">The path and file name of the package.</param>
  287. <param name="packageMode">The file mode in which to open the package.</param>
  288. <param name="packageAccess">The file access in which to open the package.</param>
  289. <param name="packageShare">The file sharing mode in which to open the package.</param>
  290. <returns>The opened package.</returns>
  291. <exception cref="T:System.ArgumentNullException"><paramref name="path">path</paramref> is null.</exception>
  292. <exception cref="T:System.ArgumentOutOfRangeException">The value for <paramref name="packageMode">packageMode</paramref>, <paramref name="packageAccess">packageAccess</paramref>, or <paramref name="packageShare">packageShare</paramref> is not valid.</exception>
  293. </member>
  294. <member name="P:System.IO.Packaging.Package.PackageProperties">
  295. <summary>Gets the core properties of the package.</summary>
  296. <returns>The core properties of the package.</returns>
  297. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  298. </member>
  299. <member name="M:System.IO.Packaging.Package.PartExists(System.Uri)">
  300. <summary>Indicates whether a part with a given URI is in the package.</summary>
  301. <param name="partUri">The <see cref="T:System.Uri"></see> of the part to check for.</param>
  302. <returns>true if a part with the specified <paramref name="partUri">partUri</paramref> is in the package; otherwise, false.</returns>
  303. <exception cref="T:System.ArgumentNullException"><paramref name="partUri">partUri</paramref> is null.</exception>
  304. <exception cref="T:System.ArgumentException"><paramref name="partUri">partUri</paramref> is not a valid <see cref="T:System.IO.Packaging.PackagePart"></see> uniform resource identifier (URI).</exception>
  305. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  306. <exception cref="T:System.IO.IOException">The package is write-only (information cannot be read).</exception>
  307. </member>
  308. <member name="M:System.IO.Packaging.Package.RelationshipExists(System.String)">
  309. <summary>Indicates whether a package-level relationship with a given ID is contained in the package.</summary>
  310. <param name="id">The <see cref="P:System.IO.Packaging.PackageRelationship.Id"></see> of the relationship to check for.</param>
  311. <returns>true if a package-level relationship with the specified <paramref name="id">id</paramref> is in the package; otherwise, false.</returns>
  312. <exception cref="T:System.ArgumentNullException"><paramref name="id">id</paramref> is null.</exception>
  313. <exception cref="T:System.Xml.XmlException"><paramref name="id">id</paramref> is not a valid XML identifier.</exception>
  314. <exception cref="T:System.ObjectDisposedException">The package is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  315. <exception cref="T:System.IO.IOException">The package is write-only.</exception>
  316. </member>
  317. <member name="M:System.IO.Packaging.Package.System#IDisposable#Dispose">
  318. <summary>This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended for application use. Use the type-safe <see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> method instead.</summary>
  319. </member>
  320. <member name="T:System.IO.Packaging.PackagePart">
  321. <summary>Provides a base class for parts stored in a <see cref="T:System.IO.Packaging.Package"></see>. This class is abstract.</summary>
  322. </member>
  323. <member name="M:System.IO.Packaging.PackagePart.#ctor(System.IO.Packaging.Package,System.Uri)">
  324. <summary>Initializes a new instance of the <see cref="T:System.IO.Packaging.PackagePart"></see> class with a specified parent <see cref="P:System.IO.Packaging.PackagePart.Package"></see> and part URI.</summary>
  325. <param name="package">The parent <see cref="T:System.IO.Packaging.Package"></see> of the part.</param>
  326. <param name="partUri">The URI of the part, relative to the parent <see cref="T:System.IO.Packaging.Package"></see> root.</param>
  327. <exception cref="T:System.ArgumentNullException"><paramref name="package">package</paramref> or <paramref name="partUri">partUri</paramref> is null.</exception>
  328. </member>
  329. <member name="M:System.IO.Packaging.PackagePart.#ctor(System.IO.Packaging.Package,System.Uri,System.String)">
  330. <summary>Initializes a new instance of the <see cref="T:System.IO.Packaging.PackagePart"></see> class with a specified parent <see cref="P:System.IO.Packaging.PackagePart.Package"></see>, part URI, and MIME content type.</summary>
  331. <param name="package">The parent <see cref="T:System.IO.Packaging.Package"></see> of the part.</param>
  332. <param name="partUri">The URI of the part, relative to the parent <see cref="T:System.IO.Packaging.Package"></see> root.</param>
  333. <param name="contentType">The MIME content type of the part data stream.</param>
  334. <exception cref="T:System.ArgumentNullException"><paramref name="package">package</paramref> or <paramref name="partUri">partUri</paramref> is null.</exception>
  335. <exception cref="T:System.ArgumentException"><paramref name="partUri">partUri</paramref> is not a valid <see cref="T:System.IO.Packaging.PackagePart"></see> URI.</exception>
  336. </member>
  337. <member name="M:System.IO.Packaging.PackagePart.#ctor(System.IO.Packaging.Package,System.Uri,System.String,System.IO.Packaging.CompressionOption)">
  338. <summary>Initializes a new instance of the <see cref="T:System.IO.Packaging.PackagePart"></see> class with a specified parent <see cref="P:System.IO.Packaging.PackagePart.Package"></see>, part URI, MIME content type, and <see cref="T:System.IO.Packaging.CompressionOption"></see>.</summary>
  339. <param name="package">The parent <see cref="T:System.IO.Packaging.Package"></see> of the part.</param>
  340. <param name="partUri">The URI of the part, relative to the parent <see cref="T:System.IO.Packaging.Package"></see> root.</param>
  341. <param name="contentType">The MIME content type of the part's data stream.</param>
  342. <param name="compressionOption">The compression option of the part data stream.</param>
  343. <exception cref="T:System.ArgumentNullException"><paramref name="package">package</paramref> or <paramref name="partUri">partUri</paramref> is null.</exception>
  344. <exception cref="T:System.ArgumentException"><paramref name="partUri">partUri</paramref> is not a valid <see cref="T:System.IO.Packaging.PackagePart"></see> URI.</exception>
  345. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="compressionOption">compressionOption</paramref> value is not valid.</exception>
  346. </member>
  347. <member name="P:System.IO.Packaging.PackagePart.CompressionOption">
  348. <summary>Gets the compression option of the part content stream.</summary>
  349. <returns>The compression option of the part content stream.</returns>
  350. <exception cref="T:System.InvalidOperationException">The part has been deleted. -or- The <see cref="P:System.IO.Packaging.PackagePart.Package"></see> is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  351. </member>
  352. <member name="P:System.IO.Packaging.PackagePart.ContentType">
  353. <summary>Gets the MIME type of the content stream.</summary>
  354. <returns>The MIME type of the content data stream for the part.</returns>
  355. <exception cref="T:System.InvalidOperationException">The part has been deleted. -or- The <see cref="P:System.IO.Packaging.PackagePart.Package"></see> is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called). -or- The string returned by the derived class <see cref="M:System.IO.Packaging.PackagePart.GetContentTypeCore"></see> method is empty.</exception>
  356. </member>
  357. <member name="M:System.IO.Packaging.PackagePart.CreateRelationship(System.Uri,System.IO.Packaging.TargetMode,System.String)">
  358. <summary>Creates a part-level relationship between this <see cref="T:System.IO.Packaging.PackagePart"></see> to a specified target <see cref="T:System.IO.Packaging.PackagePart"></see> or external resource.</summary>
  359. <param name="targetUri">The URI of the target part.</param>
  360. <param name="targetMode">One of the enumeration values. For example, <see cref="F:System.IO.Packaging.TargetMode.Internal"></see> if the target part is inside the <see cref="T:System.IO.Packaging.Package"></see>; or <see cref="F:System.IO.Packaging.TargetMode.External"></see> if the target is a resource outside the <see cref="T:System.IO.Packaging.Package"></see>.</param>
  361. <param name="relationshipType">The role of the relationship.</param>
  362. <returns>The part-level relationship between this <see cref="T:System.IO.Packaging.PackagePart"></see> to the target <see cref="T:System.IO.Packaging.PackagePart"></see> or external resource.</returns>
  363. <exception cref="T:System.InvalidOperationException">The part has been deleted. -or- The <see cref="P:System.IO.Packaging.PackagePart.Package"></see> is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  364. <exception cref="T:System.ArgumentNullException"><paramref name="targetUri">targetUri</paramref> or <paramref name="relationshipType">relationshipType</paramref> is null.</exception>
  365. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="targetMode">targetMode</paramref> parameter is not a valid <see cref="T:System.IO.Packaging.TargetMode"></see> enumeration value.</exception>
  366. <exception cref="T:System.ArgumentException">The part identified by the <paramref name="targetUri">targetUri</paramref> is a relationship (the target of a relationship cannot be another relationship). -or- <paramref name="targetMode">targetMode</paramref> is specified as <see cref="F:System.IO.Packaging.TargetMode.Internal"></see> but <paramref name="targetUri">targetUri</paramref> is an absolute external URI.</exception>
  367. <exception cref="T:System.IO.IOException">The package is read-only (a new relationship cannot be added).</exception>
  368. </member>
  369. <member name="M:System.IO.Packaging.PackagePart.CreateRelationship(System.Uri,System.IO.Packaging.TargetMode,System.String,System.String)">
  370. <summary>Creates a part-level relationship between this <see cref="T:System.IO.Packaging.PackagePart"></see> to a specified target <see cref="T:System.IO.Packaging.PackagePart"></see> or external resource.</summary>
  371. <param name="targetUri">The URI of the target part.</param>
  372. <param name="targetMode">One of the enumeration values. For example, <see cref="F:System.IO.Packaging.TargetMode.Internal"></see> if the target part is inside the <see cref="T:System.IO.Packaging.Package"></see>; or <see cref="F:System.IO.Packaging.TargetMode.External"></see> if the target is a resource outside the <see cref="T:System.IO.Packaging.Package"></see>.</param>
  373. <param name="relationshipType">The role of the relationship.</param>
  374. <param name="id">A unique ID for the relationship.</param>
  375. <returns>The part-level relationship between this <see cref="T:System.IO.Packaging.PackagePart"></see> to the target <see cref="T:System.IO.Packaging.PackagePart"></see> or external resource.</returns>
  376. <exception cref="T:System.InvalidOperationException">The part has been deleted. -or- The <see cref="P:System.IO.Packaging.PackagePart.Package"></see> is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  377. <exception cref="T:System.ArgumentNullException"><paramref name="targetUri">targetUri</paramref> or <paramref name="relationshipType">relationshipType</paramref> is null.</exception>
  378. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="targetMode">targetMode</paramref> parameter is not a valid <see cref="T:System.IO.Packaging.TargetMode"></see> enumeration value.</exception>
  379. <exception cref="T:System.ArgumentException">The part identified by the <paramref name="targetUri">targetUri</paramref> is a relationship (the target of a relationship cannot be another relationship). -or- <paramref name="targetMode">targetMode</paramref> is specified as <see cref="F:System.IO.Packaging.TargetMode.Internal"></see> but <paramref name="targetUri">targetUri</paramref> is an absolute external URI.</exception>
  380. <exception cref="T:System.IO.IOException">The package is read-only (a new relationship cannot be added).</exception>
  381. <exception cref="T:System.Xml.XmlException"><paramref name="id">id</paramref> is not a valid XML identifier. -or- A part with the specified <paramref name="id">id</paramref> already exists.</exception>
  382. </member>
  383. <member name="M:System.IO.Packaging.PackagePart.DeleteRelationship(System.String)">
  384. <summary>Deletes a specified part-level <see cref="T:System.IO.Packaging.PackageRelationship"></see>.</summary>
  385. <param name="id">The <see cref="P:System.IO.Packaging.PackageRelationship.Id"></see> of the relationship to delete.</param>
  386. <exception cref="T:System.InvalidOperationException">The part has been deleted. -or- The <see cref="P:System.IO.Packaging.PackagePart.Package"></see> is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  387. <exception cref="T:System.ArgumentNullException"><paramref name="id">id</paramref> is null.</exception>
  388. <exception cref="T:System.IO.IOException">The package is read-only (relationships cannot be deleted).</exception>
  389. <exception cref="T:System.Xml.XmlException"><paramref name="id">id</paramref> is not a valid XML identifier.</exception>
  390. </member>
  391. <member name="M:System.IO.Packaging.PackagePart.GetContentTypeCore">
  392. <summary>When overridden in a derived class, returns the MIME type of the part content.</summary>
  393. <returns>The MIME type of the part content.</returns>
  394. <exception cref="T:System.NotSupportedException">The derived class does not provide an override implementation required for the <see cref="M:System.IO.Packaging.PackagePart.GetContentTypeCore"></see> method.</exception>
  395. </member>
  396. <member name="M:System.IO.Packaging.PackagePart.GetRelationship(System.String)">
  397. <summary>Returns the relationship that has a specified <see cref="P:System.IO.Packaging.PackageRelationship.Id"></see>.</summary>
  398. <param name="id">The <see cref="P:System.IO.Packaging.PackageRelationship.Id"></see> of the relationship to return.</param>
  399. <returns>The relationship that matches the specified <paramref name="id">id</paramref>.</returns>
  400. <exception cref="T:System.ArgumentNullException"><paramref name="id">id</paramref> is null.</exception>
  401. <exception cref="T:System.Xml.XmlException"><paramref name="id">id</paramref> is not a valid XML identifier.</exception>
  402. <exception cref="T:System.ArgumentException"><paramref name="relationshipType">relationshipType</paramref> is an empty string.</exception>
  403. <exception cref="T:System.InvalidOperationException">The part has been deleted. -or- The <see cref="P:System.IO.Packaging.PackagePart.Package"></see> is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called). -or- A relationship with the specified <paramref name="id">id</paramref> does not exist in the package.</exception>
  404. <exception cref="T:System.IO.IOException">The package is write-only (relationship information cannot be read).</exception>
  405. </member>
  406. <member name="M:System.IO.Packaging.PackagePart.GetRelationships">
  407. <summary>Returns a collection of all the relationships that are owned by this part.</summary>
  408. <returns>A collection of all the relationships that are owned by the part.</returns>
  409. <exception cref="T:System.InvalidOperationException">The part has been deleted. -or- The <see cref="P:System.IO.Packaging.PackagePart.Package"></see> is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  410. <exception cref="T:System.IO.IOException">The package is write-only (relationship information cannot be read).</exception>
  411. </member>
  412. <member name="M:System.IO.Packaging.PackagePart.GetRelationshipsByType(System.String)">
  413. <summary>Returns a collection of the relationships that match a specified <see cref="P:System.IO.Packaging.PackageRelationship.RelationshipType"></see>.</summary>
  414. <param name="relationshipType">The <see cref="P:System.IO.Packaging.PackageRelationship.RelationshipType"></see> of the relationships to locate and return in the collection.</param>
  415. <returns>A collection of the relationships that match the specified <paramref name="relationshipType">relationshipType</paramref>.</returns>
  416. <exception cref="T:System.ArgumentNullException"><paramref name="relationshipType">relationshipType</paramref> is null.</exception>
  417. <exception cref="T:System.ArgumentException"><paramref name="relationshipType">relationshipType</paramref> is an empty string.</exception>
  418. <exception cref="T:System.InvalidOperationException">The part has been deleted. -or- The <see cref="P:System.IO.Packaging.PackagePart.Package"></see> is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  419. <exception cref="T:System.IO.IOException">The package is write-only (relationship information cannot be read).</exception>
  420. </member>
  421. <member name="M:System.IO.Packaging.PackagePart.GetStream">
  422. <summary>Returns the part content data stream.</summary>
  423. <returns>The content data stream for the part.</returns>
  424. <exception cref="T:System.InvalidOperationException">The part has been deleted. -or- The <see cref="P:System.IO.Packaging.PackagePart.Package"></see> is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  425. <exception cref="T:System.IO.IOException">The stream object returned by the <see cref="M:System.IO.Packaging.PackagePart.GetStreamCore(System.IO.FileMode,System.IO.FileAccess)"></see> method of the derived subclass is null.</exception>
  426. </member>
  427. <member name="M:System.IO.Packaging.PackagePart.GetStream(System.IO.FileMode)">
  428. <summary>Returns the content stream opened in a specified I/O <see cref="T:System.IO.FileMode"></see>.</summary>
  429. <param name="mode">The I/O mode in which to open the content stream.</param>
  430. <returns>The content stream of the part.</returns>
  431. <exception cref="T:System.InvalidOperationException">The part has been deleted. -or- The <see cref="P:System.IO.Packaging.PackagePart.Package"></see> is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  432. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="mode">mode</paramref> parameter is not a valid <see cref="T:System.IO.FileMode"></see> enumeration value.</exception>
  433. <exception cref="T:System.IO.IOException">The <paramref name="mode">mode</paramref> parameter is not compatible with the package and part stream. -or- The stream object returned by the <see cref="M:System.IO.Packaging.PackagePart.GetStreamCore(System.IO.FileMode,System.IO.FileAccess)"></see> method of the derived subclass is null.</exception>
  434. </member>
  435. <member name="M:System.IO.Packaging.PackagePart.GetStream(System.IO.FileMode,System.IO.FileAccess)">
  436. <summary>Returns the part content stream opened with a specified <see cref="T:System.IO.FileMode"></see> and <see cref="T:System.IO.FileAccess"></see>.</summary>
  437. <param name="mode">The I/O mode in which to open the content stream.</param>
  438. <param name="access">The access permissions to use in opening the content stream.</param>
  439. <returns>The content stream for the part.</returns>
  440. <exception cref="T:System.InvalidOperationException">The part has been deleted. -or- The <see cref="P:System.IO.Packaging.PackagePart.Package"></see> is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  441. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="mode">mode</paramref> parameter is not a valid <see cref="T:System.IO.FileMode"></see> enumeration value. -or- The <paramref name="access">access</paramref> parameter is not a valid <see cref="T:System.IO.FileAccess"></see> enumeration value.</exception>
  442. <exception cref="T:System.IO.IOException"><paramref name="mode">mode</paramref> or <paramref name="access">access</paramref> is not compatible with the package and part stream. -or- The <paramref name="access">access</paramref> parameter is specified as <see cref="F:System.IO.FileAccess.Read"></see> but the <paramref name="mode">mode</paramref> parameter requires write access. (<see cref="T:System.IO.FileMode"></see> values of <see cref="F:System.IO.FileMode.Create"></see>, <see cref="F:System.IO.FileMode.CreateNew"></see>, <see cref="F:System.IO.FileMode.Truncate"></see>, and <see cref="F:System.IO.FileMode.Append"></see> require <see cref="F:System.IO.FileAccess.Write"></see> or <see cref="F:System.IO.FileAccess.ReadWrite"></see> access.) -or- The stream object returned by the <see cref="M:System.IO.Packaging.PackagePart.GetStreamCore(System.IO.FileMode,System.IO.FileAccess)"></see> method of the derived subclass is null.</exception>
  443. </member>
  444. <member name="M:System.IO.Packaging.PackagePart.GetStreamCore(System.IO.FileMode,System.IO.FileAccess)">
  445. <summary>When overridden in a derived class, returns the part content stream opened with a specified <see cref="T:System.IO.FileMode"></see> and <see cref="T:System.IO.FileAccess"></see>.</summary>
  446. <param name="mode">The I/O mode in which to open the content stream.</param>
  447. <param name="access">The access permissions to use in opening the content stream.</param>
  448. <returns>The content data stream of the part.</returns>
  449. </member>
  450. <member name="P:System.IO.Packaging.PackagePart.Package">
  451. <summary>Gets the parent <see cref="T:System.IO.Packaging.Package"></see> of the part.</summary>
  452. <returns>The parent package of the part.</returns>
  453. <exception cref="T:System.InvalidOperationException">The part has been deleted. -or- The <see cref="P:System.IO.Packaging.PackagePart.Package"></see> is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  454. </member>
  455. <member name="M:System.IO.Packaging.PackagePart.RelationshipExists(System.String)">
  456. <summary>Returns a value that indicates whether this part owns a relationship with a specified <see cref="P:System.IO.Packaging.PackageRelationship.Id"></see>.</summary>
  457. <param name="id">The <see cref="P:System.IO.Packaging.PackageRelationship.Id"></see> of the relationship to check for.</param>
  458. <returns>true if this part owns a relationship with the specified <paramref name="id">id</paramref>; otherwise, false.</returns>
  459. <exception cref="T:System.ArgumentNullException"><paramref name="id">id</paramref> is null.</exception>
  460. <exception cref="T:System.Xml.XmlException"><paramref name="id">id</paramref> is not a valid XML identifier.</exception>
  461. <exception cref="T:System.InvalidOperationException">The part has been deleted. -or- The <see cref="P:System.IO.Packaging.PackagePart.Package"></see> is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  462. <exception cref="T:System.IO.IOException">The package is write-only (relationship information cannot be read).</exception>
  463. </member>
  464. <member name="P:System.IO.Packaging.PackagePart.Uri">
  465. <summary>Gets the URI of the part.</summary>
  466. <returns>The URI of the part relative to the package root.</returns>
  467. <exception cref="T:System.InvalidOperationException">The part has been deleted. -or- The <see cref="P:System.IO.Packaging.PackagePart.Package"></see> is not open (<see cref="M:System.IO.Packaging.Package.Dispose(System.Boolean)"></see> or <see cref="M:System.IO.Packaging.Package.Close"></see> has been called).</exception>
  468. </member>
  469. <member name="T:System.IO.Packaging.PackagePartCollection">
  470. <summary>Represents a collection of <see cref="T:System.IO.Packaging.PackagePart"></see> objects.</summary>
  471. </member>
  472. <member name="M:System.IO.Packaging.PackagePartCollection.GetEnumerator">
  473. <summary>Returns an enumerator for iterating through the parts in the collection.</summary>
  474. <returns>An enumerator for iterating through the <see cref="T:System.IO.Packaging.PackagePart"></see> elements in the collection.</returns>
  475. </member>
  476. <member name="M:System.IO.Packaging.PackagePartCollection.System#Collections#Generic#IEnumerable{System#IO#Packaging#PackagePart}#GetEnumerator">
  477. <summary>Returns an enumerator that iterates through the collection.</summary>
  478. <returns>An <see cref="T:System.Collections.Generic.IEnumerator`1"></see> object that can be used to iterate through the collection.</returns>
  479. </member>
  480. <member name="M:System.IO.Packaging.PackagePartCollection.System#Collections#IEnumerable#GetEnumerator">
  481. <summary>For a description of this member, see <see cref="M:System.Collections.IEnumerable.GetEnumerator"></see>.</summary>
  482. <returns>An <see cref="T:System.Collections.IEnumerator"></see> object that can be used to iterate through the collection.</returns>
  483. </member>
  484. <member name="T:System.IO.Packaging.PackageProperties">
  485. <summary>Represents the core properties of a <see cref="T:System.IO.Packaging.Package"></see>.</summary>
  486. </member>
  487. <member name="M:System.IO.Packaging.PackageProperties.#ctor">
  488. <summary>Initializes a new instance of the <see cref="T:System.IO.Packaging.PackageProperties"></see> class.</summary>
  489. </member>
  490. <member name="P:System.IO.Packaging.PackageProperties.Category">
  491. <summary>When overridden in a derived class, gets or sets the category of the <see cref="T:System.IO.Packaging.Package"></see>.</summary>
  492. <returns>The category of the content that is contained in the <see cref="T:System.IO.Packaging.Package"></see>.</returns>
  493. </member>
  494. <member name="P:System.IO.Packaging.PackageProperties.ContentStatus">
  495. <summary>When overridden in a derived class, gets or sets a value that represents the status of the <see cref="T:System.IO.Packaging.Package"></see>.</summary>
  496. <returns>The status of the <see cref="T:System.IO.Packaging.Package"></see> content.</returns>
  497. </member>
  498. <member name="P:System.IO.Packaging.PackageProperties.ContentType">
  499. <summary>When overridden in a derived class, gets or sets a value that represents the type of content that is contained in the <see cref="T:System.IO.Packaging.Package"></see>.</summary>
  500. <returns>The type of content that is contained in the <see cref="T:System.IO.Packaging.Package"></see>.</returns>
  501. </member>
  502. <member name="P:System.IO.Packaging.PackageProperties.Created">
  503. <summary>When overridden in a derived class, gets or sets the date and time the <see cref="T:System.IO.Packaging.Package"></see> was created.</summary>
  504. <returns>The date and time the <see cref="T:System.IO.Packaging.Package"></see> was initially created.</returns>
  505. </member>
  506. <member name="P:System.IO.Packaging.PackageProperties.Creator">
  507. <summary>When overridden in a derived class, gets or sets a value that identifies the individual or entity that created the <see cref="T:System.IO.Packaging.Package"></see> and its content.</summary>
  508. <returns>The individual or entity that created the <see cref="T:System.IO.Packaging.Package"></see> and its content.</returns>
  509. </member>
  510. <member name="P:System.IO.Packaging.PackageProperties.Description">
  511. <summary>When overridden in a derived class, gets or sets a description of the content contained in the <see cref="T:System.IO.Packaging.Package"></see>.</summary>
  512. <returns>A description of the content contained in the <see cref="T:System.IO.Packaging.Package"></see>.</returns>
  513. </member>
  514. <member name="M:System.IO.Packaging.PackageProperties.Dispose">
  515. <summary>Releases all resources used by the <see cref="T:System.IO.Packaging.PackageProperties"></see> instance.</summary>
  516. </member>
  517. <member name="M:System.IO.Packaging.PackageProperties.Dispose(System.Boolean)">
  518. <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Packaging.PackageProperties"></see> instance and optionally releases the managed resources.</summary>
  519. <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
  520. </member>
  521. <member name="P:System.IO.Packaging.PackageProperties.Identifier">
  522. <summary>When overridden in a derived class, gets or sets a value that unambiguously identifies the <see cref="T:System.IO.Packaging.Package"></see> and its content.</summary>
  523. <returns>A value that unambiguously identifies the <see cref="T:System.IO.Packaging.Package"></see> and its content.</returns>
  524. </member>
  525. <member name="P:System.IO.Packaging.PackageProperties.Keywords">
  526. <summary>When overridden in a derived class, gets or sets a value that define a delimited set of keywords to support searching and indexing the <see cref="T:System.IO.Packaging.Package"></see> and its content.</summary>
  527. <returns>A delimited set of keywords to support searching and indexing the <see cref="T:System.IO.Packaging.Package"></see> and content.</returns>
  528. </member>
  529. <member name="P:System.IO.Packaging.PackageProperties.Language">
  530. <summary>When overridden in a derived class, gets or sets a value that identifies the language of the <see cref="T:System.IO.Packaging.Package"></see> content.</summary>
  531. <returns>A value that identifies the <see cref="T:System.IO.Packaging.Package"></see> content language.</returns>
  532. </member>
  533. <member name="P:System.IO.Packaging.PackageProperties.LastModifiedBy">
  534. <summary>When overridden in a derived class, gets or sets a value that identifies the user who last modified the <see cref="T:System.IO.Packaging.Package"></see> content.</summary>
  535. <returns>The user who last modified the <see cref="T:System.IO.Packaging.Package"></see> content.</returns>
  536. </member>
  537. <member name="P:System.IO.Packaging.PackageProperties.LastPrinted">
  538. <summary>When overridden in a derived class, gets or sets the date and time the <see cref="T:System.IO.Packaging.Package"></see> content was last printed.</summary>
  539. <returns>The date and time the <see cref="T:System.IO.Packaging.Package"></see> content was last printed.</returns>
  540. </member>
  541. <member name="P:System.IO.Packaging.PackageProperties.Modified">
  542. <summary>When overridden in a derived class, gets or sets the date and time the <see cref="T:System.IO.Packaging.Package"></see> was last changed.</summary>
  543. <returns>The date and time the <see cref="T:System.IO.Packaging.Package"></see> was last changed.</returns>
  544. </member>
  545. <member name="P:System.IO.Packaging.PackageProperties.Revision">
  546. <summary>When overridden in a derived class, gets or sets the revision number of the <see cref="T:System.IO.Packaging.Package"></see>.</summary>
  547. <returns>The revision number of the <see cref="T:System.IO.Packaging.Package"></see>.</returns>
  548. </member>
  549. <member name="P:System.IO.Packaging.PackageProperties.Subject">
  550. <summary>When overridden in a derived class, gets or sets the topic of the <see cref="T:System.IO.Packaging.Package"></see> content.</summary>
  551. <returns>The topic of the <see cref="T:System.IO.Packaging.Package"></see> content.</returns>
  552. </member>
  553. <member name="P:System.IO.Packaging.PackageProperties.Title">
  554. <summary>When overridden in a derived class, gets or sets the name given to the <see cref="T:System.IO.Packaging.Package"></see> and its content.</summary>
  555. <returns>The name given to the <see cref="T:System.IO.Packaging.Package"></see> and its content.</returns>
  556. </member>
  557. <member name="P:System.IO.Packaging.PackageProperties.Version">
  558. <summary>When overridden in a derived class, gets or sets the version number of the <see cref="T:System.IO.Packaging.Package"></see>.</summary>
  559. <returns>The version number of the <see cref="T:System.IO.Packaging.Package"></see>.</returns>
  560. </member>
  561. <member name="T:System.IO.Packaging.PackageRelationship">
  562. <summary>Represents an association between a source <see cref="T:System.IO.Packaging.Package"></see> or <see cref="T:System.IO.Packaging.PackagePart"></see>, and a target object which can be a <see cref="T:System.IO.Packaging.PackagePart"></see> or external resource.</summary>
  563. </member>
  564. <member name="P:System.IO.Packaging.PackageRelationship.Id">
  565. <summary>Gets a string that identifies the relationship.</summary>
  566. <returns>A string that identifies the relationship.</returns>
  567. </member>
  568. <member name="P:System.IO.Packaging.PackageRelationship.Package">
  569. <summary>Gets the <see cref="T:System.IO.Packaging.Package"></see> that contains this relationship.</summary>
  570. <returns>The package that contains this relationship.</returns>
  571. </member>
  572. <member name="P:System.IO.Packaging.PackageRelationship.RelationshipType">
  573. <summary>Gets the qualified type name of the relationship.</summary>
  574. <returns>The qualified type name of the relationship.</returns>
  575. </member>
  576. <member name="P:System.IO.Packaging.PackageRelationship.SourceUri">
  577. <summary>Gets the URI of the package or part that owns the relationship.</summary>
  578. <returns>The URI of the <see cref="T:System.IO.Packaging.Package"></see> or <see cref="T:System.IO.Packaging.PackagePart"></see> that owns the relationship.</returns>
  579. </member>
  580. <member name="P:System.IO.Packaging.PackageRelationship.TargetMode">
  581. <summary>Gets a value that indicates whether the target of the relationship is <see cref="F:System.IO.Packaging.TargetMode.Internal"></see> or <see cref="F:System.IO.Packaging.TargetMode.External"></see> to the <see cref="T:System.IO.Packaging.Package"></see>.</summary>
  582. <returns>An enumeration value that indicates whether <see cref="P:System.IO.Packaging.PackageRelationship.TargetUri"></see> references a resource <see cref="F:System.IO.Packaging.TargetMode.Internal"></see> or <see cref="F:System.IO.Packaging.TargetMode.External"></see> to the <see cref="T:System.IO.Packaging.Package"></see>.</returns>
  583. </member>
  584. <member name="P:System.IO.Packaging.PackageRelationship.TargetUri">
  585. <summary>Gets the URI of the target resource of the relationship.</summary>
  586. <returns>The URI of the target resource.</returns>
  587. </member>
  588. <member name="T:System.IO.Packaging.PackageRelationshipCollection">
  589. <summary>Represents a collection of <see cref="T:System.IO.Packaging.PackageRelationship"></see> elements that are owned by a given <see cref="T:System.IO.Packaging.PackagePart"></see> or the <see cref="T:System.IO.Packaging.Package"></see>.</summary>
  590. </member>
  591. <member name="M:System.IO.Packaging.PackageRelationshipCollection.GetEnumerator">
  592. <summary>Returns an enumerator for iterating through the relationships in the collection.</summary>
  593. <returns>An enumerator for iterating through the <see cref="T:System.IO.Packaging.PackageRelationship"></see> elements in the collection.</returns>
  594. </member>
  595. <member name="M:System.IO.Packaging.PackageRelationshipCollection.System#Collections#IEnumerable#GetEnumerator">
  596. <summary>This type or member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code.</summary>
  597. <returns>Do not use—use <see cref="M:System.IO.Packaging.PackageRelationshipCollection.GetEnumerator"></see>.</returns>
  598. </member>
  599. <member name="T:System.IO.Packaging.PackageRelationshipSelector">
  600. <summary>Defines <see cref="T:System.IO.Packaging.PackageRelationship"></see> criteria to select part-level or package-level relationships.</summary>
  601. </member>
  602. <member name="M:System.IO.Packaging.PackageRelationshipSelector.#ctor(System.Uri,System.IO.Packaging.PackageRelationshipSelectorType,System.String)">
  603. <summary>Initializes a new instance of the <see cref="T:System.IO.Packaging.PackageRelationshipSelector"></see> class.</summary>
  604. <param name="sourceUri">The uniform resource identifier (URI) of the <see cref="T:System.IO.Packaging.PackagePart"></see> or the <see cref="T:System.IO.Packaging.Package"></see> (SourceUri=&quot;/&quot;) that owns the relationship.</param>
  605. <param name="selectorType">The type of the selectionCriteria, either by relationship <see cref="F:System.IO.Packaging.PackageRelationshipSelectorType.Id"></see> or relationship <see cref="F:System.IO.Packaging.PackageRelationshipSelectorType.Type"></see>.</param>
  606. <param name="selectionCriteria">The qualification string that is used to select the relationships based on the selectorType.</param>
  607. <exception cref="T:System.ArgumentNullException"><paramref name="sourceUri">sourceUri</paramref> or <paramref name="selectionCriteria">selectionCriteria</paramref> is null.</exception>
  608. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="selectorType">selectorType</paramref> parameter is not valid.</exception>
  609. <exception cref="T:System.Xml.XmlException">The <paramref name="selectorType">selectorType</paramref> parameter is <see cref="F:System.IO.Packaging.PackageRelationshipSelectorType.Id"></see> but <paramref name="selectionCriteria">selectionCriteria</paramref> is not a valid XML Schema Definition (XSD) identifier (ID).</exception>
  610. <exception cref="T:System.ArgumentException">The <paramref name="sourceUri">sourceUri</paramref> is not the <see cref="T:System.IO.Packaging.Package"></see> root (&quot;/&quot;) and is also not a valid <see cref="T:System.IO.Packaging.PackagePart"></see> URI.</exception>
  611. </member>
  612. <member name="M:System.IO.Packaging.PackageRelationshipSelector.Select(System.IO.Packaging.Package)">
  613. <summary>Returns a list of <see cref="T:System.IO.Packaging.PackageRelationship"></see> objects that match the defined <see cref="P:System.IO.Packaging.PackageRelationshipSelector.SourceUri"></see>, <see cref="P:System.IO.Packaging.PackageRelationshipSelector.SelectorType"></see>, and <see cref="P:System.IO.Packaging.PackageRelationshipSelector.SelectionCriteria"></see>.</summary>
  614. <param name="package">The package from which to select the relationships based on the selection criteria.</param>
  615. <returns>A list of relationships that match the selection parameters specified to the <see cref="M:System.IO.Packaging.PackageRelationshipSelector.#ctor(System.Uri,System.IO.Packaging.PackageRelationshipSelectorType,System.String)"></see> constructor.</returns>
  616. </member>
  617. <member name="P:System.IO.Packaging.PackageRelationshipSelector.SelectionCriteria">
  618. <summary>Gets the selection criteria specified to the <see cref="M:System.IO.Packaging.PackageRelationshipSelector.#ctor(System.Uri,System.IO.Packaging.PackageRelationshipSelectorType,System.String)"></see> constructor.</summary>
  619. <returns>The selection criteria based on the <see cref="P:System.IO.Packaging.PackageRelationshipSelector.SelectorType"></see> of <see cref="F:System.IO.Packaging.PackageRelationshipSelectorType.Id"></see> or <see cref="F:System.IO.Packaging.PackageRelationshipSelectorType.Type"></see> specified to the <see cref="M:System.IO.Packaging.PackageRelationshipSelector.#ctor(System.Uri,System.IO.Packaging.PackageRelationshipSelectorType,System.String)"></see> constructor.</returns>
  620. </member>
  621. <member name="P:System.IO.Packaging.PackageRelationshipSelector.SelectorType">
  622. <summary>Gets the <see cref="T:System.IO.Packaging.PackageRelationshipSelectorType"></see> specified to the <see cref="M:System.IO.Packaging.PackageRelationshipSelector.#ctor(System.Uri,System.IO.Packaging.PackageRelationshipSelectorType,System.String)"></see> constructor.</summary>
  623. <returns>The selector type of <see cref="F:System.IO.Packaging.PackageRelationshipSelectorType.Id"></see> or <see cref="F:System.IO.Packaging.PackageRelationshipSelectorType.Type"></see> specified to the <see cref="M:System.IO.Packaging.PackageRelationshipSelector.#ctor(System.Uri,System.IO.Packaging.PackageRelationshipSelectorType,System.String)"></see> constructor.</returns>
  624. </member>
  625. <member name="P:System.IO.Packaging.PackageRelationshipSelector.SourceUri">
  626. <summary>Gets the root package URI (&quot;/&quot;) or part <see cref="P:System.IO.Packaging.PackagePart.Uri"></see> specified to the <see cref="M:System.IO.Packaging.PackageRelationshipSelector.#ctor(System.Uri,System.IO.Packaging.PackageRelationshipSelectorType,System.String)"></see> constructor as the owner of the relationship.</summary>
  627. <returns>The root package URI (&quot;/&quot;) or part <see cref="P:System.IO.Packaging.PackagePart.Uri"></see> specified to the <see cref="M:System.IO.Packaging.PackageRelationshipSelector.#ctor(System.Uri,System.IO.Packaging.PackageRelationshipSelectorType,System.String)"></see> constructor as the owner of the relationship.</returns>
  628. </member>
  629. <member name="T:System.IO.Packaging.PackageRelationshipSelectorType">
  630. <summary>Specifies the type of selection criteria that is used to match and return <see cref="T:System.IO.Packaging.PackageRelationship"></see> selections through a <see cref="T:System.IO.Packaging.PackageRelationshipSelector"></see>.</summary>
  631. </member>
  632. <member name="F:System.IO.Packaging.PackageRelationshipSelectorType.Id">
  633. <summary><see cref="T:System.IO.Packaging.PackageRelationship"></see> selections are by <see cref="P:System.IO.Packaging.PackageRelationship.Id"></see>.</summary>
  634. <returns></returns>
  635. </member>
  636. <member name="F:System.IO.Packaging.PackageRelationshipSelectorType.Type">
  637. <summary><see cref="T:System.IO.Packaging.PackageRelationship"></see> selections are by <see cref="P:System.IO.Packaging.PackageRelationship.RelationshipType"></see>.</summary>
  638. <returns></returns>
  639. </member>
  640. <member name="T:System.IO.Packaging.PackUriHelper">
  641. <summary>Provides utility methods to compose and parse pack URI objects.</summary>
  642. </member>
  643. <member name="M:System.IO.Packaging.PackUriHelper.ComparePartUri(System.Uri,System.Uri)">
  644. <summary>Returns a value that indicates whether two package part URIs are equivalent.</summary>
  645. <param name="firstPartUri">The URI of the first <see cref="T:System.IO.Packaging.PackagePart"></see>.</param>
  646. <param name="secondPartUri">The URI of the second <see cref="T:System.IO.Packaging.PackagePart"></see>.</param>
  647. <returns><p sourcefile="System.IO.Packaging.yml" sourcestartlinenumber="1" sourceendlinenumber="2"><p sourcefile="System.IO.Packaging.yml" sourcestartlinenumber="1" sourceendlinenumber="1">A value that indicates the relationship between <code data-dev-comment-type="paramref">firstPartUri</code> and <code data-dev-comment-type="paramref">secondPartUri</code>. </p>
  648. <table><thead><tr><th> Value <p>
  649. <p sourcefile="System.IO.Packaging.yml" sourcestartlinenumber="4" sourceendlinenumber="4"> </th><th> Meaning <p>
  650. <p sourcefile="System.IO.Packaging.yml" sourcestartlinenumber="6" sourceendlinenumber="6"> </th></tr></thead><tbody><tr><td> Less than 0 <p>
  651. <p sourcefile="System.IO.Packaging.yml" sourcestartlinenumber="8" sourceendlinenumber="8"> </td><td><code data-dev-comment-type="paramref">firstPartUri</code> is less than <code data-dev-comment-type="paramref">secondPartUri</code>. <p>
  652. <p sourcefile="System.IO.Packaging.yml" sourcestartlinenumber="10" sourceendlinenumber="10"> </td></tr><tr><td> 0 <p>
  653. <p sourcefile="System.IO.Packaging.yml" sourcestartlinenumber="12" sourceendlinenumber="12"> </td><td><code data-dev-comment-type="paramref">firstPartUri</code> is equivalent to <code data-dev-comment-type="paramref">secondPartUri</code>. <p>
  654. <p sourcefile="System.IO.Packaging.yml" sourcestartlinenumber="14" sourceendlinenumber="14"> </td></tr><tr><td> Greater than 0 <p>
  655. <p sourcefile="System.IO.Packaging.yml" sourcestartlinenumber="16" sourceendlinenumber="16"> </td><td><code data-dev-comment-type="paramref">firstPartUri</code> is greater than <code data-dev-comment-type="paramref">secondPartUri</code>. <p>
  656. <p sourcefile="System.IO.Packaging.yml" sourcestartlinenumber="18" sourceendlinenumber="18"> </td></tr></tbody></table></p>
  657. </returns>
  658. <exception cref="T:System.ArgumentException"><paramref name="firstPartUri">firstPartUri</paramref> or <paramref name="secondPartUri">secondPartUri</paramref> is not a valid part URI syntax.</exception>
  659. </member>
  660. <member name="M:System.IO.Packaging.PackUriHelper.CreatePartUri(System.Uri)">
  661. <summary>Creates a formatted <see cref="T:System.IO.Packaging.PackagePart"></see> URI.</summary>
  662. <param name="partUri">The URI of the <see cref="T:System.IO.Packaging.PackagePart"></see> within the package.</param>
  663. <returns>A formatted <see cref="T:System.IO.Packaging.PackagePart"></see> URI.</returns>
  664. </member>
  665. <member name="M:System.IO.Packaging.PackUriHelper.GetNormalizedPartUri(System.Uri)">
  666. <summary>Returns the normalized form of a specified <see cref="T:System.IO.Packaging.PackagePart"></see> URI.</summary>
  667. <param name="partUri">The <see cref="T:System.IO.Packaging.PackagePart"></see> URI to normalize.</param>
  668. <returns>The normalized form of the given <paramref name="partUri">partUri</paramref>.</returns>
  669. <exception cref="T:System.ArgumentNullException"><paramref name="partUri">partUri</paramref> is null.</exception>
  670. </member>
  671. <member name="M:System.IO.Packaging.PackUriHelper.GetRelationshipPartUri(System.Uri)">
  672. <summary>Returns the URI of the relationship part associated with a specified <see cref="T:System.IO.Packaging.PackagePart"></see>.</summary>
  673. <param name="partUri">The <see cref="P:System.IO.Packaging.PackagePart.Uri"></see> of the <see cref="T:System.IO.Packaging.PackagePart"></see> to return the URI for the associated <see cref="T:System.IO.Packaging.PackageRelationship"></see>.</param>
  674. <returns>The URI of the <see cref="T:System.IO.Packaging.PackageRelationship"></see> part associated with the <see cref="T:System.IO.Packaging.PackagePart"></see> identified by <paramref name="partUri">partUri</paramref>.</returns>
  675. <exception cref="T:System.ArgumentNullException"><paramref name="partUri">partUri</paramref> is null.</exception>
  676. <exception cref="T:System.ArgumentException"><paramref name="partUri">partUri</paramref> syntax is not valid for a package part URI. -or- <paramref name="partUri">partUri</paramref> is an absolute URI. -or- <paramref name="partUri">partUri</paramref> references a relationship part.</exception>
  677. </member>
  678. <member name="M:System.IO.Packaging.PackUriHelper.GetRelativeUri(System.Uri,System.Uri)">
  679. <summary>Returns the relative URI between two specified <see cref="T:System.IO.Packaging.PackagePart"></see> URIs.</summary>
  680. <param name="sourcePartUri">The URI of the source part.</param>
  681. <param name="targetPartUri">The URI of the target part.</param>
  682. <returns>The relative URI from <paramref name="sourcePartUri">sourcePartUri</paramref> to <paramref name="targetPartUri">targetPartUri</paramref>.</returns>
  683. <exception cref="T:System.ArgumentNullException"><paramref name="sourcePartUri">sourcePartUri</paramref> or <paramref name="targetPartUri">targetPartUri</paramref> is null.</exception>
  684. </member>
  685. <member name="M:System.IO.Packaging.PackUriHelper.GetSourcePartUriFromRelationshipPartUri(System.Uri)">
  686. <summary>Returns the <see cref="P:System.IO.Packaging.PackageRelationship.SourceUri"></see> from the <see cref="T:System.IO.Packaging.PackageRelationship"></see> with a specified URI.</summary>
  687. <param name="relationshipPartUri">The URI of the relationship part to return the <see cref="P:System.IO.Packaging.PackageRelationship.SourceUri"></see> from.</param>
  688. <returns>The <see cref="P:System.IO.Packaging.PackageRelationship.SourceUri"></see> of the <see cref="T:System.IO.Packaging.PackagePart"></see> from the relationship with the specified <paramref name="relationshipPartUri">relationshipPartUri</paramref>.</returns>
  689. <exception cref="T:System.ArgumentNullException"><paramref name="relationshipPartUri">relationshipPartUri</paramref> is null.</exception>
  690. <exception cref="T:System.ArgumentException"><paramref name="relationshipPartUri">relationshipPartUri</paramref> is an absolute URI. -or- <paramref name="relationshipPartUri">relationshipPartUri</paramref> syntax is not valid for a <see cref="T:System.IO.Packaging.PackagePart"></see>. -or- <paramref name="relationshipPartUri">relationshipPartUri</paramref> does not reference a relationship part. -or- The <see cref="P:System.IO.Packaging.PackageRelationship.SourceUri"></see> of the relationship part references another relationship part (not valid).</exception>
  691. </member>
  692. <member name="M:System.IO.Packaging.PackUriHelper.IsRelationshipPartUri(System.Uri)">
  693. <summary>Returns a value that indicates whether a specified URI is the URI of a <see cref="T:System.IO.Packaging.PackageRelationship"></see> part.</summary>
  694. <param name="partUri">The URI to check for a <see cref="T:System.IO.Packaging.PackageRelationship"></see> part.</param>
  695. <returns>true if <paramref name="partUri">partUri</paramref> identifies a <see cref="T:System.IO.Packaging.PackageRelationship"></see> part; otherwise, false.</returns>
  696. <exception cref="T:System.ArgumentNullException"><paramref name="partUri">partUri</paramref> is null.</exception>
  697. <exception cref="T:System.ArgumentException"><paramref name="partUri">partUri</paramref> is an absolute URI. -or- <paramref name="partUri">partUri</paramref> is an invalid <see cref="T:System.IO.Packaging.PackagePart"></see> syntax.</exception>
  698. </member>
  699. <member name="M:System.IO.Packaging.PackUriHelper.ResolvePartUri(System.Uri,System.Uri)">
  700. <summary>Returns a part URI given a source part URI and a URI with a relative path to a target part.</summary>
  701. <param name="sourcePartUri">The URI of the source part, or &quot;/&quot; to designate the <see cref="T:System.IO.Packaging.Package"></see> root.</param>
  702. <param name="targetUri">The relative URI to the target part.</param>
  703. <returns>The URI of the target part resolved between the specified <paramref name="SourcePartUri">SourcePartUri</paramref> and the <paramref name="targetUri">targetUri</paramref> parameters.</returns>
  704. <exception cref="T:System.ArgumentNullException"><paramref name="sourcePartUri">sourcePartUri</paramref> or <paramref name="targetUri">targetUri</paramref> is null.</exception>
  705. <exception cref="T:System.ArgumentException"><paramref name="sourcePartUri">sourcePartUri</paramref> is not a valid part URI. -or- <paramref name="targetUri">targetUri</paramref> is not a valid relative URI.</exception>
  706. </member>
  707. <member name="F:System.IO.Packaging.PackUriHelper.UriSchemePack">
  708. <summary>Defines the pack URI scheme name &quot;pack&quot;.</summary>
  709. <returns></returns>
  710. </member>
  711. <member name="T:System.IO.Packaging.TargetMode">
  712. <summary>Specifies whether the target of a <see cref="T:System.IO.Packaging.PackageRelationship"></see> is inside or outside the <see cref="T:System.IO.Packaging.Package"></see>.</summary>
  713. </member>
  714. <member name="F:System.IO.Packaging.TargetMode.External">
  715. <summary>The relationship references a resource that is external to the package.</summary>
  716. <returns></returns>
  717. </member>
  718. <member name="F:System.IO.Packaging.TargetMode.Internal">
  719. <summary>The relationship references a part that is inside the package.</summary>
  720. <returns></returns>
  721. </member>
  722. <member name="T:System.IO.Packaging.ZipPackage">
  723. <summary>Implements a derived subclass of the abstract <see cref="T:System.IO.Packaging.Package"></see> base class—the <see cref="T:System.IO.Packaging.ZipPackage"></see> class uses a ZIP archive as the container store. This class cannot be inherited.</summary>
  724. </member>
  725. <member name="T:System.IO.Packaging.ZipPackagePart">
  726. <summary>Represents a part that is stored in a <see cref="T:System.IO.Packaging.ZipPackage"></see>.</summary>
  727. </member>
  728. </members>
  729. </doc></span>