XmlParamRefElement

Definition

Assembly: CloudNimble.EasyAF.XmlDocumentation.dll Namespace: CloudNimble.EasyAF.XmlDocumentation Inheritance: CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Syntax

CloudNimble.EasyAF.XmlDocumentation.XmlParamRefElement

Summary

Represents a paramref XML documentation element for parameter references.

Remarks

The paramref element creates a reference to a parameter within the documentation. It is used to refer to parameters inline within text.

Constructors

.ctor

Initializes a new instance of the XmlParamRefElement class.

Syntax

public XmlParamRefElement()

.ctor

Initializes a new instance of the XmlParamRefElement class with XML content.

Syntax

public XmlParamRefElement(System.Xml.Linq.XElement element)

Parameters

Name	Type	Description
`element`	`System.Xml.Linq.XElement`	The XML element to parse.

.ctor Inherited

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Initializes a new instance of the XmlDocumentationElement class.

Syntax

protected XmlDocumentationElement()

.ctor Inherited

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Initializes a new instance of the XmlDocumentationElement class with XML content.

Syntax

protected XmlDocumentationElement(System.Xml.Linq.XElement element)

Parameters

Name	Type	Description
`element`	`System.Xml.Linq.XElement`	The XML element to parse.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

InnerElements Inherited

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Gets or sets the inner XML elements for nested content.

Syntax

public System.Collections.Generic.List<CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement> InnerElements { get; set; }

Property Value

Type: System.Collections.Generic.List<CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement>

Name

Gets or sets the name of the referenced parameter.

Syntax

public string Name { get; set; }

Property Value

Type: string

RawXml Inherited

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Gets or sets the raw XML content of the element.

Syntax

public string RawXml { get; set; }

Property Value

Type: string

Text Inherited

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Gets or sets the parsed text content of the element.

Syntax

public string Text { get; set; }

Property Value

Type: string

Methods

CreateDocumentationElement Inherited Virtual

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Creates the appropriate documentation element based on the XML element name.

Syntax

protected virtual CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement CreateDocumentationElement(System.Xml.Linq.XElement element)

Parameters

Name	Type	Description
`element`	`System.Xml.Linq.XElement`	The XML element to convert.

Returns

Type: CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement The appropriate documentation element, or null if not supported.

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ParseInnerElements Inherited Virtual

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Parses inner XML elements recursively.

Syntax

protected virtual void ParseInnerElements(System.Xml.Linq.XElement element)

Parameters

Name	Type	Description
`element`	`System.Xml.Linq.XElement`	The parent XML element to parse.

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ToMdx Override

Converts this paramref element to MDX format as inline code.

Syntax

public override string ToMdx()

Returns

Type: string The MDX representation of this parameter reference.

ToMdx Inherited Abstract

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Converts this element to MDX format.

Syntax

public abstract string ToMdx()

Returns

Type: string The MDX representation of this element.

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

​Definition

​Syntax

​Summary

​Remarks

​Constructors

​ .ctor

​Syntax

​ .ctor

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​ .ctor Inherited

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​Properties

​ InnerElements Inherited

​Syntax

​Property Value

​ Name

​Syntax

​Property Value

​ RawXml Inherited

​Syntax

​Property Value

​ Text Inherited

​Syntax

​Property Value

​Methods

​ CreateDocumentationElement Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ParseInnerElements Inherited Virtual

​Syntax

​Parameters

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ToMdx Override

​Syntax

​Returns

​ ToMdx Inherited Abstract

​Syntax

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

Definition

Syntax

Summary

Remarks

Constructors

.ctor

Syntax

.ctor

Syntax

Parameters

.ctor Inherited

Syntax

.ctor Inherited

Syntax

Parameters

.ctor Inherited

Syntax

Properties

InnerElements Inherited

Syntax

Property Value

Name

Syntax

Property Value

RawXml Inherited

Syntax

Property Value

Text Inherited

Syntax

Property Value

Methods

CreateDocumentationElement Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

MemberwiseClone Inherited

Syntax

Returns

ParseInnerElements Inherited Virtual

Syntax

Parameters

ReferenceEquals Inherited

Syntax

Parameters

Returns

ToMdx Override

Syntax

Returns

ToMdx Inherited Abstract

Syntax

Returns

ToString Inherited Virtual

Syntax

Returns