API Reference
WordPackageSigningOptions
Options for signing a DOCX package through the cross-platform OPC XML-signature engine.
Inheritance
- Object
- WordPackageSigningOptions
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters
- Method WordDocument.SignPackage
- Method WordDocument.SignPackage
- Method WordDocument.TrySignPackage
- Method WordDocument.TrySignPackage
Constructors
public WordPackageSigningOptions() #Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public IReadOnlyCollection<String> PartUris { get; set; } #Gets or sets explicit package-part URIs to sign. When null, all existing non-signature package parts are signed.
public Boolean IncludePackageRelationships { get; set; } #Gets or sets whether package-level relationships are included in the signature.
public Boolean IncludePartRelationships { get; set; } #Gets or sets whether relationships owned by individual package parts are included in the signature.
public String HashAlgorithm { get; set; } #Gets or sets the XML DSig hash algorithm URI.
public String SignatureId { get; set; } #Gets or sets an optional signature id.
public Nullable<DateTimeOffset> SigningTime { get; set; } #Gets or sets the claimed OPC signing time. Current UTC time is used when omitted. This is signed metadata, not an RFC 3161 timestamp-authority token.
public IReadOnlyCollection<X509Certificate2> AdditionalCertificates { get; set; } #Gets or sets optional intermediate or root certificates embedded with the signer certificate.
public Int32 MaxPackageParts { get; set; } #Gets or sets the maximum number of ZIP entries accepted while signing. Defaults to 10,000.
public Int64 MaxPackageBytes { get; set; } #Gets or sets the maximum encoded package bytes accepted while signing. Defaults to 512 MiB.
public Int64 MaxPartBytes { get; set; } #Gets or sets the maximum uncompressed bytes read from one signed part. Defaults to 256 MiB.
public Int64 MaxTotalDigestBytes { get; set; } #Gets or sets the maximum aggregate uncompressed package-part bytes digested while signing. Defaults to 512 MiB.
public Int32 MaxSignedReferences { get; set; } #Gets or sets the maximum authenticated XML signature references and relationship selectors created per signature. Defaults to 4,096.
public Int64 MaxSignatureBytes { get; set; } #Gets or sets the maximum encoded bytes for the generated XML signature part. Defaults to 16 MiB.
public Int32 MaxCertificates { get; set; } #Gets or sets the maximum signer and additional certificates embedded in the created signature. Defaults to 64.
public Int64 MaxCertificateBytes { get; set; } #Gets or sets the maximum encoded bytes for one embedded certificate. Defaults to 4 MiB.
public Int64 MaxTotalCertificateBytes { get; set; } #Gets or sets the maximum aggregate encoded certificate bytes embedded in the created signature. Defaults to 64 MiB.
Fields
public const String Sha256HashAlgorithm #Gets the SHA-256 XML DSig hash algorithm URI used by default.
http://www.w3.org/2001/04/xmlenc#sha256