Class PnPPackage

Defines a PnP OpenXML package file

Inheritance
System.Object
PnPPackage
Namespace: PnP.Framework.Provisioning.Connectors.OpenXML
Assembly: PnP.Framework.dll
Syntax
public class PnPPackage : IDisposable

Fields

CT_FILE

Declaration
public const string CT_FILE = null
Field Value
System.String

CT_ORIGIN

Declaration
public const string CT_ORIGIN = null
Field Value
System.String

CT_PROVISIONINGTEMPLATE_BODY

Declaration
public const string CT_PROVISIONINGTEMPLATE_BODY = null
Field Value
System.String

CT_PROVISIONINGTEMPLATE_FILES_MAP

Declaration
public const string CT_PROVISIONINGTEMPLATE_FILES_MAP = null
Field Value
System.String

CT_PROVISIONINGTEMPLATE_MANIFEST

Declaration
public const string CT_PROVISIONINGTEMPLATE_MANIFEST = null
Field Value
System.String

CT_PROVISIONINGTEMPLATE_PROPERTIES

Declaration
public const string CT_PROVISIONINGTEMPLATE_PROPERTIES = null
Field Value
System.String

EXT_PROVISIONINGTEMPLATE

Declaration
public const string EXT_PROVISIONINGTEMPLATE = null
Field Value
System.String

PACKAGE_COMPRESSION_LEVEL

Declaration
public const CompressionOption PACKAGE_COMPRESSION_LEVEL = null
Field Value
CompressionOption

R_PROVISIONINGTEMPLATE_BODY

Declaration
public const string R_PROVISIONINGTEMPLATE_BODY = null
Field Value
System.String

R_PROVISIONINGTEMPLATE_FILE

Declaration
public const string R_PROVISIONINGTEMPLATE_FILE = null
Field Value
System.String

R_PROVISIONINGTEMPLATE_FILES_MAP

Declaration
public const string R_PROVISIONINGTEMPLATE_FILES_MAP = null
Field Value
System.String

R_PROVISIONINGTEMPLATE_FILES_ORIGIN

Declaration
public const string R_PROVISIONINGTEMPLATE_FILES_ORIGIN = null
Field Value
System.String

R_PROVISIONINGTEMPLATE_MANIFEST

Declaration
public const string R_PROVISIONINGTEMPLATE_MANIFEST = null
Field Value
System.String

R_PROVISIONINGTEMPLATE_PROPERTIES

Declaration
public const string R_PROVISIONINGTEMPLATE_PROPERTIES = null
Field Value
System.String

U_DIR_FILES

Declaration
public static string U_DIR_FILES
Field Value
System.String

U_DIR_PROVISIONINGTEMPLATE

Declaration
public static string U_DIR_PROVISIONINGTEMPLATE
Field Value
System.String

U_FILES_ORIGIN

Declaration
public static string U_FILES_ORIGIN
Field Value
System.String

U_PROVISIONINGTEMPLATE_FILES_MAP

Declaration
public static string U_PROVISIONINGTEMPLATE_FILES_MAP
Field Value
System.String

U_PROVISIONINGTEMPLATE_MANIFEST

Declaration
public static string U_PROVISIONINGTEMPLATE_MANIFEST
Field Value
System.String

U_PROVISIONINGTEMPLATE_PROPERTIES

Declaration
public static string U_PROVISIONINGTEMPLATE_PROPERTIES
Field Value
System.String

Properties

Files

The Files of the package

Declaration
public IDictionary<String, PnPPackageFileItem> Files { get; }
Property Value
IDictionary<String, PnPPackageFileItem>

FilesMap

The File Map for files stored in the OpenXML file

Declaration
public PnPFilesMap FilesMap { get; set; }
Property Value
PnPFilesMap

FilesOriginPart

The Files origin

Declaration
public PackagePart FilesOriginPart { get; }
Property Value
PackagePart

FilesPackageParts

The Files Parts of the package

Declaration
public IList<PackagePart> FilesPackageParts { get; }
Property Value
IList<PackagePart>

Manifest

The Manifest of the package file

Declaration
public PnPManifest Manifest { get; set; }
Property Value
PnPManifest

ManifestPart

The Manifest Part of the package file

Declaration
public PackagePart ManifestPart { get; }
Property Value
PackagePart

Package

The complete package object

Declaration
public Package Package { get; }
Property Value
Package

Properties

The Properties of the package

Declaration
public PnPProperties Properties { get; set; }
Property Value
PnPProperties

Methods

AddFile(String, Byte[])

Adds file to the package

Declaration
public void AddFile(string fileName, Byte[] value)
Parameters
System.String fileName

Name of the file
Byte[] value

Value of the file

ClearFiles()

Clear the files having package parts with specific relationship type

Declaration
public void ClearFiles()

Open(Stream, FileMode, FileAccess)

Opens the package and returns it based on the stream

Declaration
public static PnPPackage Open(Stream stream, FileMode mode, FileAccess access)
Parameters
Stream stream

The stream
FileMode mode

File Mode of the package
FileAccess access

File Access
Returns
PnPPackage

Package

Open(String, FileMode, FileAccess)

Opens the package and returns it based on the path

Declaration
public static PnPPackage Open(string path, FileMode mode, FileAccess access)
Parameters
System.String path

Path of the package
FileMode mode

File Mode of the package
FileAccess access

File Access
Returns
PnPPackage

Package

Extension Methods