C# Класс Docu.Output.Rendering.SparkTemplateBase

All public or protected methods and properties on this class are available within documentation templates

Наследование: Spark.AbstractSparkView, IDocuTemplate

Защищенные свойства (Protected)

Свойство	Тип	Описание
Formatter	HtmlOutputFormatter

Открытые методы

Метод	Описание
Format ( Comment comment ) : string	Returns the comments in a format suitable for display
Format ( IReferencable referencable ) : string	Returns a hyperlink to another symbol The format of the URL in the returned hyperlink can be controlled by the methods SetNamespaceUrlFormat, SetTypeUrlFormat, SetPropertyUrlFormat, SetMethodUrlFormat, SetFieldUrlFormat and SetEventUrlFormat
OutputMethodParams ( Method method ) : string	Returns a comma-delimited list of the parameters of a given method
SetEventUrlFormat ( string format ) : void	Configures the pattern that will be used to construct links to events referenced in the documentation of other symbols The pattern can be constructed using the following placeholders: {type.namespace}The namespace of the type that contains the event {type}The short name of the type that contains the event {event}The name of the event The default is {type.namespace}/{type}.htm#{event}
SetFieldUrlFormat ( string format ) : void	Configures the pattern that will be used to construct links to fields referenced in the documentation of other symbols The pattern can be constructed using the following placeholders: {type.namespace}The namespace of the type that contains the field {type}The short name of the type that contains the field {field}The name of the field The default is {type.namespace}/{type}.htm#{field}
SetMethodUrlFormat ( string format ) : void	Configures the pattern that will be used to construct links to methods referenced in the documentation of other symbols The pattern can be constructed using the following placeholders: {type.namespace}The namespace of the type that contains the method {type}The short name of the type that contains the method {method}The name of method The default is {type.namespace}/{type}.htm#{method}
SetNamespaceUrlFormat ( string format ) : void	Configures the pattern that will be used to construct links to namespaces referenced in the documentation of other symbols The pattern can be constructed using the following placeholders: {type.namespace}The name of the namespace The default is {namespace}.htm
SetPropertyUrlFormat ( string format ) : void	Configures the pattern that will be used to construct links to properties referenced in the documentation of other symbols The pattern can be constructed using the following placeholders: {type.namespace}The namespace of the type that contains the property {type}The short name of the type that contains the property {property}The name of the property The default is {type.namespace}/{type}.htm#{property}
SetTypeUrlFormat ( string format ) : void	Configures the pattern that will be used to construct links to types referenced in the documentation of other symbols The pattern can be constructed using the following placeholders: {type.namespace}The namespace of the type {type}The short name of the type The default is {type.namespace}/{type}.htm
SiteResource ( string path ) : string
WriteAssemblyTitle ( Assembly assembly ) : string	Returns the title of an assembly
WriteFileDescription ( Assembly assembly ) : string	Returns the description of an assembly
WriteInterfaces ( IList interfaces ) : string	Returns a comma-delimited list of the interfaces impleted by a given type
WriteProductName ( Assembly assembly ) : string	Returns the product name of an assembly
WriteVersion ( Assembly assembly ) : string	Returns the version number of an assembly
h ( string content ) : string	HTML encodes the content

Защищенные методы

Метод	Описание
SparkTemplateBase ( ) : System

Описание методов

Format() публичный Метод

Returns the comments in a format suitable for display

public Format ( Comment comment ) : string
comment	Docu.Documentation.Comments.Comment
Результат	string

Format() публичный Метод

Returns a hyperlink to another symbol

The format of the URL in the returned hyperlink can be controlled by the methods SetNamespaceUrlFormat, SetTypeUrlFormat, SetPropertyUrlFormat, SetMethodUrlFormat, SetFieldUrlFormat and SetEventUrlFormat

public Format ( IReferencable referencable ) : string
referencable	IReferencable
Результат	string

OutputMethodParams() публичный Метод

Returns a comma-delimited list of the parameters of a given method

public OutputMethodParams ( Method method ) : string
method	Docu.Documentation.Method
Результат	string

SetEventUrlFormat() публичный Метод

Configures the pattern that will be used to construct links to events referenced in the documentation of other symbols

The pattern can be constructed using the following placeholders: {type.namespace}The namespace of the type that contains the event {type}The short name of the type that contains the event {event}The name of the event

The default is {type.namespace}/{type}.htm#{event}

public SetEventUrlFormat ( string format ) : void
format	string	The pattern used to construct the link
Результат	void

SetFieldUrlFormat() публичный Метод

Configures the pattern that will be used to construct links to fields referenced in the documentation of other symbols

The pattern can be constructed using the following placeholders: {type.namespace}The namespace of the type that contains the field {type}The short name of the type that contains the field {field}The name of the field

The default is {type.namespace}/{type}.htm#{field}

public SetFieldUrlFormat ( string format ) : void
format	string	The pattern used to construct the link
Результат	void

SetMethodUrlFormat() публичный Метод

Configures the pattern that will be used to construct links to methods referenced in the documentation of other symbols

The pattern can be constructed using the following placeholders: {type.namespace}The namespace of the type that contains the method {type}The short name of the type that contains the method {method}The name of method

The default is {type.namespace}/{type}.htm#{method}

public SetMethodUrlFormat ( string format ) : void
format	string	The pattern used to construct the link
Результат	void

SetNamespaceUrlFormat() публичный Метод

Configures the pattern that will be used to construct links to namespaces referenced in the documentation of other symbols

The pattern can be constructed using the following placeholders: {type.namespace}The name of the namespace

The default is {namespace}.htm

public SetNamespaceUrlFormat ( string format ) : void
format	string	The pattern used to construct the link
Результат	void

SetPropertyUrlFormat() публичный Метод

Configures the pattern that will be used to construct links to properties referenced in the documentation of other symbols

The pattern can be constructed using the following placeholders: {type.namespace}The namespace of the type that contains the property {type}The short name of the type that contains the property {property}The name of the property

The default is {type.namespace}/{type}.htm#{property}

public SetPropertyUrlFormat ( string format ) : void
format	string	The pattern used to construct the link
Результат	void

SetTypeUrlFormat() публичный Метод

Configures the pattern that will be used to construct links to types referenced in the documentation of other symbols

The pattern can be constructed using the following placeholders: {type.namespace}The namespace of the type {type}The short name of the type

The default is {type.namespace}/{type}.htm

public SetTypeUrlFormat ( string format ) : void
format	string	The pattern used to construct the link
Результат	void

SiteResource() публичный Метод

public SiteResource ( string path ) : string
path	string
Результат	string

SparkTemplateBase() защищенный Метод

protected SparkTemplateBase ( ) : System
Результат	System

WriteAssemblyTitle() публичный Метод

Returns the title of an assembly

public WriteAssemblyTitle ( Assembly assembly ) : string
assembly	System.Reflection.Assembly
Результат	string

WriteFileDescription() публичный Метод

Returns the description of an assembly

public WriteFileDescription ( Assembly assembly ) : string
assembly	System.Reflection.Assembly
Результат	string

WriteInterfaces() публичный Метод

Returns a comma-delimited list of the interfaces impleted by a given type

public WriteInterfaces ( IList interfaces ) : string
interfaces	IList
Результат	string

WriteProductName() публичный Метод

Returns the product name of an assembly

public WriteProductName ( Assembly assembly ) : string
assembly	System.Reflection.Assembly
Результат	string

WriteVersion() публичный Метод

Returns the version number of an assembly

public WriteVersion ( Assembly assembly ) : string
assembly	System.Reflection.Assembly
Результат	string

h() публичный Метод

HTML encodes the content

public h ( string content ) : string
content	string
Результат	string

Описание свойств

Formatter защищенное свойство

protected HtmlOutputFormatter,Docu.Output.Rendering Formatter
Результат	HtmlOutputFormatter