TagIndex Class

Summary

Generates the tag index.
Assembly
Wyam.Blog.dll
Namespace
Wyam.Blog.Pipelines
Interfaces
Base Types
graph TD Base0["Pipeline"]-->Type click Base0 "/api/Wyam.Common.Execution/Pipeline" Base1["object"]-->Base0 Interface0["IPipeline"]-.->Type click Interface0 "/api/Wyam.Common.Execution/IPipeline" Interface1["IModuleList"]-.->Type click Interface1 "/api/Wyam.Common.Modules/IModuleList" Interface2["IList<T>"]-.->Type Interface3["ICollection<T>"]-.->Type Interface4["IEnumerable<T>"]-.->Type Interface5["IEnumerable"]-.->Type Type["TagIndex"] class Type type-node

Syntax

public class TagIndex : Pipeline, IPipeline, IModuleList, IList<IModule>, ICollection<IModule>, 
    IEnumerable<IModule>, IEnumerable

Properties

Name Value Summary
Count int
Inherited from Pipeline
IsReadOnly bool
Inherited from Pipeline
Name string
The name of the pipeline.
Inherited from Pipeline
ProcessDocumentsOnce bool
Specifies that a given pipeline doesn't use data from other pipelines and prevents reprocessing of documents after the first pass.
Inherited from Pipeline
this[int] IModule
Inherited from Pipeline
this[string] IModule
Gets the module with the specified name.
Inherited from Pipeline

Methods

Name Value Summary
Add(IModule) void
Inherited from Pipeline
Add(IModule[]) void
Adds modules to the list. Any null items in the sequence of modules will be discarded.
Inherited from Pipeline
Add(string, IModule) void
Adds a module to the list with a specified name.
Inherited from Pipeline
AsKeyValuePairs() IEnumerable<T>
Returns the list as a sequence of key-value pairs with the keys being the module names and the values being the module instances.
Inherited from Pipeline
Clear() void
Inherited from Pipeline
Contains(IModule) bool
Inherited from Pipeline
Contains(string) bool
Determines if the list contains a module with the specified name.
Inherited from Pipeline
CopyTo(IModule[], int) void
Inherited from Pipeline
GetEnumerator() IEnumerator<T>
Inherited from Pipeline
GetHashCode() int
Inherited from Pipeline
IndexOf(IModule) int
Inherited from Pipeline
IndexOf(string) int
Gets the index of the module with the specified name.
Inherited from Pipeline
Insert(int, IModule) void
Inherited from Pipeline
Insert(int, IModule[]) void
Inserts modules into the list. Any null items in the sequence of modules will be discarded.
Inherited from Pipeline
Insert(int, string, IModule) void
Inserts a module into the list with a specified name.
Inherited from Pipeline
Remove(IModule) bool
Inherited from Pipeline
Remove(string) bool
Removes a module by name.
Inherited from Pipeline
RemoveAt(int) void
Inherited from Pipeline
ToString() string
Inherited from Pipeline
TryGetValue(string, IModule) bool
Attempts to get a module with the specified name.
Inherited from Pipeline

Operators

Name Value Summary
implicit operator string(Pipeline) string
Inherited from Pipeline

Extension Methods

Name Value Summary
AddRange<IModule>(IEnumerable<IModule>) void
Adds a range of values to a collection.
Append<TagIndex>(IModule[]) TModuleList
Appends modules.
Append<TagIndex>(string, IModule) TModuleList
Appends a named module.
GroupByMany<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, TElement>) IEnumerable<T>
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<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, TElement>, IEqualityComparer<TKey>) IEnumerable<T>
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<IModule, TKey>(Func<IModule, IEnumerable<TKey>>) IEnumerable<T>
Groups the elements of a sequence according to a specified key selector function that returns a sequence of keys.
GroupByMany<IModule, TKey>(Func<IModule, IEnumerable<TKey>>, IEqualityComparer<TKey>) IEnumerable<T>
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.
GroupByManyToMany<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, IEnumerable<TElement>>) IEnumerable<T>
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.
GroupByManyToMany<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, IEnumerable<TElement>>, IEqualityComparer<TKey>) IEnumerable<T>
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.
InsertAfter<TagIndex>(string, IModule[]) TModuleList
Inserts modules after the module with the specified name.
InsertAfter<TagIndex>(string, string, IModule) TModuleList
Inserts modules after the module with the specified name.
InsertAfterFirst<T>(IModule[]) IModuleList
Inserts modules after the first module in the list of the specified type.
InsertAfterFirst<T>(Predicate<T>, IModule[]) IModuleList
Inserts modules after the first module in the list of the specified type that satisfies a predicate.
InsertAfterFirst<T>(Predicate<T>, string, IModule) IModuleList
Inserts modules after the first module in the list of the specified type that satisfies a predicate.
InsertAfterFirst<T>(string, IModule) IModuleList
Inserts modules after the first module in the list of the specified type.
InsertAfterLast<T>(IModule[]) IModuleList
Inserts modules after the last module in the list of the specified type.
InsertAfterLast<T>(Predicate<T>, IModule[]) IModuleList
Inserts modules after the last module in the list of the specified type that satisfies a predicate.
InsertAfterLast<T>(Predicate<T>, string, IModule) IModuleList
Inserts modules after the last module in the list of the specified type that satisfies a predicate.
InsertAfterLast<T>(string, IModule) IModuleList
Inserts modules after the last module in the list of the specified type.
InsertBefore<TagIndex>(string, IModule[]) TModuleList
Inserts modules before the module with the specified name.
InsertBefore<TagIndex>(string, string, IModule) TModuleList
Inserts modules before the module with the specified name.
InsertBeforeFirst<T>(IModule[]) IModuleList
Inserts modules before the first module in the list of the specified type.
InsertBeforeFirst<T>(Predicate<T>, IModule[]) IModuleList
Inserts modules before the first module in the list of the specified type that satisfies a predicate.
InsertBeforeFirst<T>(Predicate<T>, string, IModule) IModuleList
Inserts modules before the first module in the list of the specified type that satisfies a predicate.
InsertBeforeFirst<T>(string, IModule) IModuleList
Inserts modules before the first module in the list of the specified type.
InsertBeforeLast<T>(IModule[]) IModuleList
Inserts modules before the last module in the list of the specified type.
InsertBeforeLast<T>(Predicate<T>, IModule[]) IModuleList
Inserts modules before the last module in the list of the specified type that satisfies a predicate.
InsertBeforeLast<T>(Predicate<T>, string, IModule) IModuleList
Inserts modules before the last module in the list of the specified type that satisfies a predicate.
InsertBeforeLast<T>(string, IModule) IModuleList
Inserts modules before the last module in the list of the specified type.
Modify<TagIndex>(int, Action<IModule>) TModuleList
Modifies an inner module list with the specified index.
Modify<TagIndex>(string, Action<IModule>) TModuleList
Modifies an inner module with the specified name.
Prepend<TagIndex>(IModule[]) TModuleList
Prepends modules.
Prepend<TagIndex>(string, IModule) TModuleList
Prepends a named module.
RemoveAll<IModule>(Func<IModule, bool>) int
Removes all items that match a predicate from a collection.
Replace<TagIndex>(int, IModule, string) TModuleList
Replaces a module at the specified index.
Replace<TagIndex>(string, IModule, string) TModuleList
Replaces a module with the specified name. The replacement module will have the same name as the module being replaced unless an alternate name is specified.
ReplaceFirst<T>(IModule, string) IModuleList
Replaces the first module in the list of the specified type.
ReplaceFirst<T>(Predicate<T>, IModule, string) IModuleList
Replaces the first module in the list of the specified type that satisfies a predicate.
ReplaceLast<T>(IModule, string) IModuleList
Replaces the last module in the list of the specified type.
ReplaceLast<T>(Predicate<T>, IModule, string) IModuleList
Replaces the last module in the list of the specified type that satisfies a predicate.
ToLookupMany<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, TElement>) ILookup<,>
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<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, TElement>, IEqualityComparer<TKey>) ILookup<,>
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<IModule, TKey>(Func<IModule, IEnumerable<TKey>>) ILookup<,>
Creates a lookup from a sequence according to a specified key selector function that returns a sequence of keys.
ToLookupMany<IModule, TKey>(Func<IModule, IEnumerable<TKey>>, IEqualityComparer<TKey>) ILookup<,>
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.
ToLookupManyToMany<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, IEnumerable<TElement>>) ILookup<,>
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.
ToLookupManyToMany<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, IEnumerable<TElement>>, IEqualityComparer<TKey>) ILookup<,>
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.
WithProcessDocumentsOnce(bool) IPipeline
Specifies that a given pipeline doesn't use data from other pipelines and prevents reprocessing of documents after the first pass.
GitHub