AsciidoctorAttribute Class

Summary

Represents an document attribute being set when converting an AsciiDoc document.
Assembly
Cake.Asciidoctor.dll
Namespace
Cake.Asciidoctor
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["AsciidoctorAttribute"] class Type type-node

Syntax

public class AsciidoctorAttribute

Attributes

Type Description
NullableContextAttribute
NullableAttribute

Properties

Name Value Summary
Name string
Gets the name of the attribute
Options AsciidoctorAttributeOptions
Gets additional options for the attribute
Unset bool
Gets or sets whether the attribute is an "unset attribute".

When an attribute is "unset", the attribute is passed to Asciidoctor wihtout a value and the ! option. This causes the attribute value to be removed even if it is defined in the input document.

Value string
Gets the attribute's value or null if the attribute has no value.

Methods

Name Value Summary
ToString() string
Returns a string that represents the current object.

Extension Methods

Name Value Summary
Dump<AsciidoctorAttribute>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AsciidoctorAttribute>(AsciidoctorAttribute[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AsciidoctorAttribute>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<AsciidoctorAttribute>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<AsciidoctorAttribute>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<AsciidoctorAttribute>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin