Class XmlSource<TOutput>
Reads data from a xml source. This can be any http resource or a file. By default, data is pulled via httpclient. Use the ResourceType property to read data from a file.
Inheritance
Implements
Inherited Members
Namespace: ETLBox.Xml
Assembly: ETLBox.Xml.dll
Syntax
{{< /rawhtml >}} ```C# public class XmlSourceType Parameters
| Name | Description |
|---|---|
| TOutput |
Examples
XmlSource<POCO> source = new XmlSource<POCO>("https://test.com");Constructors
XmlSource()
Declaration
{{< /rawhtml >}} ```C# public XmlSource() ``` {{< rawhtml >}}XmlSource(string)
Declaration
{{< /rawhtml >}} ```C# public XmlSource(string uri) ``` {{< rawhtml >}}Parameters
| Type | Name | Description |
|---|---|---|
| string | uri | The source xml file name or uri |
XmlSource(string, ResourceType)
Declaration
{{< /rawhtml >}} ```C# public XmlSource(string uri, ResourceType resourceType) ``` {{< rawhtml >}}Parameters
| Type | Name | Description |
|---|---|---|
| string | uri | The source xml 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) |
Properties
AttributePrefixForDynamic
The prefix used for XML attributes in dynamic objects. Default is "at_". This helps distinguish attributes from elements when parsing XML dynamically.
Declaration
{{< /rawhtml >}} ```C# public string AttributePrefixForDynamic { get; set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| string |
CollectUnparsedData
If set to true, unparsed XML data that is not mapped to the output type will be collected and stored in UnparsedData. Default is false.
Declaration
{{< /rawhtml >}} ```C# public override bool CollectUnparsedData { get; set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| bool |
Overrides
ElementName
The XML element name that contains an item of the data to be parsed. This setting applies only when reading dynamic objects. For POCOs, use XML attributes on the class instead.
Declaration
{{< /rawhtml >}} ```C# public string ElementName { get; set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| string |
Namespace
Optional: The namespace of the element specified in ElementName. This setting applies only when reading dynamic objects. For POCOs, use XML attributes on the class instead.
Declaration
{{< /rawhtml >}} ```C# public string Namespace { get; set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| string |
RetrieveElementFunc
Dynamically determines the ElementName during XML reading. This function is applied only for dynamic objects and overrides any existing ElementName and Namespace settings.
Declaration
{{< /rawhtml >}} ```C# public FuncProperty Value
| Type | Description |
|---|---|
| Func<StreamMetaData, bool> |
TextPrefixForDynamic
The prefix used for text values outside of XML elements in dynamic objects. Default is "tx_". This ensures text content is properly distinguished during parsing.
Declaration
{{< /rawhtml >}} ```C# public string TextPrefixForDynamic { get; set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| string |
XmlReaderSettings
The XmlReaderSettings used when creating the XmlReader. This controls how XML is read, such as whether whitespace is ignored. Default: XmlReaderSettings with IgnoreWhitespace set to true.
Declaration
{{< /rawhtml >}} ```C# public XmlReaderSettings XmlReaderSettings { get; set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| XmlReaderSettings |
XmlSerializer
The XmlSerializer used to deserialize XML into the specified data type.
Declaration
{{< /rawhtml >}} ```C# public XmlSerializer XmlSerializer { get; set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| XmlSerializer |