Table of Contents

SyntaxGeneratorExportAttribute Class

Definition

Namespace
Sandcastle.Core.BuildAssembler.SyntaxGenerator
Assembly
Sandcastle.Core.dll

This is a custom version of the ExportAttribute that contains metadata for the BuildAssembler syntax generators.

[MetadataAttribute]
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
public sealed class SyntaxGeneratorExportAttribute : ExportAttribute
Inheritance
SyntaxGeneratorExportAttribute

Constructors

SyntaxGeneratorExportAttribute(string, string, string)

Constructor

Properties

AlternateIds

This is used to get or set a comma-separated list of alternate language IDs that can be used by designers to translate an alternate ID to the primary Id

Copyright

This is used to get or set copyright information for the syntax generator

DefaultConfiguration

This is used to get or set a string containing an XML fragment that defines the default syntax generator configuration if supported.

Description

This is used to get or set a brief description of the syntax generator

Id

This read-only property is used to get the syntax generator ID (typically the language name)

IsConfigurable

This is used to get or set whether or not the syntax generator is configurable

KeywordStyleParameter

This read-only property is used to get the keyword style parameter value used by the client side script in the topics for language specific keyword/separator text.

LanguageElementName

This read-only property is used to get the value used as the XML element name and in resource item IDs used during XSL transformation such as for label text.

SortOrder

This is used to get or set the value that defines the order in which the syntax generators are added the to the configuration file.

Version

This is used to get or set the syntax generator version number