Class ExcelDestination<TInput>
A Excel destination creates an excel files with formatted data. The output will look similar to a csv file.
Inheritance
Inherited Members
Namespace: ETLBox.DataFlow.Connectors
Assembly: ETLBox.Excel.dll
Syntax
public class ExcelDestination<TInput> : DataFlowStreamDestination<TInput>, ILoggableTask, IDataFlowLogging, IDataFlowStreamDestination<TInput>, IDataFlowDestination<TInput>, IDataFlowDestination, IDataFlowComponent, IDataFlowStreamDestination
Type Parameters
| Name | Description |
|---|---|
| TInput | Type of ingoing data |
Constructors
ExcelDestination()
Declaration
public ExcelDestination()
ExcelDestination(string, ResourceType)
Declaration
public ExcelDestination(string uri, ResourceType resourceType)
Parameters
| Type | Name | Description |
|---|---|---|
| string | uri | The destination excel file name or uri |
| ResourceType | resourceType | Specifies if data is loaded from a file, a web endpoint or other storage types (e.g. Azure Blob Storage) |
ExcelDestination(string)
Declaration
public ExcelDestination(string uri)
Parameters
| Type | Name | Description |
|---|---|---|
| string | uri | The destination excel file name or uri |
Properties
ExcelColumns
List of ExcelColumn attributes to map the properties with the right excel column. If you are providing a mapping, all properties that you want to include in the output file need to be specified, and all specified columns require a ColumnIndex. If left empty, the order of the output columns is equal to the order of the properties in the object definition.
Declaration
public ICollection<ExcelColumn> ExcelColumns { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.ICollection<T><ExcelColumn> |
HttpContentType
The content type used when sending the http request content.
Declaration
public override string HttpContentType { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
SheetName
The sheet name that will hold the data
Declaration
public string SheetName { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
SuppressHeader
If set to true, no header row is written into the output
Declaration
public bool SuppressHeader { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
TaskName
A name to identify the task or component. Every component or task comes with a default name that can be overwritten.
Declaration
public override string TaskName { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
Methods
CheckParameter()
Declaration
protected override void CheckParameter()
Overrides
CloseStream()
Declaration
protected override void CloseStream()
Overrides
InitStream()
Declaration
protected override void InitStream()
Overrides
PrepareParameter()
Declaration
protected override void PrepareParameter()
Overrides
WriteIntoStream(TInput)
Declaration
protected override void WriteIntoStream(TInput data)
Parameters
| Type | Name | Description |
|---|---|---|
| TInput | data |