TopicTransformationCoreApiTopicShortNamePlainText Method

Get the short type/member name for an API topic in plain text. This is used for metadata values and the table of contents title.

Definition

Namespace: Sandcastle.Core.PresentationStyle.Transformation
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.12.21.0

C#View Source Request Example

protected virtual XNode ApiTopicShortNamePlainText(
	bool qualifyMembers
)

VBView Source Request Example

Protected Overridable Function ApiTopicShortNamePlainText ( 
	qualifyMembers As Boolean
) As XNode

C++View Source Request Example

protected:
virtual XNode^ ApiTopicShortNamePlainText(
	bool qualifyMembers
)

F#View Source Request Example

abstract ApiTopicShortNamePlainText : 
        qualifyMembers : bool -> XNode 
override ApiTopicShortNamePlainText : 
        qualifyMembers : bool -> XNode

Parameters

qualifyMembers Boolean: True to qualify members with their namespace, false if not

Return Value

XNode
An XML element representing the current topic's type/member name in plain text

TopicTransformationCoreApiTopicShortNamePlainText Method

Definition

Parameters

Return Value

See Also

Reference