TcHmiJSchemaGeneratorCreateGenerator(SchemaPropertyOrderHandling, SchemaReferenceHandling, Boolean, IEnumerableJSchemaGenerationProvider, IContractResolver, IContractResolver, Boolean, FuncType, String) Method

Creates a TcHmiJSchemaGenerator with the specified parameters.


Namespace: TcHmiSrv.Core.Tools.DynamicSymbols
Assembly: TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 3.1.7447.0+85f9b473a1dd11b8f3e5c9a182fd1901975e46f9

Syntax

C#

public static TcHmiJSchemaGenerator CreateGenerator(
    SchemaPropertyOrderHandling schemaPropertyOrderHandling,
    SchemaReferenceHandling schemaReferenceHandling,
    bool required,
    IEnumerable<JSchemaGenerationProvider> generationProviders,
    IContractResolver preContractResolver,
    IContractResolver postContractResolver,
    bool escapeUris,
    Func<Type, string> schemaIdGenerator
)

Parameters

schemaPropertyOrderHandling  SchemaPropertyOrderHandling

The SchemaPropertyOrderHandling that indicates in which order the properties should appear in the generated schema.

schemaReferenceHandling  SchemaReferenceHandling

The SchemaReferenceHandling that indicates which generated schemas can be referenced.

required  Boolean

true if all properties in the generated JSON schema are required; otherwise, false.

generationProviders  IEnumerableJSchemaGenerationProvider

An IEnumerableT of JSchemaGenerationProvider s that are used to customize JSchema generation.

preContractResolver  IContractResolver

An IContractResolver that is used to resolve a JsonContract for a given Type before JsonSchemaContractResolver tries to resolve the JsonContract .

postContractResolver  IContractResolver

An IContractResolver that is used to resolve a JsonContract for a given Type after JsonSchemaContractResolver tried to resolve the JsonContract .

escapeUris  Boolean

true if URIs in "$ref" values should be escaped; otherwise, false.

schemaIdGenerator  FuncType, String

A FuncT, TResult that is used to generate the schema ID for a specified Type in "definitions" and "$ref" values.

Return Value

TcHmiJSchemaGenerator
A TcHmiJSchemaGenerator with the specified parameters.

Version Information

Supported in: 3.1.7447.0, 2.3.7447.0, 1.10.7447.0

Reference

TcHmiJSchemaGenerator Class CreateGenerator Overload TcHmiSrv.Core.Tools.DynamicSymbols Namespace

Copyright © Beckhoff Automation GmbH & Co. KG