Table of Contents

SyntaxGeneratorTemplate Class

Definition

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

This abstract class is used as the base class for syntax generators

public abstract class SyntaxGeneratorTemplate : SyntaxGeneratorCore
Inheritance
SyntaxGeneratorTemplate
Derived

Constructors

SyntaxGeneratorTemplate()

Constructor

Fields

apiAncestorsExpression
apiAttributesExpression
apiBaseClassExpression
apiBestFitMappingProcedureExpression
apiCallingConvProcedureExpression
apiCharSetProcedureExpression
apiComImportTypeExpression
apiContainingAssemblyExpression
apiContainingNamespaceIdExpression
apiContainingNamespaceNameExpression
apiContainingTypeExpression
apiContainingTypeNameExpression
apiContainingTypeSubgroupExpression
apiEntryPointProcedureExpression
apiEventArgsExpression
apiExactSpellingProcedureExpression
apiFieldOffsetFieldExpression
apiFixedAttribute
apiFixedBufferSize
apiFixedBufferType
apiGetterExpression
apiGetVisibilityExpression
apiGroupExpression
apiHandlerOfEventExpression
apiImplementedInterfacesExpression
apiImplementedMembersExpression
apiIsAbstractProcedureExpression
apiIsAbstractTypeExpression
apiIsDefaultMemberExpression
apiIsExplicitImplementationExpression
apiIsExtensionMethod
apiIsFamilyMemberExpression
apiIsFinalExpression
apiIsGenericExpression
apiIsInitOnlyExpression
apiIsInitOnlyFieldExpression
apiIsLiteralFieldExpression
apiIsOverrideExpression
apiIsReadOnlyStructExpression
apiIsReadPropertyExpression
apiIsRefStructExpression
apiIsSealedTypeExpression
apiIsSerializableTypeExpression
apiIsSerializedFieldExpression
apiIsSpecialExpression
apiIsStaticExpression
apiIsUdtReturnExpression
apiIsUnsafeExpression
apiIsVarargsExpression
apiIsVirtualExpression
apiIsVolatileFieldExpression
apiIsWritePropertyExpression
apiModuleProcedureExpression
apiNameExpression
apiOverridesMemberExpression
apiParametersExpression
apiPreserveSigProcedureExpression
apiRequiredMemberAttribute
apiReturnTypeExpression
apiSetLastErrorProcedureExpression
apiSetterExpression
apiSetVisibilityExpression
apiStructLayoutFormatTypeExpression
apiStructLayoutPackTypeExpression
apiStructLayoutSizeTypeExpression
apiStructLayoutTypeExpression
apiSubgroupExpression
apiSubsubgroupExpression
apiTemplatesExpression
apiUnmappableCharProcedureExpression
apiVisibilityExpression
apiVisibilityOfMemberExpression
apiVisibilityOfTypeExpression
assignmentNameExpression
attachedEventAdderExpression
attachedEventRemoverExpression
attachedPropertyGetterExpression
attachedPropertySetterExpression
attributeArgumentsExpression
attributeAssignmentsExpression
attributeTypeExpression
explicitDereferenceExpression
MaxPosition

The maximum line width for the generated syntax

memberDeclaringTypeExpression
nameExpression
parameterArgumentExpression
parameterIsInExpression
parameterIsOptionalExpression
parameterIsOutExpression
parameterIsParamArrayExpression
parameterIsRefExpression
parameterNameExpression
parameterTypeExpression
returnsRefExpression
returnsTypeExpression
returnsValueExpression
specializationArgumentsExpression
templateConstraintsExpression
templateIsConstrainedExpression
templateIsConstructableExpression
templateIsContravariantExpression
templateIsCovariantExpression
templateIsReferenceTypeExpression
templateIsValueTypeExpression
templateNameExpression
typeExpression
typeIdExpression
typeIsObjectExpression
typeModifiersExpression
typeOuterTypeExpression
valueExpression

Properties

Language

This is used to get or set the language name

StyleId

This is used to get or set the style ID

Methods

Initialize(XPathNavigator)

Initialize the syntax generator

IsUnsupportedExplicit(XPathNavigator, SyntaxWriter)

Write unsupported explicit implementation syntax

IsUnsupportedGeneric(XPathNavigator, SyntaxWriter)

Write unsupported generic types syntax

IsUnsupportedUnsafe(XPathNavigator, SyntaxWriter)

Write unsupported unsafe code syntax

IsUnsupportedVarargs(XPathNavigator, SyntaxWriter)

Write unsupported variable arguments syntax

WriteAttachedEventSyntax(XPathNavigator, SyntaxWriter)

Write attached event syntax

WriteAttachedPropertySyntax(XPathNavigator, SyntaxWriter)

Write attached property syntax

WriteCastSyntax(XPathNavigator, SyntaxWriter)

Write cast syntax

WriteClassSyntax(XPathNavigator, SyntaxWriter)

Write class syntax

WriteConstantValue(XPathNavigator, SyntaxWriter)

Write out a constant's value

WriteConstructorSyntax(XPathNavigator, SyntaxWriter)

Write constructor syntax

WriteDelegateSyntax(XPathNavigator, SyntaxWriter)

Write delegate syntax

WriteEnumerationSyntax(XPathNavigator, SyntaxWriter)

Write enumeration syntax

WriteEventSyntax(XPathNavigator, SyntaxWriter)

Write event syntax

WriteFieldSyntax(XPathNavigator, SyntaxWriter)

Write field syntax

WriteInterfaceSyntax(XPathNavigator, SyntaxWriter)

Write interface syntax

WriteMemberSyntax(XPathNavigator, SyntaxWriter)

Write member syntax

WriteMethodSyntax(XPathNavigator, SyntaxWriter)

Write method syntax

WriteNamespaceSyntax(XPathNavigator, SyntaxWriter)

Write namespace syntax

WriteNormalMethodSyntax(XPathNavigator, SyntaxWriter)

Write normal method syntax

WriteNormalTypeReference(string, SyntaxWriter)

Write out a normal type reference

WriteOperatorSyntax(XPathNavigator, SyntaxWriter)

Write operator syntax

WritePropertySyntax(XPathNavigator, SyntaxWriter)

Write property syntax

WriteStructureSyntax(XPathNavigator, SyntaxWriter)

Write structure syntax

WriteSyntax(XPathNavigator, SyntaxWriter)

This is the main syntax writing method

WriteTypeReference(XPathNavigator, SyntaxWriter)

Write out a type reference

WriteTypeSyntax(XPathNavigator, SyntaxWriter)

Write type syntax

WriteWithLineBreakIfNeeded(SyntaxWriter, string, string)

This is used to write a string followed by an optional line break if needed (the writer position is past the maximum position afterwards).