FileName Class

Summary

Optimizes a specified metadata key as a filename.
Assembly
Wyam.Core.dll
Namespace
Wyam.Core.Modules.Metadata
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IModule"] click Interface0 "/api/Wyam.Common.Modules/IModule" Type["FileName"] class Type type-node

Syntax

public class FileName : IModule

Remarks

This module takes the value of the specified metadata key and optimizes it for use as a filename by removing reserved characters, white-listing characters, etc.

Constructors

Name Summary
FileName() Sets the metadata key WriteFileName to an optimized version of SourceFileName. Also sets the metadata key WritePath to Path.Combine(RelativeFileDir, WriteFileName).
FileName(DocumentConfig) Sets the metadata key WriteFileName to an optimized version of the return value of the delegate. Also sets the metadata key WritePath to Path.Combine(RelativeFileDir, WriteFileName).
FileName(DocumentConfig, string) Sets the specified metadata key to an optimized version of the return value of the delegate. Does not automatically set the WritePath metadata key.
FileName(string) Sets the metadata key WriteFileName to an optimized version of the specified input metadata key. Also sets the metadata key WritePath to Path.Combine(RelativeFileDir, WriteFileName).
FileName(string, string) Sets the specified metadata key to an optimized version of the specified input metadata key. Does not automatically set the WritePath metadata key.

Methods

Name Value Summary
Execute(IReadOnlyList<IDocument>, IExecutionContext) IEnumerable<IDocument>
This should not be called directly, instead call IExecutionContext.Execute() if you need to execute a module from within another module.
PreservePath(bool) FileName
Indicates whether to set the metadata key WritePath to Path.Combine(RelativeFileDir, WriteFileName).
PreservePath(string) FileName
Indicates whether to set the specified metadata key to Path.Combine(RelativeFileDir, WriteFileName).
WithAllowedCharacters(IEnumerable<string>) FileName
Specifies the characters to allow in the filename.
GitHub