Class FacturXDocumentBuilderFileExtensions

Extension methods related to using files with the FacturXDotNet.Generation.FacturX.FacturXDocumentBuilder.

Assembly: FacturXDotNet.dll

public static class FacturXDocumentBuilderFileExtensions

Methods

WithBasePdfFile(FacturXDocumentBuilder, string, string?)

Reads the base PDF file from the specified path.

public static FacturXDocumentBuilder WithBasePdfFile(this FacturXDocumentBuilder builder, string path, string? password = null)

Returns

FacturXDotNet.Generation.FacturX.FacturXDocumentBuilder: The builder itself, for chaining.

Parameters

Type	Name	Description
FacturXDotNet.Generation.FacturX.FacturXDocumentBuilder	builder	The builder.
System.String	path	The path to the PDF document.
System.String	password	The password to open the PDF document.

WithXmpMetadataFile(FacturXDocumentBuilder, string)

Reads the XMP metadata file from the specified path.

public static FacturXDocumentBuilder WithXmpMetadataFile(this FacturXDocumentBuilder builder, string path)

Returns

FacturXDotNet.Generation.FacturX.FacturXDocumentBuilder: The builder itself, for chaining.

Parameters

Type	Name	Description
FacturXDotNet.Generation.FacturX.FacturXDocumentBuilder	builder	The builder.
System.String	path	The path to the XMP metadata file.

WithCrossIndustryInvoiceFile(FacturXDocumentBuilder, string, string?)

Reads the Cross-Industry Invoice file from the specified path.

public static FacturXDocumentBuilder WithCrossIndustryInvoiceFile(this FacturXDocumentBuilder builder, string path, string? ciiAttachmentName = null)

Returns

FacturXDotNet.Generation.FacturX.FacturXDocumentBuilder: The builder itself, for chaining.

Parameters

Type	Name	Description
FacturXDotNet.Generation.FacturX.FacturXDocumentBuilder	builder	The builder.
System.String	path	The path to the Cross-Industry Invoice XML file.
System.String	ciiAttachmentName	The name of the attachment containing the Cross-Industry Invoice XML file. If not specified, the default name 'factur-x.xml' will be used.