RefDocGen
Home
API
FAQ
Templates
Configuration
Basic config
Custom static pages
Doc versioning
YAML config
C#
public class
SearchResultTM
assembly
RefDocGen
namespace
RefDocGen.TemplateProcessors.Shared.TemplateModels.Types
Base type:
object
Implements:
ITemplateModelWithId
,
IEquatable
<
SearchResultTM
>
Template model representing a search result displayed at the
search
page.
Constructors
public
SearchResultTM
(
LanguageSpecificData
<
string
>
Name
,
string
DocComment
,
string
Id
,
string
IdFragment
=
null
)
#
Template model representing a search result displayed at the
search
page.
Parameters
LanguageSpecificData
<
string
>
Name
Name of the search result.
string
DocComment
Documentation provided to the search result.
string
Id
ID of the search result. In case of a member, the ID containing type is returned.
string
IdFragment
In case of a member, this variable represents the ID of the member.
Properties
public
string
DocComment
{
get
;
init
;
}
#
Documentation provided to the search result.
public
string
Id
{
get
;
init
;
}
#
Implements
ITemplateModelWithId.Id
ID of the search result. In case of a member, the ID containing type is returned.
public
string
IdFragment
{
get
;
init
;
}
#
In case of a member, this variable represents the ID of the member.
public
LanguageSpecificData
<
string
>
Name
{
get
;
init
;
}
#
Name of the search result.
public
string
Url
{
get
;
}
#
URL of the search result, relative to the
search
page.
Made with
RefDocGen