Class ExcelConversionClient

Inheritance

System.Object

ExcelConversionClient

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Dangl.AVACloud.Client

Assembly: Dangl.AVACloud.Client.dll

Syntax

public class ExcelConversionClient

Constructors

| Improve this Doc View Source

ExcelConversionClient(HttpClient)

Declaration

public ExcelConversionClient(HttpClient httpClient)

Parameters

Type	Name	Description
System.Net.Http.HttpClient	httpClient

Properties

| Improve this Doc View Source

BaseUrl

Declaration

public string BaseUrl { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

JsonSerializerSettings

Declaration

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

Type	Description
Newtonsoft.Json.JsonSerializerSettings

Methods

| Improve this Doc View Source

ConvertToAvaAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Converts Excel files to Dangl.AVA projects.

Declaration

public Task<ProjectDto> ConvertToAvaAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, bool? removePlainTextLongTexts, bool? removeHtmlLongTexts)

Parameters

Type	Name	Description
FileParameter	excelFile	The input file
System.Nullable<System.Boolean>	readNewElements	Defaults to false
System.Nullable<System.Boolean>	rebuildItemNumberSchema	When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
System.Nullable<System.Boolean>	removePlainTextLongTexts	If set to true, plain text long texts will be removed from the output to reduce response sizes
System.Nullable<System.Boolean>	removeHtmlLongTexts	If set to true, html long texts will be removed from the output to reduce response sizes

Returns

Type	Description
System.Threading.Tasks.Task<Dangl.AVA.IO.Dto.v1.ProjectDto>

Exceptions

Type	Condition
SwaggerException	A server side error occurred.

| Improve this Doc View Source

ConvertToAvaAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Converts Excel files to Dangl.AVA projects.

Declaration

public Task<ProjectDto> ConvertToAvaAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, bool? removePlainTextLongTexts, bool? removeHtmlLongTexts, CancellationToken cancellationToken)

Parameters

Type	Name	Description
FileParameter	excelFile	The input file
System.Nullable<System.Boolean>	readNewElements	Defaults to false
System.Nullable<System.Boolean>	rebuildItemNumberSchema	When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
System.Nullable<System.Boolean>	removePlainTextLongTexts	If set to true, plain text long texts will be removed from the output to reduce response sizes
System.Nullable<System.Boolean>	removeHtmlLongTexts	If set to true, html long texts will be removed from the output to reduce response sizes
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<Dangl.AVA.IO.Dto.v1.ProjectDto>

Exceptions

Type	Condition
SwaggerException	A server side error occurred.

| Improve this Doc View Source

ConvertToExcelAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String)

Converts Excel files to Excel files. Used, for example, when elements were added in excel to generate or modify a project. The Excel file can then be shared containing the full project with all formattings, formulas and styles applied.

Declaration

public Task<FileResponse> ConvertToExcelAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, bool? writePrices, bool? writeLongTexts, string conversionCulture)

Parameters

Type	Name	Description
FileParameter	excelFile	The input file
System.Nullable<System.Boolean>	readNewElements	Defaults to false
System.Nullable<System.Boolean>	rebuildItemNumberSchema	When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
System.Nullable<System.Boolean>	writePrices	Defaults to true
System.Nullable<System.Boolean>	writeLongTexts	Defaults to true
System.String	conversionCulture	The culture that should be used for the conversion process, to have localized Excel files

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>

Exceptions

Type	Condition
SwaggerException	A server side error occurred.

| Improve this Doc View Source

ConvertToExcelAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, CancellationToken)

Declaration

public Task<FileResponse> ConvertToExcelAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, bool? writePrices, bool? writeLongTexts, string conversionCulture, CancellationToken cancellationToken)

Parameters

Type	Name	Description
FileParameter	excelFile	The input file
System.Nullable<System.Boolean>	readNewElements	Defaults to false
System.Nullable<System.Boolean>	rebuildItemNumberSchema	When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
System.Nullable<System.Boolean>	writePrices	Defaults to true
System.Nullable<System.Boolean>	writeLongTexts	Defaults to true
System.String	conversionCulture	The culture that should be used for the conversion process, to have localized Excel files
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>

Exceptions

Type	Condition
SwaggerException	A server side error occurred.

| Improve this Doc View Source

ConvertToGaebAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<DestinationGaebType>, Nullable<DestinationGaebExchangePhase>)

Converts Excel files to GAEB files.

Declaration

public Task<FileResponse> ConvertToGaebAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, DestinationGaebType? destinationGaebType, DestinationGaebExchangePhase? targetExchangePhaseTransform)

Parameters

Type	Name	Description
FileParameter	excelFile	The input file
System.Nullable<System.Boolean>	readNewElements	Defaults to false
System.Nullable<System.Boolean>	rebuildItemNumberSchema	When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
System.Nullable<DestinationGaebType>	destinationGaebType	Defaults to GAEB XML V3.2
System.Nullable<DestinationGaebExchangePhase>	targetExchangePhaseTransform	Defaults to none, meaning no transformation will be done

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>

Exceptions

Type	Condition
SwaggerException	A server side error occurred.

| Improve this Doc View Source

ConvertToGaebAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<DestinationGaebType>, Nullable<DestinationGaebExchangePhase>, CancellationToken)

Converts Excel files to GAEB files.

Declaration

public Task<FileResponse> ConvertToGaebAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, DestinationGaebType? destinationGaebType, DestinationGaebExchangePhase? targetExchangePhaseTransform, CancellationToken cancellationToken)

Parameters

Type	Name	Description
FileParameter	excelFile	The input file
System.Nullable<System.Boolean>	readNewElements	Defaults to false
System.Nullable<System.Boolean>	rebuildItemNumberSchema	When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
System.Nullable<DestinationGaebType>	destinationGaebType	Defaults to GAEB XML V3.2
System.Nullable<DestinationGaebExchangePhase>	targetExchangePhaseTransform	Defaults to none, meaning no transformation will be done
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>

Exceptions

Type	Condition
SwaggerException	A server side error occurred.

| Improve this Doc View Source

ConvertToOenormAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<DestinationOenormType>, Nullable<Boolean>)

Converts Excel files to Oenorm files.

Declaration

public Task<FileResponse> ConvertToOenormAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, DestinationOenormType? destinationOenormType, bool? tryRepairProjectStructure)

Parameters

Type	Name	Description
FileParameter	excelFile	The input file
System.Nullable<System.Boolean>	readNewElements	Defaults to false
System.Nullable<System.Boolean>	rebuildItemNumberSchema	When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
System.Nullable<DestinationOenormType>	destinationOenormType	Defaults to Lv2015
System.Nullable<System.Boolean>	tryRepairProjectStructure	Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>

Exceptions

Type	Condition
SwaggerException	A server side error occurred.

| Improve this Doc View Source

ConvertToOenormAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<DestinationOenormType>, Nullable<Boolean>, CancellationToken)

Converts Excel files to Oenorm files.

Declaration

public Task<FileResponse> ConvertToOenormAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, DestinationOenormType? destinationOenormType, bool? tryRepairProjectStructure, CancellationToken cancellationToken)

Parameters

Type	Name	Description
FileParameter	excelFile	The input file
System.Nullable<System.Boolean>	readNewElements	Defaults to false
System.Nullable<System.Boolean>	rebuildItemNumberSchema	When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
System.Nullable<DestinationOenormType>	destinationOenormType	Defaults to Lv2015
System.Nullable<System.Boolean>	tryRepairProjectStructure	Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>

Exceptions

Type	Condition
SwaggerException	A server side error occurred.