Skip to content

API Overview

Mike-EEE edited this page Nov 30, 2019 · 19 revisions

At the heart of ExtendedXmlSerializer's configuration sits a fluent API. Example:

    IExtendedXmlSerializer serializer = new ConfigurationContainer()
        .UseEncryptionAlgorithm(new CustomEncryption())
        .Type<Person>() // Configuration of Person class
            .Member(p => p.Password) // First member
                .Name("P")
                .Encrypt()
            .Member(p => p.Name) // Second member
                .Name("T")
        .Type<TestClass>() // Configuration of another class
            .CustomSerializer(new TestClassSerializer())
        .Create();

As such, there are three primary configuration components that you will work with to configure ExtendedXmlSerializer:

  • ConfigurationContainer
  • TypeConfiguration<T>
  • MemberConfiguration<T, TMember>

We start this API Overview by exploring these three configuration elements, then move onto other primary components used throughout ExtendedXmlSerializer.

ConfigurationContainer

[API Reference]

The ConfigurationContainer is considered the root-level entry object in ExtendedXmlSerializer. All root serializers created in ExtendedXmlSerializer are done through a ConfigurationContainer after it has been created and configured.

Is is through the use of the ConfigurationContainer's Type<T> method call that we are able to configure types, which we explore next.

Configuration Profiles

[API Reference]

TBD

TypeConfiguration

[API Reference]

TBD

MemberConfiguration

[API Reference]

TBD

Application Components

Now that we have explored the configuration components, let's briefly dive into the other featured components used throughout ExtendedXmlSerializer.

ISerializer

[API Reference]

TBD

IElement

[API Reference]

TBD

IContents

[API Reference]

TBD

IConverter

[API Reference]

TBD

ISerializerExtension

[API Reference]

TBD

Clone this wiki locally