Table of Contents

SyntaxWriter Class

Definition

Namespace
Sandcastle.Core.BuildAssembler.SyntaxGenerator
Assembly
Sandcastle.Core.dll

This is used as the abstract base class for syntax writers

public abstract class SyntaxWriter
Inheritance
SyntaxWriter
Derived

Constructors

SyntaxWriter()

Constructor

Properties

Position

The current position of the writer

RenderReferenceLinks

This is used to indicate whether or not the syntax writer should render reference links as actual links.

Methods

WriteEndBlock()

Write an end block

WriteEndSubBlock()

Write an end sub-block

WriteIdentifier(string)

Write out an identifier

WriteKeyword(string)

Write out a keyword

WriteLine()

Write out a blank line

WriteLiteral(string)

Write out a literal

WriteMessage(string)

Write out a message

WriteMessage(string, IEnumerable<string>)

Write a message include item

WriteParameter(string)

Write out a parameter

WriteReferenceLink(string)

Write a reference link

WriteReferenceLink(string, string)

Write a reference link with inner text

WriteStartBlock(string, string)

Write a start block

WriteStartSubBlock(string)

Write a start sub-block

WriteString(string)

Write a string value

WriteStringWithStyle(string, string)

Write a string value with a style