FSharpDeclarationSyntaxGeneratorFactoryResourceItemFileLocation Property

This read-only property is implemented to return the default and localized resource item file location.

Definition

Namespace: Sandcastle.Tools.SyntaxGenerators
Assembly: Sandcastle.Tools.SyntaxGenerators (in Sandcastle.Tools.SyntaxGenerators.dll) Version: 2024.12.21.0
public string ResourceItemFileLocation { get; }

Property Value

String

Implements

ISyntaxGeneratorFactoryResourceItemFileLocation

Remarks

If it returns null or an empty string, it is assumed the syntax generator has no resource item files. Otherwise, this will return the folder containing the default and localized resource item files for things such as the title to use for syntax sections and code examples, unsupported language feature messages, etc.

The resource item files are like those in the presentation styles. The root folder contains the default (English) resource item file. Subfolders, if any, named after each supported language contain the localized version of the file. In all cases, the file is named using the language ID plus a ".xml" extension.

See Also