TestAnalyzerContext Class
Namespace
Statiq.Testing
Interfaces
Base Types
graph BT Type-->Base0["TestExecutionContext"] click Base0 "/api/Statiq.Testing/TestExecutionContext" Base0-->Base1["object"] Type-.->Interface0["IAnalyzerContext"] click Interface0 "/api/Statiq.Common/IAnalyzerContext" Type-.->Interface1["IExecutionContext"] click Interface1 "/api/Statiq.Common/IExecutionContext" Type-.->Interface2["IExecutionState"] click Interface2 "/api/Statiq.Common/IExecutionState" Type-.->Interface3["IDocumentFactory"] click Interface3 "/api/Statiq.Common/IDocumentFactory" Type-.->Interface4["IMetadata"] click Interface4 "/api/Statiq.Common/IMetadata" Type-.->Interface5["IReadOnlyDictionary<string, object>"] Type-.->Interface6["IReadOnlyCollection<KeyValuePair<string, object>>"] Type-.->Interface7["IEnumerable<KeyValuePair<string, object>>"] Type-.->Interface8["IEnumerable"] Type-.->Interface9["IServiceProvider"] Type-.->Interface10["ILogger"] Type["TestAnalyzerContext"] class Type type-node

Syntax

public class TestAnalyzerContext : TestExecutionContext, IAnalyzerContext, IExecutionContext, 
    IExecutionState, IDocumentFactory, IMetadata, IReadOnlyDictionary<string, object>, 
    IReadOnlyCollection<KeyValuePair<string, object>>, IEnumerable<KeyValuePair<string, object>>, 
    IEnumerable, IServiceProvider, ILogger

Constructors

Name Summary
TestAnalyzerContext()
TestAnalyzerContext(IDocument[])
TestAnalyzerContext(IEnumerable<IDocument>)

Properties

Name Property Type Summary
AnalyzerResults ConcurrentBag<TestAnalyzerResult>
ApplicationState IApplicationState
Inherited from TestExecutionContext
CancellationToken CancellationToken
Gets a cancellation token that will be canceled when processing should stop.
Inherited from TestExecutionContext
ClassCatalog ClassCatalog
A catalog of all classes in all assemblies loaded by the current application context.
Inherited from TestExecutionContext
Engine TestEngine
Inherited from TestExecutionContext
Events TestEventCollection
Inherited from TestExecutionContext
ExecutionDateTime DateTime
The date/time that the current execution started.
Inherited from TestExecutionContext
ExecutionId Guid
Uniquely identifies the current execution cycle. This can be used to initialize and/or reset static data for a module on new generations (I.e., due to watching). For example, cache data could be cleared when this changes between runs.
Inherited from TestExecutionContext
FileSystem TestFileSystem
Inherited from TestExecutionContext
HttpResponseFunc Func<HttpRequestMessage, HttpMessageHandler, HttpResponseMessage>
A message handler that should be used to register HttpResponseMessage instances for a given request.
Inherited from TestExecutionContext
Inputs ImmutableArray<IDocument>
The input documents to process.
Inherited from TestExecutionContext
JsEngineFunc Func<IJavaScriptEngine>
Inherited from TestExecutionContext
LinkGenerator ILinkGenerator
Helps generate normalized links.
Inherited from TestExecutionContext
Logger ILogger
Inherited from TestExecutionContext
LogLevel LogLevel
LogMessages ConcurrentQueue<TestMessage>
Inherited from TestExecutionContext
MemoryStreamFactory TestMemoryStreamFactory
Inherited from TestExecutionContext
Module IModule
Gets the currently executing module.
Inherited from TestExecutionContext
Namespaces TestNamespacesCollection
Inherited from TestExecutionContext
OutputPages FilteredDocumentList<IDocument>
Gets the collection of output documents from all previously processed pipelines, filtered to destination paths with a PageFileExtensions extension (which defaults to ".htm" and ".html").
Inherited from TestExecutionContext
Outputs TestPipelineOutputs
Inherited from TestExecutionContext
Parent IExecutionContext
The parent execution context if this is a nested module execution, null otherwise.
Inherited from TestExecutionContext
Phase Phase
Gets the currently executing pipeline phase.
Inherited from TestExecutionContext
Pipeline TestPipeline
Inherited from TestExecutionContext
PipelineName string
Gets the name of the currently executing pipeline.
Inherited from TestExecutionContext
Pipelines TestPipelineCollection
Inherited from TestExecutionContext
ScriptHelper IScriptHelper
Inherited from TestExecutionContext
SerialExecution bool
Indicates that the engine is executing pipeline phases and modules in serial.
Inherited from TestExecutionContext
Services TestServiceProvider
Inherited from TestExecutionContext
Settings Settings
Inherited from TestExecutionContext
Shortcodes TestShortcodeCollection
Inherited from TestExecutionContext
TestLoggerProvider TestLoggerProvider
Inherited from TestExecutionContext

Methods

Name Return Value Summary
AddAnalyzerResult(IDocument, string) void
BeginScope<TState>(TState) IDisposable
Inherited from TestExecutionContext
CreateDocument(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
Inherited from TestExecutionContext
CreateDocument<TDocument>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) TDocument
Inherited from TestExecutionContext
CreateHttpClient() HttpClient
Creates a HttpClient instance that should be used for all HTTP communication.
Inherited from TestExecutionContext
CreateHttpClient(HttpMessageHandler) HttpClient
Creates a new HttpClient instance that uses a custom message handler.
Inherited from TestExecutionContext
ExecuteModulesAsync(IEnumerable<IModule>, IEnumerable<IDocument>) Task<ImmutableArray<IDocument>>
Executes the specified modules with the specified input documents and returns the result documents.
Inherited from TestExecutionContext
GetContentStream(string) Stream
Gets a Stream that can be used for document content. If content is not null, the stream is initialized with the specified content. It is preferred to use this method to obtain a stream over creating your own if the source of the content does not already provide one. The returned streams are optimized for memory usage and performance. Instances of the returned stream should be disposed when writing is complete.
Inherited from TestExecutionContext
GetJavaScriptEnginePool(Action<IJavaScriptEngine>, int, int, int, TimeSpan?) IJavaScriptEnginePool
Gets a new IJavaScriptEnginePool. The returned engine pool should be disposed when no longer needed.
Inherited from TestExecutionContext
GetLogLevel(IDocument) LogLevel
GetService(Type) object
Inherited from TestExecutionContext
IsEnabled(LogLevel) bool
Inherited from TestExecutionContext
Log<TState>(LogLevel, EventId, TState, Exception, Func<TState, Exception, string>) void
Inherited from TestExecutionContext
SendHttpRequestWithRetryAsync(Func<HttpRequestMessage>, int) Task<HttpResponseMessage>
Sends an HttpRequestMessage with exponential back-off.
Inherited from TestExecutionContext
SendHttpRequestWithRetryAsync(Func<HttpRequestMessage>) Task<HttpResponseMessage>
Sends an HttpRequestMessage with exponential back-off.
Inherited from TestExecutionContext
SetDefaultDocumentType<TDocument>() void
Inherited from TestExecutionContext
SetInputs(IDocument[]) void
Inherited from TestExecutionContext
SetInputs(IEnumerable<IDocument>) void
Inherited from TestExecutionContext

Extension Methods

Name Value Summary
CloneOrCreateDocument(IDocument, IContentProvider) IDocument
CloneOrCreateDocument(IDocument, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
CloneOrCreateDocument(IDocument, NormalizedPath, IContentProvider) IDocument
CloneOrCreateDocument(IDocument, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
CloneOrCreateDocument(IDocument, NormalizedPath, NormalizedPath, IContentProvider) IDocument
CloneOrCreateDocument(IDocument, NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
CloneOrCreateDocument(IDocument, IEnumerable<KeyValuePair<string, object>>, Stream, string) IDocument
CloneOrCreateDocument(IDocument, IEnumerable<KeyValuePair<string, object>>, string, string) IDocument
CloneOrCreateDocument(IDocument, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, Stream, string) IDocument
CloneOrCreateDocument(IDocument, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, string, string) IDocument
CloneOrCreateDocument(IDocument, NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, Stream, string) IDocument
CloneOrCreateDocument(IDocument, NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, string, string) IDocument
CloneOrCreateDocument(IDocument, NormalizedPath, NormalizedPath, Stream, string) IDocument
CloneOrCreateDocument(IDocument, NormalizedPath, NormalizedPath, string, string) IDocument
CloneOrCreateDocument(IDocument, NormalizedPath, Stream, string) IDocument
CloneOrCreateDocument(IDocument, NormalizedPath, string, string) IDocument
CloneOrCreateDocument(IDocument, Stream, string) IDocument
CloneOrCreateDocument(IDocument, string, string) IDocument
CloneOrCreateDocument<TDocument>(TDocument, IContentProvider) TDocument
CloneOrCreateDocument<TDocument>(TDocument, IEnumerable<KeyValuePair<string, object>>, IContentProvider) TDocument
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, IContentProvider) TDocument
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) TDocument
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, NormalizedPath, IContentProvider) TDocument
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) TDocument
CloneOrCreateDocument<TDocument>(TDocument, IEnumerable<KeyValuePair<string, object>>, Stream, string) TDocument
CloneOrCreateDocument<TDocument>(TDocument, IEnumerable<KeyValuePair<string, object>>, string, string) IDocument
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, Stream, string) TDocument
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, string, string) IDocument
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, Stream, string) TDocument
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, string, string) IDocument
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, NormalizedPath, Stream, string) TDocument
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, NormalizedPath, string, string) IDocument
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, Stream, string) TDocument
CloneOrCreateDocument<TDocument>(TDocument, NormalizedPath, string, string) IDocument
CloneOrCreateDocument<TDocument>(TDocument, Stream, string) TDocument
CloneOrCreateDocument<TDocument>(TDocument, string, string) IDocument
CloneOrCreateDocumentsAsync(IDocument, IEnumerable<IDocument>, object) Task<IEnumerable<IDocument>>
Clones or creates documents from several types of values.
Concat<KeyValuePair<string, object>>(KeyValuePair<string, object>) IEnumerable<T>
ContainsAnyKeys<string, object>(IEnumerable<string>) bool
Determines whether the dictionary contains all the specified keys.
ContainsAnyKeys<string, object>(string[]) bool
Determines whether the dictionary contains all the specified keys.
ContainsKeys<string, object>(IEnumerable<string>) bool
Determines whether the dictionary contains all the specified keys.
ContainsKeys<string, object>(string[]) bool
Determines whether the dictionary contains all the specified keys.
CreateDocument(IContentProvider) IDocument
CreateDocument(IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
CreateDocument(NormalizedPath, IContentProvider) IDocument
CreateDocument(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
CreateDocument(NormalizedPath, NormalizedPath, IContentProvider) IDocument
CreateDocument(IEnumerable<KeyValuePair<string, object>>, Stream, string) IDocument
CreateDocument(IEnumerable<KeyValuePair<string, object>>, string, string) IDocument
CreateDocument(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, Stream, string) IDocument
CreateDocument(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, string, string) IDocument
CreateDocument(NormalizedPath, NormalizedPath, Stream, string) IDocument
CreateDocument(NormalizedPath, NormalizedPath, string, string) IDocument
CreateDocument(NormalizedPath, Stream, string) IDocument
CreateDocument(NormalizedPath, string, string) IDocument
CreateDocument(Stream, string) IDocument
CreateDocument(string, string) IDocument
CreateDocument<TDocument>(IContentProvider) TDocument
CreateDocument<TDocument>(IEnumerable<KeyValuePair<string, object>>, IContentProvider) TDocument
CreateDocument<TDocument>(NormalizedPath, IContentProvider) TDocument
CreateDocument<TDocument>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) TDocument
CreateDocument<TDocument>(NormalizedPath, NormalizedPath, IContentProvider) TDocument
CreateDocument<TDocument>(IEnumerable<KeyValuePair<string, object>>, Stream, string) TDocument
CreateDocument<TDocument>(IEnumerable<KeyValuePair<string, object>>, string, string) TDocument
CreateDocument<TDocument>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, Stream, string) TDocument
CreateDocument<TDocument>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, string, string) TDocument
CreateDocument<TDocument>(NormalizedPath, NormalizedPath, Stream, string) TDocument
CreateDocument<TDocument>(NormalizedPath, NormalizedPath, string, string) TDocument
CreateDocument<TDocument>(NormalizedPath, Stream, string) TDocument
CreateDocument<TDocument>(NormalizedPath, string, string) TDocument
CreateDocument<TDocument>(Stream, string) TDocument
CreateDocument<TDocument>(string, string) TDocument
ExecuteModulesAsync(IEnumerable<IModule>, IEnumerable<KeyValuePair<string, object>>) Task<ImmutableArray<IDocument>>
Executes the specified modules with an single initial input document with optional additional metadata and returns the result documents.
ExecuteModulesAsync(IEnumerable<IModule>) Task<ImmutableArray<IDocument>>
Executes the specified modules without an initial input document and returns the result documents.
FilterMetadata(string[]) IMetadata
Gets a new filtered IMetadata containing only the specified keys and their values. If a key is not present in the current metadata, it will be ignored and will not be copied to the new metadata object.
Get(string, object) object
Gets the value for the specified key. This method never throws an exception. It will return the specified default value or null if the key is not found or is null.
Get<T>(string, T) T
Gets the value for the specified key. This method never throws an exception. It will return the specified default value if the key is not found or is null.
Get<T>(string) T
Gets the value for the specified key converted to the specified type. This method never throws an exception. It will return default(T) if the key is not found, is null, or the value cannot be converted to T.
GetBool(string, bool) bool
Gets the value for the specified key converted to a bool. This method never throws an exception. It will return the specified default value if the key is not found.
GetContentProvider(byte[], int, int, string) IContentProvider
GetContentProvider(byte[], int, int) IContentProvider
GetContentProvider(byte[], string) IContentProvider
GetContentProvider(byte[]) IContentProvider
GetContentProvider(Func<Stream>, string) IContentProvider
Creates a content provider from a delegate that returns a Stream to use on each content request. A new stream should be returned on each request since it may be read concurrently.
GetContentProvider(Func<Stream>) IContentProvider
Creates a content provider from a delegate that returns a Stream to use on each content request. A new stream should be returned on each request since it may be read concurrently.
GetContentProvider(IMarkupFormattable) IContentProvider
Gets a content provider for HTML content, sets the media type to Html, and updates the internal HTML document cache used by ParseHtmlAsync(IDocument, bool) if the markup parameter is a IHtmlDocument.
GetContentProvider(Stream, string) IContentProvider
creates a content provider from a Stream by reading the stream into a buffer and then providing that buffer when content is requested.
GetContentProvider(Stream) IContentProvider
creates a content provider from a Stream by reading the stream into a buffer and then providing that buffer when content is requested.
GetContentProvider(string, string) IContentProvider
GetContentProvider(string) IContentProvider
GetCurrentDateTime() DateTime
Gets the current date/time using the CurrentDateTime metadata setting if it's set, otherwise using the value of ExecutionDateTime (which is System.DateTime.Now at the time execution started).
GetDateTime(string, DateTime) DateTime
Gets the value for the specified key converted to a DateTime. This method never throws an exception. It will return the specified default value if the key is not found.
GetDateTimeDisplayCulture(string) CultureInfo
Gets the CultureInfo for the date display culture.
GetDateTimeInputCulture() CultureInfo
Gets the CultureInfo for the date input culture.
GetDateTimeOffset(string, DateTimeOffset) DateTimeOffset
Gets the value for the specified key converted to a DateTimeOffset. This method never throws an exception. It will return the specified default value if the key is not found.
GetDocument(string, IDocument) IDocument
Gets the value for the specified key converted to a IDocument. This method never throws an exception. It will return null if the key is not found.
GetDocumentList(string) DocumentList<IDocument>
Gets the value for the specified key converted to a DocumentList<TDocument>. This method never throws an exception. It will return an empty list if the key is not found or if the key is found but contains no items that can be converted to IDocument.
GetDocumentList<TDocument>(string) DocumentList<TDocument>
Gets the value for the specified key converted to a DocumentList<TDocument>. This method never throws an exception. It will return an empty list if the key is not found or if the key is found but contains no items that can be converted to the specified document type.
GetDocuments(string, IReadOnlyList<IDocument>) IEnumerable<IDocument>
Gets the value for the specified key converted to a IReadOnlyList<IDocument>. This method never throws an exception. It will return null if the key is not found and an empty list if the key is found but contains no items that can be converted to IDocument.
GetDocuments<TDocument>(string, IReadOnlyList<TDocument>) IEnumerable<TDocument>
Gets the value for the specified key converted to a IReadOnlyList<TDocument>. This method never throws an exception. It will return null if the key is not found and an empty list if the key is found but contains no items that can be converted to the specified document type.
GetDynamic(string, object) dynamic
Gets the value associated with the specified key as a dynamic object. This is equivalent to calling as dynamic to cast the value.
GetEnumerable() IEnumerable<KeyValuePair<string, object>>
Gets an enumerable that enumerates key-value pairs.
GetFormattedHtmlName(string) string
Formats a symbol or other name by encoding HTML characters and adding HTML break elements as appropriate.
GetInt(string, int) int
Gets the value for the specified key converted to an int. This method never throws an exception. It will return the specified default value if the key is not found.
GetLink(IDocument, bool) string
Gets a link for the specified document using the document destination. This version should be used inside modules to ensure consistent link generation. Note that you can optionally include the host or not depending on if you want to generate host-specific links. By default, the host is not included so that sites work the same on any server including the preview server.
GetLink(IMetadata, string, bool) string
Gets a link for the specified metadata using the specified metadata value and the default settings from the configuration. This version should be used inside modules to ensure consistent link generation. Note that you can optionally include the host or not depending on if you want to generate host-specific links. By default, the host is not included so that sites work the same on any server including the preview server.
GetLink(IMetadata, string, string, bool) string
Gets a link for the specified metadata using the specified metadata value and the default settings from the configuration. This version should be used inside modules to ensure consistent link generation. Note that you can optionally include the host or not depending on if you want to generate host-specific links. By default, the host is not included so that sites work the same on any server including the preview server.
GetLink(NormalizedPath, bool) string
Converts the specified path into a string appropriate for use as a link using default settings from the configuration. This version should be used inside modules to ensure consistent link generation. Note that you can optionally include the host or not depending on if you want to generate host-specific links. By default, the host is not included so that sites work the same on any server including the preview server.
GetLink(NormalizedPath, string, NormalizedPath, bool, bool, bool, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(NormalizedPath, string, NormalizedPath, bool, bool, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(NormalizedPath, string, NormalizedPath, bool, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(NormalizedPath, string, NormalizedPath, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(NormalizedPath, string, string, bool, bool, bool, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(NormalizedPath, string, string, bool, bool, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(NormalizedPath, string, string, bool, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(NormalizedPath, string, string, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(string, bool) string
Converts the specified path into a string appropriate for use as a link using default settings from the configuration. This version should be used inside modules to ensure consistent link generation. Note that you can optionally include the host or not depending on if you want to generate host-specific links. By default, the host is not included so that sites work the same on any server including the preview server.
GetLink(string, string, NormalizedPath, bool, bool, bool, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(string, string, NormalizedPath, bool, bool, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(string, string, NormalizedPath, bool, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(string, string, NormalizedPath, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(string, string, string, bool, bool, bool, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(string, string, string, bool, bool, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(string, string, string, bool, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink(string, string, string, bool, bool, bool) string
Converts the path into a string appropriate for use as a link, overriding one or more settings from the configuration.
GetLink() string
Gets a link for the root of the site using the host and root path specified in the settings.
GetList<T>(string, IReadOnlyList<T>) IReadOnlyList<T>
Gets the value for the specified key converted to a IReadOnlyList<T>. This method never throws an exception. It will return the specified default value if the key is not found. Note that if the value is atomic, the conversion operation will succeed and return a list with one item.
GetMetadata(string, IMetadata) IMetadata
Gets the value for the specified key converted to a nested IMetadata. This method never throws an exception. It will return null if the key is not found.
GetNext<KeyValuePair<string, object>>(KeyValuePair<string, object>, IEqualityComparer<KeyValuePair<string, object>>) T
GetNext<KeyValuePair<string, object>>(KeyValuePair<string, object>) T
GetPath(string, NormalizedPath) NormalizedPath
Gets the value for the specified key converted to a NormalizedPath. This method never throws an exception. It will return the specified default value if the key is not found.
GetPrevious<KeyValuePair<string, object>>(KeyValuePair<string, object>, IEqualityComparer<KeyValuePair<string, object>>) T
GetPrevious<KeyValuePair<string, object>>(KeyValuePair<string, object>) T
GetRaw(string) object
Gets the raw value for the specified key. This method will not materialize IMetadataValue values the way other get methods will. A System.Collections.Generic.KeyNotFoundException will be thrown for missing keys.
GetRawEnumerable() IEnumerable<KeyValuePair<string, object>>
Gets an enumerable that enumerates raw key-value pairs (I.e., the values have not been expanded similar to TryGetRaw(string, object)).
GetString(string, Func<string, string>, string) string
Formats a string value if it exists in the metadata, otherwise returns a default value.
GetString(string, string) string
Gets the value for the specified key converted to a string. This method never throws an exception. It will return the specified default value if the key is not found.
GetTypeLink(IDocument, bool) HtmlString
GetTypeLink(IDocument, string, bool) HtmlString
GetTypeLink(IDocument, string) HtmlString
GetTypeLink(IDocument) HtmlString
GetXrefDocument(string) IDocument
GetXrefLink(string, bool) string
GetXrefLink(string, IDictionary<string, ICollection<(string PipelineName, IDocument Document)>>, bool) string
GetXrefMappings() IDictionary<string, ICollection<(string PipelineName, IDocument Document)>>
GroupByMany<KeyValuePair<string, object>, TKey, TElement>(Func<KeyValuePair<string, object>, IEnumerable<TKey>>, Func<KeyValuePair<string, object>, TElement>, IEqualityComparer<TKey>) IEnumerable<IGrouping<TKey, TElement>>
Groups the elements of a sequence according to a specified key selector function that returns a sequence of keys. The keys are compared by using a comparer and each group's elements are projected by using a specified function.
GroupByMany<KeyValuePair<string, object>, TKey, TElement>(Func<KeyValuePair<string, object>, IEnumerable<TKey>>, Func<KeyValuePair<string, object>, TElement>) IEnumerable<IGrouping<TKey, TElement>>
Groups the elements of a sequence according to a specified key selector function that returns a sequence of keys and projects the elements for each group by using a specified function.
GroupByMany<KeyValuePair<string, object>, TKey>(Func<KeyValuePair<string, object>, IEnumerable<TKey>>, IEqualityComparer<TKey>) IEnumerable<IGrouping<TKey, TSource>>
Groups the elements of a sequence according to a specified key selector function that returns a sequence of keys and compares the keys by using a specified comparer.
GroupByMany<KeyValuePair<string, object>, TKey>(Func<KeyValuePair<string, object>, IEnumerable<TKey>>) IEnumerable<IGrouping<TKey, TSource>>
Groups the elements of a sequence according to a specified key selector function that returns a sequence of keys.
GroupByManyToMany<KeyValuePair<string, object>, TKey, TElement>(Func<KeyValuePair<string, object>, IEnumerable<TKey>>, Func<KeyValuePair<string, object>, IEnumerable<TElement>>, IEqualityComparer<TKey>) IEnumerable<IGrouping<TKey, TElement>>
Groups the elements of a sequence according to a specified key selector function that returns a sequence of keys. The keys are compared by using a comparer and each group's elements are projected by using a specified function that returns a sequence of elements.
GroupByManyToMany<KeyValuePair<string, object>, TKey, TElement>(Func<KeyValuePair<string, object>, IEnumerable<TKey>>, Func<KeyValuePair<string, object>, IEnumerable<TElement>>) IEnumerable<IGrouping<TKey, TElement>>
Groups the elements of a sequence according to a specified key selector function that returns a sequence of keys and projects the elements for each group by using a specified function that returns a sequence of elements.
ParallelForEachAsync<KeyValuePair<string, object>>(Func<KeyValuePair<string, object>, Task>, CancellationToken) Task
ParallelSelectAsync<KeyValuePair<string, object>, TResult>(Func<KeyValuePair<string, object>, Task<TResult>>, CancellationToken) Task<IEnumerable<TResult>>
Invokes an async selector in parallel.
ParallelSelectManyAsync<KeyValuePair<string, object>, TResult>(Func<KeyValuePair<string, object>, Task<IEnumerable<TResult>>>, CancellationToken) Task<IEnumerable<TResult>>
Invokes an async selector that returns multiple results in parallel.
ParallelWhereAsync<KeyValuePair<string, object>>(Func<KeyValuePair<string, object>, Task<bool>>, CancellationToken) Task<IEnumerable<TSource>>
RequireKeys<string, object>(IEnumerable<string>) void
Verifies that a dictionary contains all requires keys. An System.ArgumentException will be thrown if the specified keys are not all present in the dictionary.
RequireKeys<string, object>(string[]) void
Verifies that a dictionary contains all requires keys. An System.ArgumentException will be thrown if the specified keys are not all present in the dictionary.
SendHttpRequestWithRetryAsync(string) Task<HttpResponseMessage>
Sends a GET request with exponential back-off.
SendHttpRequestWithRetryAsync(Uri) Task<HttpResponseMessage>
Sends a GET request with exponential back-off.
StartsWith<KeyValuePair<string, object>>(IEnumerable<KeyValuePair<string, object>>, IEqualityComparer<KeyValuePair<string, object>>) bool
Determines whether the items starts with the specified values.
StartsWith<KeyValuePair<string, object>>(IEnumerable<KeyValuePair<string, object>>) bool
Determines whether the items starts with the specified values.
ThrowIfNull<TestAnalyzerContext>(string) T
ToDocument<TestAnalyzerContext>(IContentProvider) IDocument
ToDocument<TestAnalyzerContext>(IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<TestAnalyzerContext>(NormalizedPath, IContentProvider) IDocument
ToDocument<TestAnalyzerContext>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<TestAnalyzerContext>(NormalizedPath, NormalizedPath, IContentProvider) IDocument
ToDocument<TestAnalyzerContext>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocuments<KeyValuePair<string, object>>(Func<KeyValuePair<string, object>, IContentProvider>) IEnumerable<IDocument>
ToDocuments<KeyValuePair<string, object>>(Func<KeyValuePair<string, object>, IEnumerable<KeyValuePair<string, object>>>, Func<KeyValuePair<string, object>, IContentProvider>) IEnumerable<IDocument>
ToDocuments<KeyValuePair<string, object>>(Func<KeyValuePair<string, object>, NormalizedPath>, Func<KeyValuePair<string, object>, IContentProvider>) IEnumerable<IDocument>
ToDocuments<KeyValuePair<string, object>>(Func<KeyValuePair<string, object>, NormalizedPath>, Func<KeyValuePair<string, object>, IEnumerable<KeyValuePair<string, object>>>, Func<KeyValuePair<string, object>, IContentProvider>) IEnumerable<IDocument>
ToDocuments<KeyValuePair<string, object>>(Func<KeyValuePair<string, object>, NormalizedPath>, Func<KeyValuePair<string, object>, NormalizedPath>, Func<KeyValuePair<string, object>, IContentProvider>) IEnumerable<IDocument>
ToDocuments<KeyValuePair<string, object>>(Func<KeyValuePair<string, object>, NormalizedPath>, Func<KeyValuePair<string, object>, NormalizedPath>, Func<KeyValuePair<string, object>, IEnumerable<KeyValuePair<string, object>>>, Func<KeyValuePair<string, object>, IContentProvider>) IEnumerable<IDocument>
ToJson(JsonSerializerOptions) string
ToLookupMany<KeyValuePair<string, object>, TKey, TElement>(Func<KeyValuePair<string, object>, IEnumerable<TKey>>, Func<KeyValuePair<string, object>, TElement>, IEqualityComparer<TKey>) ILookup<TKey, TElement>
Creates a lookup from a sequence according to a specified key selector function that returns a sequence of keys. The keys are compared by using a comparer and each group's elements are projected by using a specified function.
ToLookupMany<KeyValuePair<string, object>, TKey, TElement>(Func<KeyValuePair<string, object>, IEnumerable<TKey>>, Func<KeyValuePair<string, object>, TElement>) ILookup<TKey, TElement>
Creates a lookup from a sequence according to a specified key selector function that returns a sequence of keys and projects the elements for each group by using a specified function.
ToLookupMany<KeyValuePair<string, object>, TKey>(Func<KeyValuePair<string, object>, IEnumerable<TKey>>, IEqualityComparer<TKey>) ILookup<TKey, TSource>
Creates a lookup from a sequence according to a specified key selector function that returns a sequence of keys and compares the keys by using a specified comparer.
ToLookupMany<KeyValuePair<string, object>, TKey>(Func<KeyValuePair<string, object>, IEnumerable<TKey>>) ILookup<TKey, TSource>
Creates a lookup from a sequence according to a specified key selector function that returns a sequence of keys.
ToLookupManyToMany<KeyValuePair<string, object>, TKey, TElement>(Func<KeyValuePair<string, object>, IEnumerable<TKey>>, Func<KeyValuePair<string, object>, IEnumerable<TElement>>, IEqualityComparer<TKey>) ILookup<TKey, TElement>
Creates a lookup from a sequence according to a specified key selector function that returns a sequence of keys. The keys are compared by using a comparer and each group's elements are projected by using a specified function that returns a sequence of elements.
ToLookupManyToMany<KeyValuePair<string, object>, TKey, TElement>(Func<KeyValuePair<string, object>, IEnumerable<TKey>>, Func<KeyValuePair<string, object>, IEnumerable<TElement>>) ILookup<TKey, TElement>
Creates a lookup from a sequence according to a specified key selector function that returns a sequence of keys and projects the elements for each group by using a specified function that returns a sequence of elements.
ToStringTable<KeyValuePair<string, object>>(string[], Func<KeyValuePair<string, object>, object>[]) string
TryGetValue<TValue>(string, TValue) bool
Tries to get the value for the specified key.
TryGetXrefDocument(string, IDictionary<string, ICollection<(string PipelineName, IDocument Document)>>, IDocument, string) bool
TryGetXrefDocument(string, IDocument, string) bool
TryGetXrefDocument(string, IDocument) bool
TryGetXrefLink(string, bool, IDictionary<string, ICollection<(string PipelineName, IDocument Document)>>, string, string) bool
TryGetXrefLink(string, bool, IDictionary<string, ICollection<(string PipelineName, IDocument Document)>>, string) bool
TryGetXrefLink(string, bool, string, string) bool
TryGetXrefLink(string, bool, string) bool
TryGetXrefLink(string, IDictionary<string, ICollection<(string PipelineName, IDocument Document)>>, string, string) bool
TryGetXrefLink(string, IDictionary<string, ICollection<(string PipelineName, IDocument Document)>>, string) bool
TryGetXrefLink(string, string, string) bool
TryGetXrefLink(string, string) bool
TryParseInputDateTime(string, DateTime) bool
Attempts to parse an input date using the input date culture setting.
WithoutSettings() IMetadata
XAttribute(string, Func<string, string>) XAttribute
XAttribute(string, Func<string, XAttribute>) XAttribute
XAttribute(string, string, Func<string, string>) XAttribute
XAttribute(string, string) XAttribute
Gets an XML attribute for the given metadata key.
XAttribute(string) XAttribute
Gets an XML attribute for the given metadata key. The name of the attribute will be the lower-case key name.
XElement(string, Func<string, object[]>) XElement
XElement(string, Func<string, XElement>) XElement
XElement(string, string, Func<string, object[]>) XElement
Guide API
GitHub Twitter Get Help Support/Buy
© 2023 Statiq/Dave Glick