MetadataSerializationOptionsBuilder Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA!
Provides the ability to build the set of options that are used during metadata serialization.
public sealed class MetadataSerializationOptionsBuildertype MetadataSerializationOptionsBuilder = classPublic NotInheritable Class MetadataSerializationOptionsBuilder- Inheritance
-
MetadataSerializationOptionsBuilder
Constructors
| MetadataSerializationOptionsBuilder(MetadataSerializationOptions) |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Creates an instance of the MetadataSerializationOptionsBuilder class that is initialized by the specified options. |
| MetadataSerializationOptionsBuilder(MetadataSerializationStyle) |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Creates a new instance of MetadataSerializationOptionsBuilder class based on the specified style. |
Properties
| Compatibility |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Gets an optional compatibility options that should be used when serializing the metadata. |
| Formatting |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Gets an optional formatting options that should be used when generating the metadata content. |
| IncludeChildren |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Gets an indication if the children of the root object should also be serialized, or only the root object. |
| IncludeRestrictedInformation |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Gets an indication if the serialized output should include restricted information or only the curated version of the data. |
Methods
| GetOptions() |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Gets an instance of MetadataSerializationOptions initialized with the serialization options that were chosen. |
| WithChildrenMetadata() |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Sets the indication that the children of the root object should also be serialized, and not only the root object. |
| WithCompatibilityOptions(MetadataCompatibilityOptions) |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Sets the compatibility options that should be used during the serialization. |
| WithFormattingOptions(MetadataFormattingOptions) |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Sets the formatting options that should be used when generating the metadata content. |
| WithoutChildrenMetadata() |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Reset the indication that the children of the root object should also be serialized, to include only the root object. |
| WithoutCompatibilityOptions() |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Resets the compatibility options that should be used during the serialization, and restore the default options. |
| WithoutFormattingOptions() |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Resets the formatting options that should be used when generating the metadata content, and restore the default options. |
| WithoutRestrictedInformation() |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Reset the indication that the serialized output should not include restricted information, just the curated version of the data. |
| WithRestrictedInformation() |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Sets the indication that the serialized output should include restricted information and not the curated version of the data. |
Extension Methods
| GetExpressionTrimStyle(MetadataSerializationOptionsBuilder) |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Gets the style in which whitespaces in lines in an expression block, are trimmed when serialized into TMDL text; default is TrimTrailingWhitespaces. |
| IsMetadataOrderHintsExcluded(MetadataSerializationOptionsBuilder) |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Gets an indication if the serialized TMDL content should not include hints for the order of metadata elements; default is false, indicating to included in the generated TMDL. |
| WithExpressionTrimStyle(MetadataSerializationOptionsBuilder, TmdlExpressionTrimStyle) |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Sets the style in which whitespaces in lines in an expression block, are trimmed when serialized into TMDL text. |
| WithMetadataOrderHints(MetadataSerializationOptionsBuilder) |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Sets an indication that metadata-order hints should be included in the generated TMDL content. |
| WithoutMetadataOrderHints(MetadataSerializationOptionsBuilder) |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Sets an indication that metadata-order hints should not be included in the generated TMDL content. |