C# Класс NDoc.Documenter.NAnt.NAntXsltUtilities

Provides an extension object for the XSLT transformations.
Показать файл Открыть проект Примеры использования класса

Private Properties

Свойство Тип Описание
CreateInstance NAntXsltUtilities
GetElementNameForMethod string
GetElementNameForProperty string
GetElementNameForType string
GetFileNameForFunction string
GetFileNameForFunction string
GetFileNameForType string
GetFileNameForType string
GetFilenameForSystemMember string
GetHRefForFunctionSet string
GetTaskNameForType string
NAntXsltUtilities System.Collections

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

Метод Описание
GetClassNode ( string id ) : XPathNodeIterator

Searches the document for the <class> node with the given id.

GetElementDocType ( XmlNode typeNode ) : ElementDocType

Determines the ElementDocType of the given type node.

GetElementDocTypeByID ( string cref ) : ElementDocType

Determines the ElementDocType of the type to which the given cref points.

GetElementName ( string cref ) : string

Returns the NAnt element name for a given cref.

GetHRef ( string cref ) : string

Returns an href for a cref.

GetMethodNodeByID ( string cref ) : XmlNode
GetName ( string cref ) : string

Returns the name for a given cref.

GetNamespaceFilter ( ) : string

Gets the root namespace to document.

GetTaskName ( string cref ) : string

Returns the NAnt task name for a given cref.

GetTypeNodeByID ( string cref ) : XmlNode
IsDataType ( string cref ) : bool

Determines whether the given cref points to a datatype.

IsElement ( string cref ) : bool

Determines whether the given cref points to an element.

When the cref points to a Task or DataTypeBase this method returns .

IsFilter ( string cref ) : bool

Determines whether the given cref points to a datatype.

IsFunctionSet ( string cref ) : bool

Determines whether the given cref points to a functionset.

IsTask ( string cref ) : bool

Determines whether the given cref points to a task.

UrlEncode ( string value ) : string

Encodes a URL string using Encoding.UTF8 for reliable HTTP transmission from the Web server to a client.

Приватные методы

Метод Описание
CreateInstance ( XmlDocument doc, NAntDocumenterConfig config ) : NAntXsltUtilities
GetElementNameForMethod ( XmlNode methodNode ) : string

Gets the function name for methods that represent a NAtn function.

GetElementNameForProperty ( XmlNode propertyNode ) : string

Gets the BuildElementAttribute name for the "class/property" XmlNode

GetElementNameForType ( XmlNode typeNode ) : string
GetFileNameForFunction ( XmlNode functionNode, bool urlEncode ) : string

Returns the filename to use for the given function XmlElement

GetFileNameForFunction ( string type, bool urlEncode ) : string
GetFileNameForType ( XmlNode typeNode, bool urlEncode ) : string

Returns the filename to use for the given class XmlNode

For a type that is neither a task, enum, global type, filter or functionset, the returned filename will point to the SDK docs for that type.

GetFileNameForType ( string type, bool urlEncode ) : string
GetFilenameForSystemMember ( string cref ) : string
GetHRefForFunctionSet ( XmlNode functionNode ) : string

Returns a partial URL to link to the functionset in the function index.

GetTaskNameForType ( XmlNode typeNode ) : string

Gets the TaskNameAttrbute name for the "class" XmlNode

The class is also checked to make sure it is derived from Task

NAntXsltUtilities ( XmlDocument doc, NAntDocumenterConfig config ) : System.Collections

Initializes a new instance of the NAntXsltUtilities class.

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

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

Searches the document for the <class> node with the given id.
public GetClassNode ( string id ) : XPathNodeIterator
id string
Результат System.Xml.XPath.XPathNodeIterator

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

Determines the ElementDocType of the given type node.
public GetElementDocType ( XmlNode typeNode ) : ElementDocType
typeNode System.Xml.XmlNode The type node for which to determine the .
Результат ElementDocType

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

Determines the ElementDocType of the type to which the given cref points.
public GetElementDocTypeByID ( string cref ) : ElementDocType
cref string The cref for which to determine the .
Результат ElementDocType

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

Returns the NAnt element name for a given cref.
public GetElementName ( string cref ) : string
cref string The cref for the element name will be looked up.
Результат string

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

Returns an href for a cref.
public GetHRef ( string cref ) : string
cref string The cref for which the href will be looked up.
Результат string

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

public GetMethodNodeByID ( string cref ) : XmlNode
cref string
Результат System.Xml.XmlNode

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

Returns the name for a given cref.
public GetName ( string cref ) : string
cref string The cref for which the name will be looked up.
Результат string

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

Gets the root namespace to document.
public GetNamespaceFilter ( ) : string
Результат string

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

Returns the NAnt task name for a given cref.
public GetTaskName ( string cref ) : string
cref string The cref for the task name will be looked up.
Результат string

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

public GetTypeNodeByID ( string cref ) : XmlNode
cref string
Результат System.Xml.XmlNode

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

Determines whether the given cref points to a datatype.
public IsDataType ( string cref ) : bool
cref string The cref to check.
Результат bool

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

Determines whether the given cref points to an element.
When the cref points to a Task or DataTypeBase this method returns .
public IsElement ( string cref ) : bool
cref string The cref to check.
Результат bool

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

Determines whether the given cref points to a datatype.
public IsFilter ( string cref ) : bool
cref string The cref to check.
Результат bool

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

Determines whether the given cref points to a functionset.
public IsFunctionSet ( string cref ) : bool
cref string The cref to check.
Результат bool

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

Determines whether the given cref points to a task.
public IsTask ( string cref ) : bool
cref string The cref to check.
Результат bool

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

Encodes a URL string using Encoding.UTF8 for reliable HTTP transmission from the Web server to a client.
public UrlEncode ( string value ) : string
value string The text to encode.
Результат string