Skip to content

c5606475 afec 0e56 1277 644804e4b2ce

Fernando Garcia edited this page May 8, 2018 · 1 revision

ExportsModel Class

Additional header content

Root element of iTin Export Engine configuration file that contains a list with export definition.

Inheritance Hierarchy

System.Object
  iTin.Export.Model.BaseModel(ExportsModel)
    iTin.Export.Model.ExportsModel
Namespace: iTin.Export.Model
Assembly: iTin.Export.Core (in iTin.Export.Core.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C#

[SerializableAttribute]
public class ExportsModel : BaseModel<ExportsModel>

VB

<SerializableAttribute>
Public Class ExportsModel
	Inherits BaseModel(Of ExportsModel)

The ExportsModel type exposes the following members.

Constructors

 

Name Description
Public method ExportsModel Initializes a new instance of the ExportsModel class
  Back to Top

Properties

 

Name Description
Public property Items Gets or sets collection of export configurations.
Public property Properties Gets or sets a reference to user-defined property list for this element. (Inherited from BaseModel(T).)
Public property References Gets a reference to the assembly references.
Public property Resources Gets or sets global resources.
  Back to Top

Methods

 

Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public methodStatic member GetDefaultPropertyValue(T) Gets the default value for specified property.
Public method GetHashCode (Inherited from Object.)
Public methodStatic member GetRelativeFilePathParsed Gets a valid full path from a relative path.
Protected method GetStaticBindingValue Gets the static binding value by reflection. (Inherited from BaseModel(T).)
Public method GetType (Inherited from Object.)
Public methodStatic member GetXmlEnumAttributeFromItem Gets a string containing the attribute value an element XmlEnumAttribute.
Protected method MemberwiseClone (Inherited from Object.)
Public method SaveToFile(String) Saves to file. (Inherited from BaseModel(T).)
Public method SaveToFile(String, Exception) Serializes current BaseModel object into file (Inherited from BaseModel(T).)
Public method Serialize Serializes current BaseModel object into an Xml document. (Inherited from BaseModel(T).)
Public method ToString Returns a string that represents the current data type. (Overrides BaseModel(T).ToString().)
  Back to Top

Remarks

Represents ITEE root element of a configuration file. ITEE Object Element Usage

<?xml version="1.0" encoding="utf-8"?>
<Exports xmlns="http://schemas.iTin.com/export/engine/2013/configuration">
  <Export/>
  <Export/>
  ...
</Exports>

Attributes  

Attribute Description
xmlns Namespace for the iTin Export Engine (AEE) configuration file.
   
Note Note
The xsd schema file that will be used to validate the document are located in the location VisualStudioInstallationFolder\Xml\Schemas, also gives us the intellisense to write quickly the document.
  Elements  
Element Description
Items Collection of export configurations. Each element is composed of a description and a data table definition.

Examples

The following example shows a full configuration file. XML

<?xml version="1.0" encoding="utf-8"?>
<Exports xmlns="http://schemas.iTin.com/export/engine/2013/configuration">
  <Export Name="iTin" Current="Yes">
    <Description>Sample 1</Description>
    <Table Name="SCR3SFL"
           AutoFilter="Yes"
           AutoFitColumns="Yes"
           Alias="iTin Sample 1">
      <Exporter>   
        <Writer Name="Spreadsheet2003TabularWriter"/>
        <Behaviors>
          <Download/>
          <TransformFile Save="Yes"/>
        </Behaviors>
      </Exporter>
      <Output>
        <File>ExampleI</File>
        <Path>~\Samples\Output\Writers\Demo\XML Spreadsheet</Path>
      </Output>
      <Styles>
        <Style Name="Header">
          <Content Color="#D9E1F2">
            <Alignment Horizontal="Left"/>
            <Text/>
          </Content>
          <Font Name="Calibri" Size="11" Bold="Yes"/>
        </Style>
        <Style Name="PeriodValue">
          <Content Color="#B4C6E7">
            <Alignment Horizontal="Right"/>
            <DateTime Format="Year-Month"/>
          </Content>
          <Font Name="Calibri" Size="11"/>
        </Style>
        <Style Name="EuropeValue">
          <Content Color="#B4C6E7">
            <Alignment Horizontal="Right"/>
            <Number Decimals="1" Separator="Yes"/>
          </Content>
          <Font Name="Calibri" Size="11"/>
        </Style>
        <Style Name="AfricaValue">
          <Content Color="#B4C6E7">
            <Alignment Horizontal="Right"/>
            <Number Decimals="1" Separator="Yes"/>
          </Content>
          <Font Name="Calibri" Size="11"/>
        </Style>
        <Style Name="AsiaValue">
          <Content Color="#B4C6E7">
            <Alignment Horizontal="Right"/>
            <Number Decimals="1" Separator="Yes"/>
          </Content>
          <Font Name="Calibri" Size="11"/>
        </Style>
        <Style Name="NorthAmericaValue">
          <Content Color="#B4C6E7">
            <Alignment Horizontal="Right"/>
            <Number Decimals="1" Separator="Yes"/>
          </Content>
          <Font Name="Calibri" Size="11"/>
        </Style>
        <Style Name="SouthAmericaValue">
          <Content Color="#B4C6E7">
            <Alignment Horizontal="Right"/>
            <Number Decimals="1" Separator="Yes"/>
          </Content>
          <Font Name="Calibri" Size="11"/>
        </Style>
        <Style Name="AustraliaValue">
          <Content Color="#B4C6E7">
            <Alignment Horizontal="Right"/>
            <Number Decimals="1" Separator="Yes"/>
          </Content>
          <Font Name="Calibri" Size="11"/>
        </Style>
      </Styles>
      <Fields>
        <Field Name="PERIOD" Alias="Period">
          <Header Style="Header"/>
          <Value Style="PeriodValue"/>
        </Field>
        <Field Name="EUROPE" Alias="Europe">
          <Header Style="Header"/>
          <Value Style="EuropeValue"/>
        </Field>
        <Field Name="AFRICA" Alias="Africa">
          <Header Style="Header"/>
          <Value Style="AfricaValue"/>
        </Field>
        <Field Name="ASIA" Alias="Asia">
          <Header Style="Header"/>
          <Value Style="AsiaValue"/>
        </Field>
        <Field Name="NORTHAMERICA" Alias="North America">
          <Header Style="Header"/>
          <Value Style="NorthAmericaValue"/>
        </Field>
        <Field Name="SOUTHAMERICA" Alias="South America">
          <Header Style="Header"/>
          <Value Style="SouthAmericaValue"/>
        </Field>
        <Field Name="AUSTRALIA" Alias="Australia">
          <Header Style="Header"/>
          <Value Style="AustraliaValue"/>
        </Field>
      </Fields>
    </Table>
  </Export>
</Exports>

See Also

Reference

iTin.Export.Model Namespace

Clone this wiki locally