The TemplatePackage type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
 | TemplatePackage |
Create a new (empty) package.
|
Methods
| Name | Description | |
|---|---|---|
| AddFile(String) |
Add a file to the package. This function uses the filepath of the path as the internal name.
|
| AddFile(String, String) |
Add a file to the package.
|
 | Create(String, TemplatePackageManifest, IEnumerable String ) |
Create an unencrypted package in one step using the default compression option (=Maximum).
|
| Create(String, TemplatePackageManifest, IEnumerable String , String) |
Create a package in one step using the default compression option (=Maximum).
|
| Create(String, TemplatePackageManifest, IEnumerable String , String, CompressionOption) |
Create a package in one step.
|
| CreateKey |
Create a new RSA public/private key pair serialized as XML.
|
| Decrypt |
A helper function to convert an encrypted HotDocs package stream to an unencrypted HotDocs package stream.
|
| Encrypt |
A helper function to convert an unencrypted HotDocs package stream to an encrypted HotDocs package stream.
|
|  Equals | (Inherited from Object.) |
| Extract(String, String, TemplatePackageManifest , IEnumerable String ) |
Extract an unencrypted package in one step.
|
| Extract(String, String, String, TemplatePackageManifest , IEnumerable String ) |
Extract a package in one step.
|
| ExtractAllFiles |
Extract a package in one step, treating the manifest like any other file.
|
| ExtractFile(String) |
Extract an existing file.
|
| ExtractFile(String, String) |
Extract an existing file.
|
| FileExists |
Check if a file exists in the package.
|
| GetFiles |
Get a list of all file names stored in the package. These are internal names. E.g. "template.rtf" or "images/icon.png".
|
| GetFiles(Boolean) |
Get a list of all file names stored in the package. These are internal names. E.g. "template.rtf" or "images/icon.png".
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetPublicKeyOf |
Get the public RSA key serialized as XML from a RSA public/private key pair serialized as XML.
|
| GetType | Gets the (Inherited from Type of the current instance.Object.) |
| IsPublicOnlyKey |
Determine if the RSA key is only a public key.
|
| IsValidKey |
Check if a string represents a valid RSA key serialized as XML.
|
| IsValidManifest(String ) |
Check if the current manifest (property 'Manifest') is valid for the current files in the package.
|
| IsValidManifest(TemplatePackageManifest, String ) |
Check if a given manifest is valid for the current files in the package.
|
| Open(String) |
Open an unencrypted package
|
| Open(Stream, String) |
Open a package from a byte stream.
|
| Open(String, String) |
Open a package from a file.
|
| RemoveFile |
Remove an existing file.
|
| Save |
Save the package unencrypted to a file. This function only works if Open has been called before and it uses the same file path again.
|
| Save(String) |
Save the package to a file. This function only works if Open has been called before and it uses the same file path again.
|
| SaveAs(String) |
Save the package unencrypted to a file.
|
| SaveAs(String, String) |
Save the package to a file.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
 | ManifestName |
The internal name of the manifest file. It will be automatically created if the Manifest property has been set upon saving the package. When opening a package, this manifest will be used to initialize the Manifest property.
|
Properties
| Name | Description | |
|---|---|---|
 | CurrentCompression |
Set/get the current compression level. It will be used in the AddFile and Create functions. Default is 'Maximum'.
|
| CurrentPath |
Returns the current path, i.e. the file path used in the Open function. If Open hasn't been called, return null.
|
| IsNew |
Returns true if the package is new, i.e. Open hasn't been called.
|
| Manifest |
Get or set the current manifest for the package
|
| ManifestXml |
Get or set the current manifest from an XML string
|
See Also