ISyntaxGeneratorMetadata Interface

This class defines the metadata for a BuildAssembler syntax generator component

Definition

Namespace: Sandcastle.Core.BuildAssembler.SyntaxGenerator
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.9.12.0

public interface ISyntaxGeneratorMetadata

Public Interface ISyntaxGeneratorMetadata

public interface class ISyntaxGeneratorMetadata

type ISyntaxGeneratorMetadata = interface end

AlternateIds	This read-only property returns 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 read-only property returns the copyright information for the syntax generator
DefaultConfiguration	This read-only property returns a string containing an XML fragment that defines the default syntax generator configuration if supported.
Description	This read-only property returns a brief description of the syntax generator
Id	This read-only property returns the ID for the syntax generator (typically the language name)
IsConfigurable	This read-only property returns true if the syntax generator is configurable or false if it is not
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 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 read-only property returns the value that defines the order in which the syntax generators are added the to the configuration file.
Version	This read-only property returns the version of the syntax generator