XmlSchemaClassGenerator

XML Schema xs:group and xs:attributeGroup are reusable components. To make these easily accessible across different classes, the generator can optionally create C# interfaces.

If a group is defined in the schema, the generator creates a partial interface containing the group's members. Any class that includes that group will then implement that interface.

Example: If an attributeGroup named Common contains a name attribute, and is referenced by classes A and B, the generator produces:

public partial interface ICommon
{
  string Name { get; set; }
}

public partial class A: ICommon
{
  public string Name { get; set; }
}

public partial class B: ICommon
{
  public string Name { get; set; }
}

If your XSD uses obscure names, you can substitute them using the --tns (command line) or --tnsf (mapping file) options.

Syntax: {kindId}:{generatedName}={substituteName}

Valid kindId values:

• P: Property
• T: Type (class, enum, interface)
• A: Any property and/or type

Example CLI usage:

xscgen --tns T:Example_RootType=Example --tns P:StartDateDateTimeValue=StartDate example.xsd

Example mapping file content:

# Comment
T:Example_RootType = Example
T:Example_RootTypeExampleScope = ExampleScope
P:StartDateDateTimeValue = StartDate

xscgen --tnsf substitutions.txt example.xsd

You can install XmlSchemaClassGenerator in several ways depending on your workflow:

• As a .NET Core CLI tool: Install the dotnet-xscgen NuGet package.
• As a Console Application: Use the binaries provided in the tools folder of the XmlSchemaClassGenerator.Console NuGet package.
• As a Library: Use the XmlSchemaClassGenerator-beta NuGet package for programmatic usage in C#.
• Manual Download: Download binary zips from the GitHub releases page.

dotnet tool install --global dotnet-xscgen

The generator approximates XML xs:integer types to the closest .NET type. You can override this behavior using the --integer=TYPE option.

Supported Types: sb[yte], sh[ort], i[nt], l[ong], ni[nt], b[yte], us[hort], ui[nt], ul[ong], nui[nt], or decimal.

Fallback Mode: If you use the --fb, --fallback flag, the specified integer type will only be used if the generator cannot automatically deduce a more appropriate type based on the schema's minInclusive and maxInclusive restrictions.

xscgen --integer=long example.xsd

You can integrate the generator directly into your C# code using the XmlSchemaClassGenerator-beta NuGet package.

var generator = new Generator
{
    OutputFolder = outputFolder,
    Log = s => Console.Out.WriteLine(s),
    GenerateNullables = true,
    NamespaceProvider = new Dictionary<NamespaceKey, string> 
    { 
        { new NamespaceKey("http://wadl.dev.java.net/2009/02"), "Wadl" } 
    }
    .ToNamespaceProvider(new GeneratorConfiguration { NamespacePrefix = "Wadl" }.NamespaceProvider.GenerateNamespace)
};

generator.Generate(files);

To provide a custom NamespaceProvider, you can instantiate it and define the GenerateNamespace function:

var generator = new Generator
{
    NamespaceProvider = new NamespaceProvider
    {
        GenerateNamespace = key => /* your custom logic */
    }
};

When generating collection properties, you can specify the collection type and its implementation using the following options. Note that values must be in the format accepted by Type.GetType() (e.g., System.Collections.Generic.List1`).

Options:

• --ct, --collectionType=VALUE: The type of the collection (default: System.Collections.ObjectModel.Collection1).
• --cit, --collectionImplementationType=VALUE: The implementation type of the collection (default: null).
• --csm, --collectionSettersMode=VALUE: Controls how the setter is generated.
  • Options: Private, Public, PublicWithoutConstructorInitialization, Init, InitWithoutConstructorInitialization (default: Private).

--ct System.Collections.Generic.List`1
--cit System.Collections.Generic.List`1
--csm Init

When --emitMetadataAttributes is enabled, the generator produces custom attributes for specific XML schema facets. These attributes are placed in the namespace defined by --metadataNamespace (default: XmlSchemaClassGenerator.Metadata).

// Example of generated metadata attribute usage
[FractionDigits(2)]
public decimal Price { get; set; }