Reads the contents of Excel Open XML documents as a table into metadata.

Namespace

Interfaces

Base Types

graph BT Type-->Base0["ParallelSyncMultiConfigModule"] click Base0 "/api/Statiq.Common/ParallelSyncMultiConfigModule" Base0-->Base1["ParallelMultiConfigModule"] click Base1 "/api/Statiq.Common/ParallelMultiConfigModule" Base1-->Base2["MultiConfigModuleBase"] click Base2 "/api/Statiq.Common/MultiConfigModuleBase" Base2-->Base3["Module"] click Base3 "/api/Statiq.Common/Module" Base3-->Base4["object"] Type-.->Interface0["IModule"] click Interface0 "/api/Statiq.Common/IModule" Type-.->Interface1["IParallelModule"] click Interface1 "/api/Statiq.Common/IParallelModule" Type["ReadExcel"] class Type type-node

Syntax

public class ReadExcel : ParallelSyncMultiConfigModule, IModule, IParallelModule

Remarks

The table array is stored in a "Table" key by default as a IReadOnlyList<IReadOnlyList<string>>.

Constructors

Name	Summary
ReadExcel()
ReadExcel(Config<string>, Config<int>)

Properties

Name	Property Type	Summary
Configs	IReadOnlyDictionary<string, IConfig>	Inherited from MultiConfigModuleBase
ForceDocumentExecution	bool	Inherited from MultiConfigModuleBase
Parallel	bool	Indicates whether documents will be processed by this module in parallel. Inherited from ParallelMultiConfigModule

Methods

Name	Return Value	Summary
AfterExecution(IExecutionContext, ExecutionOutputs)	void	Called after each module execution. Inherited from Module
AfterExecutionAsync(IExecutionContext, ExecutionOutputs)	Task	Called after each module execution. Inherited from Module
BeforeExecution(IExecutionContext)	void	Called before each module execution. Inherited from Module
BeforeExecutionAsync(IExecutionContext)	Task	Called before each module execution. Inherited from Module
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IDocument, IExecutionContext, Task<TValue>>)	MultiConfigModuleBase	Inherited from MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IDocument, IExecutionContext, TValue>)	MultiConfigModuleBase	Inherited from MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IExecutionContext, Task<TValue>>)	MultiConfigModuleBase	Inherited from MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IExecutionContext, TValue>)	MultiConfigModuleBase	Inherited from MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, Task<TValue>>)	MultiConfigModuleBase	Inherited from MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, TValue>)	MultiConfigModuleBase	Inherited from MultiConfigModuleBase
ExecuteAsync(IExecutionContext)	Task<IEnumerable<IDocument>>	This should not be called directly, instead call `IExecutionContext.Execute()` if you need to execute a module from within another module. Inherited from Module
ExecuteConfig(IDocument, IExecutionContext, IMetadata)	IEnumerable<IDocument>
ExecuteConfigAsync(IDocument, IExecutionContext, IMetadata)	Task<IEnumerable<IDocument>>	Executes the module for each input document. If there aren't any input documents and the config delegate doesn't require documents, this will be called once with a null input. Inherited from ParallelSyncMultiConfigModule
ExecuteContextAsync(IExecutionContext)	Task<IEnumerable<IDocument>>	Executes the module once for all input documents. Inherited from ParallelMultiConfigModule
ExecuteInputAsync(IDocument, IExecutionContext)	Task<IEnumerable<IDocument>>	Executes the module. Inherited from MultiConfigModuleBase
Finally(IExecutionContext)	void	Called after each module execution, even if an exception is thrown during execution. Inherited from Module
FinallyAsync(IExecutionContext)	Task	Called after each module execution, even if an exception is thrown during execution. Inherited from Module
GetConfig(string)	IConfig	Gets the config for a given key. Inherited from MultiConfigModuleBase
GetConfig<TValue>(string)	Config<TValue>	Gets the config for a given key cast to a specific config value. Inherited from MultiConfigModuleBase
SetConfig(string, IConfig)	MultiConfigModuleBase	Sets the config for a given key. Inherited from MultiConfigModuleBase
TryGetConfig(string, IConfig)	bool	Inherited from MultiConfigModuleBase
WithKey(Config<string>)	ReadExcel	Sets the metadata key where the table will be stored (default of "Table").
WithSheet(Config<int>)	ReadExcel	Sets the 0-based index of the sheet to read in the Excel file.

Extension Methods

Name	Value	Summary
ForEachDocument()	ForEachDocument	From IModuleExtensions
ThrowIfNull<ReadExcel>(string)	T	From GuardExtensions
ToDocument<ReadExcel>(IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ReadExcel>(IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ReadExcel>(NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ReadExcel>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ReadExcel>(NormalizedPath, NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ReadExcel>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
WithParallelExecution<ReadExcel>(bool)	TModule	Indicates that the module should process documents in parallel. From IParallelModuleExtensions