IShortcodeCollection Interface
Namespace
Statiq.Common
Interfaces
Implementing Types
graph BT Type-.->Interface0["IReadOnlyShortcodeCollection"] click Interface0 "/api/Statiq.Common/IReadOnlyShortcodeCollection" Type-.->Interface1["IReadOnlyCollection<string>"] Type-.->Interface2["IEnumerable<string>"] Type-.->Interface3["IEnumerable"] Type["IShortcodeCollection"] class Type type-node Implementing0["TestShortcodeCollection"]-.->Type click Implementing0 "/api/Statiq.Testing/TestShortcodeCollection"

Syntax

public interface IShortcodeCollection : IReadOnlyShortcodeCollection, IReadOnlyCollection<string>, 
    IEnumerable<string>, IEnumerable

Methods

Name Return Value Summary
Add(string, Func<IShortcode>) void
Adds a shortcode using a factory.

Extension Methods

Name Value Summary
Add(string, Config<ShortcodeResult>) void
Adds a shortcode and uses a Config<TValue> to determine the shortcode result.
Add(string, Func<KeyValuePair<string, string>[], string, IDocument, IExecutionContext, IEnumerable<ShortcodeResult>>) void
Adds a shortcode that determines the result content using the declared arguments and content and the current document and execution context.
Add(string, Func<KeyValuePair<string, string>[], string, IDocument, IExecutionContext, ShortcodeResult>) void
Adds a shortcode that determines the result content using the declared arguments and content and the current document and execution context.
Add(string, Func<KeyValuePair<string, string>[], string, IDocument, IExecutionContext, Task<IEnumerable<ShortcodeResult>>>) void
Adds a shortcode that determines the result content using the declared arguments and content and the current document and execution context.
Add(string, Func<KeyValuePair<string, string>[], string, IDocument, IExecutionContext, Task<ShortcodeResult>>) void
Adds a shortcode that determines the result content using the declared arguments and content and the current document and execution context.
Add(string, Type) void
Adds a shortcode by type.
Add(Type) void
Adds a shortcode by type, inferring the name from the type name and removing a trailing "Shortcode" from the type name.
Add<TShortcode>(string) void
Adds a shortcode by type.
Add<TShortcode>() void
Adds a shortcode by type, inferring the name from the type name.
Concat<string>(string) IEnumerable<T>
GetNext<string>(string, IEqualityComparer<string>) T
GetNext<string>(string) T
GetPrevious<string>(string, IEqualityComparer<string>) T
GetPrevious<string>(string) T
GroupByMany<string, TKey, TElement>(Func<string, IEnumerable<TKey>>, Func<string, 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<string, TKey, TElement>(Func<string, IEnumerable<TKey>>, Func<string, 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<string, TKey>(Func<string, 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<string, TKey>(Func<string, 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<string, TKey, TElement>(Func<string, IEnumerable<TKey>>, Func<string, 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<string, TKey, TElement>(Func<string, IEnumerable<TKey>>, Func<string, 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<string>(Func<string, Task>, CancellationToken) Task
ParallelSelectAsync<string, TResult>(Func<string, Task<TResult>>, CancellationToken) Task<IEnumerable<TResult>>
Invokes an async selector in parallel.
ParallelSelectManyAsync<string, TResult>(Func<string, Task<IEnumerable<TResult>>>, CancellationToken) Task<IEnumerable<TResult>>
Invokes an async selector that returns multiple results in parallel.
ParallelWhereAsync<string>(Func<string, Task<bool>>, CancellationToken) Task<IEnumerable<TSource>>
StartsWith<string>(IEnumerable<string>, IEqualityComparer<string>) bool
Determines whether the items starts with the specified values.
StartsWith<string>(IEnumerable<string>) bool
Determines whether the items starts with the specified values.
ThrowIfNull<IShortcodeCollection>(string) T
ToDocument<IShortcodeCollection>(IContentProvider) IDocument
ToDocument<IShortcodeCollection>(IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<IShortcodeCollection>(NormalizedPath, IContentProvider) IDocument
ToDocument<IShortcodeCollection>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<IShortcodeCollection>(NormalizedPath, NormalizedPath, IContentProvider) IDocument
ToDocument<IShortcodeCollection>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocuments<string>(Func<string, IContentProvider>) IEnumerable<IDocument>
ToDocuments<string>(Func<string, IEnumerable<KeyValuePair<string, object>>>, Func<string, IContentProvider>) IEnumerable<IDocument>
ToDocuments<string>(Func<string, NormalizedPath>, Func<string, IContentProvider>) IEnumerable<IDocument>
ToDocuments<string>(Func<string, NormalizedPath>, Func<string, IEnumerable<KeyValuePair<string, object>>>, Func<string, IContentProvider>) IEnumerable<IDocument>
ToDocuments<string>(Func<string, NormalizedPath>, Func<string, NormalizedPath>, Func<string, IContentProvider>) IEnumerable<IDocument>
ToDocuments<string>(Func<string, NormalizedPath>, Func<string, NormalizedPath>, Func<string, IEnumerable<KeyValuePair<string, object>>>, Func<string, IContentProvider>) IEnumerable<IDocument>
ToLookupMany<string, TKey, TElement>(Func<string, IEnumerable<TKey>>, Func<string, 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<string, TKey, TElement>(Func<string, IEnumerable<TKey>>, Func<string, 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<string, TKey>(Func<string, 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<string, TKey>(Func<string, 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<string, TKey, TElement>(Func<string, IEnumerable<TKey>>, Func<string, 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<string, TKey, TElement>(Func<string, IEnumerable<TKey>>, Func<string, 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<string>(string[], Func<string, object>[]) string
Guide API
GitHub Twitter Get Help Support/Buy
© 2023 Statiq/Dave Glick