Class CliArguments

Represents the arguments (options) which are available to the CLI application.

Inheritance
System.Object
CliArguments
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: ZptSharp.Cli
Assembly: ZptSharp.Cli.dll
Syntax
public class CliArguments

Properties

| Improve this Doc View Source

CommaSeparatedExcludePatterns

Gets or sets a comma-separated list of file/path glob patterns to exclude from the operation. If left unset then this defaults to empty/no exclusions.

Declaration
public string CommaSeparatedExcludePatterns { get; set; }
Property Value
Type Description
System.String

The exclude patterns.
| Improve this Doc View Source

CommaSeparatedIncludePatterns

Gets or sets a comma-separated list of file/path glob patterns to include in the operation. If left unset then this defaults to .. IE: All files in the directory, but no recursive searching.

Declaration
public string CommaSeparatedIncludePatterns { get; set; }
Property Value
Type Description
System.String

The include patterns.
| Improve this Doc View Source

CommaSeparatedKeywordOptions

Gets or sets an optional collection of key/value pairs which shall be used in the rendering operation as the "TALES keyword options".

Declaration
public string CommaSeparatedKeywordOptions { get; set; }
Property Value
Type Description
System.String

The keyword options.
Remarks

These should be passed as comma-separated list of key/value pairs in the format key=value. For example, the string weather=cloudy,time=13:45 would create two keyword options. Those would be weather with a value of cloudy & time with a value of 13:45.

| Improve this Doc View Source

EnableSourceAnnotation

Gets or sets a value which indicates whether or not source annotation should be enabled.

Declaration
public bool EnableSourceAnnotation { get; set; }
Property Value
Type Description
System.Boolean

Whether or not to use source annotation.
| Improve this Doc View Source

OutputFileExtension

Gets or sets an optional file extension to be used for the output files. If left unset then the files will be output with the same extension as the source files.

Declaration
public string OutputFileExtension { get; set; }
Property Value
Type Description
System.String

The output file extension.
| Improve this Doc View Source

OutputPath

Gets the directory path to where output files should be saved. If this is null then the current directory shall be used.

Declaration
public string OutputPath { get; set; }
Property Value
Type Description
System.String

The output path.
| Improve this Doc View Source

PathToModelJson

Gets or sets an optional path to a JSON-formatted file which shall be used as the model for the rendering operation.

Declaration
public string PathToModelJson { get; set; }
Property Value
Type Description
System.String

The model JSON file path.
| Improve this Doc View Source

RootPath

The only mandatory argument; this gets or sets the root path which shall be used for the bulk file rendering operation.

Declaration
public IList<string> RootPath { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<System.String>

The root path.
Remarks

Whilst this property is a list, it should always have precisely one value.

| Improve this Doc View Source

UseAngleSharp

Gets or sets a value which indicates whether or not AngleSharp should be used for rendering HTML ZPT documents. If false then HTML Agility Pack will be used instead.

Declaration
public bool UseAngleSharp { get; set; }
Property Value
Type Description
System.Boolean

Whether or not to use AngleSharp for HTML.